pagerduty_alert - Срабатывание, подтверждение или разрешение инцидентов PagerDuty
Новая версия 1.9.
Обзор
- Этот модуль позволяет срабатывать, подтверждать или разрешать инциденты 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, который вы получили при первом открытии инцидента событием срабатывания. События подтверждения, относящиеся к разрешенным или несуществующим инцидентам, будут проигнорированы. | |
| name обязательно | Уникальный домен PagerDuty. | |
| service_key обязательно | GUID одного из ваших сервисов "Generic API". Это "ключ сервиса", указанный на странице подробностей сервиса Generic API. | |
| state обязательно |
| Тип события, которое нужно отправить. |
Примеры
# Trigger an incident with just the basic options
- pagerduty_alert:
name: companyabc
service_key: xxx
api_key: yourapikey
state: triggered
desc: problem that led to this trigger
# Trigger an incident with more options
- pagerduty_alert:
service_key: xxx
api_key: yourapikey
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:
service_key: xxx
api_key: yourapikey
state: acknowledged
incident_key: somekey
desc: "some text for incident's log"
# Resolve an incident based on incident_key
- pagerduty_alert:
service_key: xxx
api_key: yourapikey
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.5/modules/pagerduty_alert_module.html