community.general.datadog_monitor – Управляет мониторами Datadog
Примечание
Этот плагин является частью коллекции community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в playbook, укажите: community.general.datadog_monitor.
Обзор
- Управляет мониторами в Datadog.
- Опции, как описано на https://docs.datadoghq.com/api/.
Требования
Ниже перечислены требования к хосту, на котором будет выполняться этот модуль.
- datadog
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_host строка добавлен в 0.2.0 от community.general | URL API Datadog. Значение по умолчанию — https://api.datadoghq.com.Это значение также можно задать с помощью переменной окружения DATADOG_HOST. | |
| api_key строка / обязательно | Ваш ключ API Datadog. | |
| app_key строка / обязательно | Ваш ключ приложения Datadog. | |
| escalation_message строка | Сообщение для включения при повторном уведомлении. Поддерживает уведомление '@username', которое разрешено в других местах. Не применимо, если renotify_interval=None. | |
| evaluation_delay строка | Время задержки оценки (в секундах). Эффективно для разреженных значений. | |
| id строка | Идентификатор оповещения. Если задано, будет использоваться вместо имени для поиска оповещения. | |
| include_tags булево добавлен в 1.3.0 от community.general |
| Включать ли теги, которые автоматически вставляются в заголовок из триггерных тегов этого монитора. |
| locked булево |
| Блокировать ли изменения этого монитора для пользователя, создавшего его, или администраторов. |
| name строка / обязательно | Имя оповещения. | |
| new_host_delay строка | Положительное целое число, представляющее количество секунд ожидания перед оценкой монитора для новых хостов. Это даёт хосту время для полной инициализации. | |
| no_data_timeframe строка | Количество минут, в течение которых монитор будет оповещать при прекращении отправки данных. Должно быть по крайней мере в 2 раза больше интервала мониторинга для метрических оповещений или 2 минуты для проверок сервисов. Если не указано, по умолчанию это 2 раза больше интервала для метрики, 2 минуты для сервиса. | |
| notification_message строка | Сообщение для включения в уведомления для этого монитора. Уведомления по электронной почте могут быть отправлены определённым пользователям, используя тот же символ '@username', что и события. Переменные шаблона сообщений монитора могут быть доступны с использованием двойных квадратных скобок, т.е. '[[' и ']]'. message псевдоним устарел в community.general 0.2.0, так как используется в Ansible Core Engine.Псевдонимы: message | |
| notify_audit булево |
| Оповещать ли пользователей с соответствующими тегами об изменениях в этом мониторе. |
| notify_no_data булево |
| Оповещать ли этот монитор о прекращении отслеживания данных. |
| query строка | Запрос монитора, на котором нужно оповещать. Синтаксис зависит от типа создаваемого монитора. | |
| renotify_interval строка | Количество минут после последнего уведомления, прежде чем монитор повторно оповестит о текущем состоянии. Он будет повторно оповещать только в случае, если статус не разрешён. | |
| require_full_window булево |
| Требуется ли для этого монитора полный объём данных перед оценкой. Для разреженных метрик настоятельно рекомендуется установить значение False, иначе некоторые оценки будут пропущены. |
| silenced словарь | Значение по умолчанию: "" | Словарь объёмов для отключения, со временем или None. Каждый объём будет заглушён до заданного временного отметки POSIX или навсегда, если значение равно None. |
| state строка / обязательно |
| Определённое состояние монитора. |
| tags список / элементы=строка | Список тегов, которые следует ассоциировать с вашим монитором при создании или обновлении. Это может помочь вам категоризировать и фильтровать мониторы. | |
| thresholds словарь | Словарь порогов по статусу. Доступно только для проверок сервисов и метрических оповещений. Так как каждый из них может иметь несколько порогов, мы не определяем их напрямую в запросе. Если не указано, по умолчанию: {'ok': 1, 'critical': 1, 'warning': 1}. | |
| timeout_h строка | Количество часов, в течение которых монитор не передаёт данные, прежде чем он автоматически разрешится из триггерного состояния. | |
| type строка |
| Тип монитора. |
Примеры
- name: Create a metric monitor
community.general.datadog_monitor:
type: "metric alert"
name: "Test monitor"
state: "present"
query: "datadog.agent.up.over('host:host1').last(2).count_by_status()"
notification_message: "Host [[host.name]] with IP [[host.ip]] is failing to report to datadog."
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Deletes a monitor
community.general.datadog_monitor:
name: "Test monitor"
state: "absent"
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Mutes a monitor
community.general.datadog_monitor:
name: "Test monitor"
state: "mute"
silenced: '{"*":None}'
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Unmutes a monitor
community.general.datadog_monitor:
name: "Test monitor"
state: "unmute"
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
- name: Use datadoghq.eu platform instead of datadoghq.com
community.general.datadog_monitor:
name: "Test monitor"
state: "absent"
api_host: https://api.datadoghq.eu
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"
Авторы
- Sebastian Kornehl (@skornehl)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/datadog_monitor_module.html
