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"
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.
Для получения помощи в разработке модулей, если вы так захотите, прочитайте Информацию о сообществе и участие, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/pagerduty_alert_module.html