pagerduty_alert – Вызов, подтверждение или разрешение инцидентов PagerDuty
Описание
- Этот модуль позволит вам вызывать, подтверждать или разрешать инцидент PagerDuty, отправляя события.
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- Доступ к API PagerDuty
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_key - / обязательно | Ключ API pagerduty (только для чтения), сгенерированный на сайте pagerduty. | |
| client - | Имя клиента мониторинга, который вызывает это событие. | |
| client_url - | URL клиента мониторинга, который вызывает это событие. | |
| desc - | По умолчанию: "Создано через Ansible" | Для triggered состояния - Обязательно. Краткое описание проблемы, которая привела к этому вызову. Это поле (или усеченная версия) будет использоваться при генерации телефонных звонков, сообщений SMS и электронных писем об оповещениях. Оно также будет отображаться в таблицах инцидентов в пользовательском интерфейсе PagerDuty. Максимальная длина составляет 1024 символа.Для acknowledged или resolved состояния - Текст, который будет отображаться в журнале инцидента, связанном с этим событием. |
| incident_key - добавлено в 2.7 | Идентифицирует инцидент, к которому должно быть применено это состояние. Для triggered состояния - Если нет открытого (т.е. неразрешенного) инцидента с этим ключом, будет создан новый. Если уже существует открытый инцидент с соответствующим ключом, это событие будет добавлено в журнал этого инцидента. Ключ события обеспечивает простой способ "устранения дублирования" сообщений об ошибках.Для acknowledged или resolved состояния - Это должен быть incident_key, полученный при первом открытии инцидента событием триггера. События подтверждения, относящиеся к разрешенным или несуществующим инцидентам, будут отброшены. | |
| integration_key - / обязательно добавлено в 2.7 | GUID одной из ваших служб "Generic API". Это "ключ интеграции", указанный на вкладке "Интеграции" службы PagerDuty. | |
| name - | Уникальное доменное имя PagerDuty. Устарело. Оно не используется с API PagerDuty REST v2. | |
| service_id - / обязательно добавлено в 2.7 | Идентификатор службы PagerDuty, когда инциденты будут вызваны, подтверждены или разрешены. | |
| service_key - | GUID одной из ваших служб "Generic API". Устарело. Используйте integration_key. | |
| state - / обязательно |
| Тип события, которое нужно отправить. |
Примеры
# Trigger an incident with just the basic options
- pagerduty_alert:
name: companyabc
integration_key: xxx
api_key: yourapikey
service_id: PDservice
state: triggered
desc: problem that led to this trigger
# Trigger an incident with more options
- 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
# Acknowledge an incident based on incident_key
- pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice
state: acknowledged
incident_key: somekey
desc: "some text for incident's log"
# Resolve an incident based on incident_key
- pagerduty_alert:
integration_key: xxx
api_key: yourapikey
service_id: PDservice
state: resolved
incident_key: somekey
desc: "some text for incident's log"
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- 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.8/modules/pagerduty_alert_module.html
