Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

string

добавлен в community.general 0.2.0

URL API Datadog. Значение по умолчанию: https://api.datadoghq.com.

Это значение также можно задать с помощью переменной окружения DATADOG_HOST.

api_key

string / обязательный

Ваш ключ API Datadog.

app_key

string / обязательный

Ваш ключ приложения Datadog.

escalation_message

string

Сообщение, добавляемое к повторному уведомлению. Поддерживает уведомления вида ‘@username’, которые разрешены и в других местах.

Не применяется, если renotify_interval=none.

evaluation_delay

string

Задержка оценки (в секундах).

Подходит для разреженных значений.

id

string

Идентификатор оповещения.

Если задан, используется вместо name для поиска оповещения.

include_tags

boolean

добавлен в community.general 1.3.0

Указывает, автоматически ли добавляются сработавшие теги этого монитора в заголовок уведомлений.

Варианты:

  • false
  • true ← (по умолчанию)

locked

boolean

Указывает, могут ли изменять этот монитор только его создатель или администраторы.

Варианты:

  • false ← (по умолчанию)
  • true

name

string / обязательный

Название оповещения.

new_host_delay

string

Положительное целое число, указывающее количество секунд ожидания перед оценкой монитора для новых хостов.

Это дает хосту время для полной инициализации.

no_data_timeframe

string

Количество минут, по истечении которых монитор отправляет уведомление, если данные перестают поступать.

Для оповещений по метрикам значение должно быть не меньше удвоенного временного интервала монитора, а для проверок служб — не меньше 2 минут.

Если значение не задано, по умолчанию используется удвоенный временной интервал для метрик и 2 минуты для служб.

notification_message

string

Сообщение, включаемое в уведомления для этого монитора.

Уведомления по электронной почте можно отправлять определенным пользователям, используя ту же запись ‘@username’, что и для событий.

Переменные шаблона сообщения монитора можно указать с помощью двойных квадратных скобок, то есть [[ и ]].

notification_preset_name

string

добавлен в community.general 7.1.0

Включает или отключает отображение дополнительного содержимого, отправляемого в уведомлении монитора.

Варианты:

  • "show_all"
  • "hide_query"
  • "hide_handles"
  • "hide_all"

notify_audit

boolean

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

Варианты:

  • false ← (по умолчанию)
  • true

notify_no_data

boolean

Указывает, отправляет ли монитор уведомления, если данные перестают поступать.

Варианты:

  • false ← (по умолчанию)
  • true

priority

integer

добавлен в community.general 4.6.0

Целое число от 1 (высокий) до 5 (низкий), указывающее серьезность оповещения.

query

string

Запрос монитора, при выполнении которого отправляется уведомление.

Синтаксис зависит от типа создаваемого монитора.

renotify_interval

string

Количество минут после последнего уведомления, по истечении которого монитор повторно отправляет уведомление о текущем состоянии.

Повторное уведомление отправляется, только если состояние не разрешено.

renotify_occurrences

integer

добавлен в community.general 7.1.0

Количество повторных уведомлений о текущем состоянии, отправляемых с заданным интервалом повторной отправки.

renotify_statuses

list / элементы=string

добавлен в community.general 7.1.0

Типы состояний монитора, для которых отправляются повторные уведомления.

Варианты:

  • "alert"
  • "warn"
  • "no data"

require_full_window

boolean

Указывает, требуется ли монитору полный временной интервал данных перед оценкой.

Для разреженных метрик настоятельно рекомендуем задать значение false, иначе некоторые оценки будут пропущены.

Варианты:

  • false
  • true

silenced

dictionary

Словарь областей, для которых следует отключить уведомления, с временными метками или значением None.

Для каждой области уведомления отключаются до указанной временной метки POSIX или навсегда, если значение равно None.

state

string / обязательный

Требуемое состояние монитора.

Варианты:

  • "present"
  • "absent"
  • "mute"
  • "unmute"

tags

list / элементы=string

Список тегов, связываемых с монитором при создании или обновлении.

Это помогает классифицировать мониторы и фильтровать их.

thresholds

dictionary

Словарь пороговых значений по состояниям.

Доступно только для проверок служб и оповещений по метрикам.

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

Если значение не задано, используется значение по умолчанию: {'ok': 1, 'critical': 1, 'warning': 1}.

timeout_h

string

Количество часов, в течение которых монитор не получает данные, прежде чем автоматически снимает состояние сработавшего оповещения.

type

string

Тип монитора.

Типы 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).

Примеры

- 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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/datadog_monitor_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API