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. Подробности см. в Техническом обслуживании и поддержке модулей.
Список других модулей, поддерживаемых сообществом 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.6/modules/pagerduty_alert_module.html
