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

Примечание

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

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

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

Для использования в playbook укажите: community.general.pagerduty_alert.

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

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

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

Требования

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

Доступ к API PagerDuty

Параметры

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

Атрибуты

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

Примеры

- 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/pagerduty_alert_module.html