community.general.datadog_monitor модуль — Управление мониторами Datadog

Примечание

Этот модуль входит в коллекцию community.general (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.

Чтобы использовать его в книге задач, укажите: community.general.datadog_monitor.

Обзор
Требования
Параметры
Атрибуты
Примеры

Обзор

Управление мониторами в Datadog.
Параметры, как описано на https://docs.datadoghq.com/api/.

Требования

Ниже перечислены требования, необходимые на узле, на котором выполняется этот модуль.

datadog

Параметры

Параметр	Комментарии
api_host строка добавлен в community.general 0.2.0	URL API Datadog. Значение по умолчанию `https://api.datadoghq.com`. Это значение также можно задать с помощью переменной среды `DATADOG_HOST`.
api_key строка / обязательно	Ваш ключ API Datadog.
app_key строка / обязательно	Ваш ключ приложения Datadog.
escalation_message строка	Сообщение, которое будет включено с повторным уведомлением. Поддерживает ‘@имя_пользователя’ уведомление, которое мы разрешаем в другом месте. Не применимо, если `renotify_interval=none`.
evaluation_delay строка	Время задержки оценки (в секундах). Эффективно для разреженных значений.
id строка	Идентификатор оповещения. Если задано, будет использоваться вместо имени для поиска оповещения.
include_tags логическое добавлен в community.general 1.3.0	Включать ли теги, срабатывающие при уведомлении, в заголовок. Варианты: `false` `true` ← (по умолчанию)
locked логическое	Блокировать ли изменения в мониторе для создателя или администраторов. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательно	Имя оповещения.
new_host_delay строка	Положительное целое число, представляющее количество секунд ожидания перед оценкой монитора для новых хостов. Это даёт хосту время для полной инициализации.
no_data_timeframe строка	Количество минут, в течение которого монитор будет отправлять уведомления об отсутствии отчетов данных. Должно быть не менее чем в 2 раза больше интервала мониторинга для метрик или 2 минут для проверок сервисов. Если не указано, по умолчанию 2x интервал для метрик, 2 минуты для сервисов.
notification_message строка	Сообщение, которое будет включено в уведомления для этого монитора. Уведомления по электронной почте могут быть отправлены определённым пользователям, используя ту же ‘@имя_пользователя’ нотацию, что и события. Переменные шаблонов сообщений монитора можно получить, используя двойные квадратные скобки, т.е. ‘[[’ и ‘]]’.
notification_preset_name строка добавлен в community.general 7.1.0	Включает/выключает отображение дополнительного содержимого, отправленного в уведомлении монитора. Варианты: `"show_all"` `"hide_query"` `"hide_handles"` `"hide_all"`
notify_audit логическое	Отправлять ли уведомления отмеченным пользователям при изменениях в этом мониторе. Варианты: `false` ← (по умолчанию) `true`
notify_no_data логическое	Отправлять ли уведомления об отсутствии отчетов данных по этому монитору. Варианты: `false` ← (по умолчанию) `true`
priority целое добавлен в community.general 4.6.0	Целое число от 1 (высокий) до 5 (низкий), указывающее на серьезность оповещения.
query строка	Запрос монитора, по которому необходимо отправлять оповещения. Синтаксис зависит от типа создаваемого монитора.
renotify_interval строка	Количество минут после последнего оповещения, прежде чем монитор повторно оповестит о текущем статусе. Повторное уведомление будет отправлено только в случае, если проблема не решена.
renotify_occurrences целое добавлен в community.general 7.1.0	Количество раз, когда должны быть отправлены повторные сообщения об оповещениях по текущему статусу с заданным интервалом.

END_OF_DOCUMENT_MARKER

renotify_statuses список / элементы=строка добавлен в community.general 7.1.0	Типы статусов монитора, для которых отправляются сообщения о повторном уведомлении. Варианты: `"alert"` `"warn"` `"no data"`
require_full_window булево	Требуется ли для оценки этого монитора полный набор данных. Сильно рекомендуем установить значение в False для разреженных метрик, иначе некоторые оценки будут пропущены. Варианты: `false` `true`
silenced словарь	Словарь областей для отключения, со временем или None. Каждая область будет отключена до указанного временного отметки POSIX или навсегда, если значение равно None.
state строка / обязательно	Установленное состояние монитора. Варианты: `"present"` `"absent"` `"mute"` `"unmute"`
tags список / элементы=строка	Список тегов для сопоставления с вашим монитором при создании или обновлении. Это может помочь в категоризации и фильтрации мониторов.
thresholds словарь	Словарь пороговых значений по статусу. Доступно только для проверок сервисов и предупреждений по метрикам. Так как каждый из них может иметь несколько пороговых значений, мы их не определяем напрямую в запросе. Если не указано, по умолчанию: `{'ok': 1, 'critical': 1, 'warning': 1}`.
timeout_h строка	Количество часов, в течение которых монитор не сообщает данных, прежде чем автоматически разрешится из состояния срабатывания.
type строка	Тип монитора. Типы `query alert`, `trace-analytics alert` и `rum alert` были добавлены в community.general 2.1.0. Тип `composite` был добавлен в community.general 3.4.0. Тип `event-v2 alert` был добавлен в community.general 4.8.0. Варианты: `"metric alert"` `"service check"` `"event alert"` `"event-v2 alert"` `"process alert"` `"log alert"` `"query alert"` `"trace-analytics alert"` `"rum alert"` `"composite"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогноз изменённого статуса без изменения целевого объекта.
diff_mode	Поддержка: нет	Вернёт подробности о том, что изменилось (или, возможно, должно измениться в `check_mode`), когда включен режим diff.

Примеры

- name: Create a metric monitor
  community.general.datadog_monitor:
    type: "metric alert"
    name: "Test monitor"
    state: "present"
    renotify_interval: 30
    renotify_occurrences: 1
    renotify_statuses: ["warn"]
    notification_preset_name: "show_all"
    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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/datadog_monitor_module.html