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 | ID службы 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. [community]
Авторы
- 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.9/modules/pagerduty_alert_module.html
