Модуль community.digitalocean.digital_ocean_monitoring_alerts – Программное получение метрик, а также настройка политик оповещения на основе этих метрик

Примечание

Этот модуль является частью коллекции community.digitalocean (версия 1.27.0).

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

Для установки используйте: ansible-galaxy collection install community.digitalocean.

Для использования в playbook, укажите: community.digitalocean.digital_ocean_monitoring_alerts.

Новое в community.digitalocean 1.10.0

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

API мониторинга DigitalOcean позволяет программно получать метрики, а также настраивать политики оповещения на основе этих метрик.
API мониторинга может помочь вам получить представление о производительности и потреблении ресурсов вашими приложениями.

Параметры

Параметр	Комментарии
alerts словарь	Объект оповещения, обязателен для `state=present` Поддерживает `email["email1", "email2", ...]` и `slack[{"channel1", "url1"}, {"channel2", "url2"}, ...]`
compare строка	Сравнение оповещений, обязательно для `state=present` Варианты: `"GreaterThan"` `"LessThan"`
description строка	Описание оповещения, обязательно для `state=present`
enabled логическое	Включено или нет, обязательно для `state=present` Варианты: `false` `true`
entities список / элементы=строка	Сущности оповещения, обязательно для `state=present`
oauth_token псевдонимы: API_TOKEN строка / обязательно	Токен OAuth DigitalOcean; может быть указан в переменных среды `DO_API_KEY`, `DO_API_TOKEN` или `DO_OAUTH_TOKEN`
state строка	Обычный, `present` для создания, `absent` для удаления Варианты: `"present"` ← (по умолчанию) `"absent"`
tags список / элементы=строка	Теги оповещения, обязательно для `state=present`
type строка	Тип оповещения, обязательно для `state=present` См. https://docs.digitalocean.com/reference/api/api-reference/#operation/create_alert_policy для допустимых типов Варианты: `"v1/insights/droplet/load_1"` `"v1/insights/droplet/load_5"` `"v1/insights/droplet/load_15"` `"v1/insights/droplet/memory_utilization_percent"` `"v1/insights/droplet/disk_utilization_percent"` `"v1/insights/droplet/cpu"` `"v1/insights/droplet/disk_read"` `"v1/insights/droplet/disk_write"` `"v1/insights/droplet/public_outbound_bandwidth"` `"v1/insights/droplet/public_inbound_bandwidth"` `"v1/insights/droplet/private_outbound_bandwidth"` `"v1/insights/droplet/private_inbound_bandwidth"`
uuid строка	UUID оповещения, обязательно для `state=absent`
value число с плавающей точкой	Пороговое значение оповещения, обязательно для `state=present`
window строка	Окно оповещения, обязательно для `state=present` Варианты: `"5m"` `"10m"` `"30m"` `"1h"`

Примеры

- name: Create Droplet Monitoring alerts policy
  community.digitalocean.digital_ocean_monitoring_alerts:
    state: present
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    alerts:
      email: ["alerts@example.com"]
      slack: []
    compare: GreaterThan
    description: Droplet load1 alert
    enabled: true
    entities: ["{{ droplet_id }}"]
    tags: ["my_alert_tag"]
    type: v1/insights/droplet/load_1
    value: 3.14159
    window: 5m
  register: monitoring_alert_policy

- name: Delete Droplet Monitoring alerts policy
  community.digitalocean.digital_ocean_monitoring_alerts:
    state: absent
    oauth_token: "{{ lookup('ansible.builtin.env', 'DO_API_TOKEN') }}"
    uuid: "{{ monitoring_alert_policy.data.uuid }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
data словарь	Политика оповещений DigitalOcean Monitoring Возвращается: изменено Пример: `{"alerts": {"email": ["mamercad@gmail.com"], "slack": []}, "compare": "GreaterThan", "description": "Droplet load1 alert", "enabled": true, "entities": ["262383737"], "tags": ["my_alert_tag"], "type": "v1/insights/droplet/load_1", "uuid": "9f988f00-4690-443d-b638-ed5a99bbad3b", "value": 3.14159, "window": "5m"}`

Ключ

Описание

data

словарь

Политика оповещений DigitalOcean Monitoring

Возвращается: изменено

Пример: {"alerts": {"email": ["mamercad@gmail.com"], "slack": []}, "compare": "GreaterThan", "description": "Droplet load1 alert", "enabled": true, "entities": ["262383737"], "tags": ["my_alert_tag"], "type": "v1/insights/droplet/load_1", "uuid": "9f988f00-4690-443d-b638-ed5a99bbad3b", "value": 3.14159, "window": "5m"}

Авторы

Mark Mercado (@mamercad)

Ссылки на коллекцию

© 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/digitalocean/digital_ocean_monitoring_alerts_module.html