Модуль community.general.pagerduty_alert — запуск, подтверждение или разрешение инцидентов PagerDuty

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля требуются дополнительные компоненты. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.pagerduty_alert.

Краткое описание
Требования
Параметры
Атрибуты
Примеры

Краткое описание

Этот модуль позволяет запускать, подтверждать или разрешать инциденты PagerDuty, отправляя события.

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

Доступ к API PagerDuty

Параметры

Параметр	Комментарии
api_key строка	Ключ API PagerDuty (доступ только для чтения), созданный на сайте PagerDuty. Обязателен, если `api_version=v1`.
api_version строка добавлено в community.general 7.4.0	Версия API, которую следует использовать при выполнении модуля. В V1 меньше параметров, которые можно указать для запуска инцидента. В V2 доступно больше переменных, например `severity`, `source`, `custom_details` и так далее. Варианты: `"v1"` ← (по умолчанию) `"v2"`
client строка	Имя клиента мониторинга, который запускает это событие.
client_url строка	URL клиента мониторинга, который запускает это событие.
component строка добавлено в community.general 7.4.0	Компонент исходного компьютера, отвечающий за событие, например `mysql` или `eth0`.
custom_details словарь добавлено в community.general 7.4.0	Дополнительные сведения о событии и затронутой системе. Словарь с пользовательскими ключами и значениями.
desc строка	Для `state=triggered` — обязательно. Краткое описание проблемы, вызвавшей это событие. Это поле (или его сокращённый вариант) используется при формировании телефонных звонков, SMS-сообщений и уведомлений по электронной почте. Оно также отображается в таблицах инцидентов в интерфейсе PagerDuty. Максимальная длина — 1024 символа. Для `state=acknowledged` или `state=resolved` — текст, отображаемый в журнале инцидента для этого события. По умолчанию: `"Created via Ansible"`
incident_class строка добавлено в community.general 7.4.0	Класс или тип события, например `ping failure` или `cpu load`.
incident_key строка	Определяет инцидент, к которому следует применить это событие `state`. Для `state=triggered` — если открытого (то есть неразрешённого) инцидента с таким ключом нет, создаётся новый. Если открытый инцидент с соответствующим ключом уже существует, событие добавляется в журнал этого инцидента. Ключ события позволяет легко устранять дубликаты сообщений о проблемах. Если `incident_key` не указан, его генерирует PagerDuty. Для `state=acknowledged` или `state=resolved` — это должен быть incident_key, полученный в ответ при первоначальном открытии инцидента событием запуска. События подтверждения, ссылающиеся на разрешённые или несуществующие инциденты, отбрасываются.
integration_key строка	GUID одной из ваших служб «Generic API». Это «ключ интеграции», указанный на вкладке «Integrations» службы PagerDuty.
link_text строка добавлено в community.general 7.4.0	Краткое описание `link_url`.
link_url строка добавлено в community.general 7.4.0	URL ссылки, относящейся к оповещению. Например, ссылка на веб-сайт или задание.
name строка	Уникальный поддомен PagerDuty. Устарел. Не используется с API PagerDuty REST v2.
service_id строка	ID службы PagerDuty, для которой запускаются, подтверждаются или разрешаются инциденты. Обязателен, если `api_version=v1`.
service_key строка	GUID одной из ваших служб «Generic API». Устарел. Используйте `integration_key`.
severity строка добавлено в community.general 7.4.0	Оценка серьёзности состояния, описываемого событием, с точки зрения затронутой системы. Обязательно для `state=trigger` и `api_version=v2`. Варианты: `"critical"` ← (по умолчанию) `"warning"` `"error"` `"info"`
source строка добавлено в community.general 7.4.0	Уникальное расположение затронутой системы, предпочтительно имя хоста или FQDN. Обязательно для `state=trigger` и `api_version=v2`.
state строка / обязательно	Тип отправляемого события. Варианты: `"triggered"` `"acknowledged"` `"resolved"`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения о том, что изменилось (или, возможно, требует изменения в `check_mode`).

Примеры

- name: Trigger an incident with just the basic options
  community.general.pagerduty_alert:
    name: companyabc
    integration_key: xxx
    api_key: yourapikey
    service_id: PDservice
    state: triggered
    desc: problem that led to this trigger

- name: Trigger an incident with more options
  community.general.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

- name: Acknowledge an incident based on incident_key
  community.general.pagerduty_alert:
    integration_key: xxx
    api_key: yourapikey
    service_id: PDservice
    state: acknowledged
    incident_key: somekey
    desc: "some text for incident's log"

- name: Resolve an incident based on incident_key
  community.general.pagerduty_alert:
    integration_key: xxx
    api_key: yourapikey
    service_id: PDservice
    state: resolved
    incident_key: somekey
    desc: "some text for incident's log"

- name: Trigger an v2 incident with just the basic options
  community.general.pagerduty_alert:
    integration_key: xxx
    api_version: v2
    source: My Ansible Script
    state: triggered
    desc: problem that led to this trigger

- name: Trigger an v2 incident with more options
  community.general.pagerduty_alert:
    integration_key: xxx
    api_version: v2
    source: My Ansible Script
    state: triggered
    desc: problem that led to this trigger
    incident_key: somekey
    client: Sample Monitoring Service
    client_url: http://service.example.com
    component: mysql
    incident_class: ping failure
    link_url: https://pagerduty.com
    link_text: PagerDuty

- name: Acknowledge an incident based on incident_key using v2
  community.general.pagerduty_alert:
    api_version: v2
    integration_key: xxx
    incident_key: somekey
    state: acknowledged

- name: Resolve an incident based on incident_key
  community.general.pagerduty_alert:
    api_version: v2
    integration_key: xxx
    incident_key: somekey
    state: resolved

Авторы

Amanpreet Singh (@ApsOps)
Xiao Shen (@xshen1)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/pagerduty_alert_module.html