community.general.pagerduty_alert – Триггер, подтверждение или разрешение инцидентов PagerDuty
Примечание
Этот плагин является частью коллекции community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать его в плейбуке, укажите: community.general.pagerduty_alert.
Обзор
- Этот модуль позволит вам триггерить, подтверждать или разрешать инциденты PagerDuty, отправляя события
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- Доступ к API PagerDuty
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key строка / обязательно | Ключ API Pagerduty (только чтение), сгенерированный на сайте Pagerduty. | |
| client строка | Имя клиента мониторинга, который запускает это событие. | |
| client_url строка | URL клиента мониторинга, который запускает это событие. | |
| desc строка | По умолчанию: "Создано через Ansible" | Для triggered состояние - обязательно. Краткое описание проблемы, которая привела к этому триггеру. Это поле (или его усеченная версия) будет использоваться при генерации телефонных звонков, SMS-сообщений и электронных писем об оповещениях. Оно также будет отображаться в таблицах инцидентов в пользовательском интерфейсе PagerDuty. Максимальная длина - 1024 символа.Для acknowledged или resolved состояние - текст, который будет отображаться в журнале инцидента, связанном с этим событием. |
| incident_key строка | Идентифицирует инцидент, к которому это состояние должно быть применено. Для triggered состояние - если нет открытого (т.е. не разрешенного) инцидента с этим ключом, будет создан новый. Если уже есть открытый инцидент с соответствующим ключом, это событие будет добавлено в журнал этого инцидента. Ключ события предоставляет простой способ "устранения дублирования" сообщений о проблемах.Для acknowledged или resolved состояние - это incident_key, который вы получили обратно, когда инцидент был впервые открыт событием триггера. События подтверждения, ссылающиеся на разрешенные или несуществующие инциденты, будут отклонены. | |
| integration_key строка | GUID одной из ваших служб "Generic API". Это "ключ интеграции", указанный на вкладке "Интеграции" в службе PagerDuty. | |
| name строка | Уникальный поддомен PagerDuty. Устарел. Он не используется с API PagerDuty REST v2. | |
| service_id строка / обязательно | Идентификатор службы PagerDuty, когда инциденты будут триггериться, подтверждаться или разрешаться. | |
| service_key строка | GUID одной из ваших служб "Generic API". Устарел. Используйте integration_key. | |
| state строка / обязательно |
| Тип события, которое нужно отправить. |
Примеры
- name: Trigger an incident with just the basic options
community.general.pagerduty_alert:
name: companyabc
integration_key: xxx
api_key: yourapikey
service_id: PDservice
state: triggered
desc: problem that led to this trigger
- name: Trigger an incident with more options
community.general.pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice
state: triggered
desc: problem that led to this trigger
incident_key: somekey
client: Sample Monitoring Service
client_url: http://service.example.com
- name: Acknowledge an incident based on incident_key
community.general.pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice
state: acknowledged
incident_key: somekey
desc: "some text for incident's log"
- name: Resolve an incident based on incident_key
community.general.pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice
state: resolved
incident_key: somekey
desc: "some text for incident's log"
Авторы
- Amanpreet Singh (@ApsOps)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/pagerduty_alert_module.html
