community.grafana.grafana_notification_channel – Управление каналами уведомлений Grafana
Примечание
Этот плагин входит в коллекцию community.grafana (версия 1.1.0).
Для его установки используйте: ansible-galaxy collection install community.grafana.
Для использования в книге задач укажите: community.grafana.grafana_notification_channel.
Новое в версии 1.1.0: из community.grafana
Описание
- Создание/обновление/удаление каналов уведомлений Grafana через API.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| client_cert путь | Файл цепочки сертификатов в формате PEM, используемый для аутентификации SSL клиента. Этот файл также может содержать ключ, и если ключ включен, параметр client_key не требуется | |
| client_key путь | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации SSL клиента. Если client_cert содержит как сертификат, так и ключ, этот параметр не требуется. | |
| dingding_message_type список / элементы=строка |
| Тип сообщения DingDing. |
| dingding_url строка | Webhook URL DingDing. | |
| disable_resolve_message булево |
| Отключить сообщение о разрешении. |
| discord_message_content строка | Переопределяет содержимое сообщения. | |
| discord_url строка | Webhook URL Discord. | |
| email_addresses список / элементы=строка | Список получателей. | |
| email_single булево |
| Отправить одно электронное письмо всем получателям. |
| googlechat_url строка | Webhook URL Google Hangouts. | |
| grafana_api_key строка | Ключ API Grafana. Если задано, url_username и url_password будут проигнорированы. | |
| hipchat_api_key строка | Ключ API HipChat. | |
| hipchat_room_id строка | ID комнаты HipChat. | |
| hipchat_url строка | Webhook URL HipChat. | |
| include_image булево |
| Захватить изображение визуализации и прикрепить его к уведомлениям. |
| is_default булево |
| Использовать этот канал для всех оповещений. |
| kafka_topic строка | Имя темы Kafka. | |
| kafka_url строка | URL прокси REST Kafka. | |
| line_token строка | Токен LINE. | |
| name строка | Имя канала уведомлений. Требуется, когда state равно present. | |
| opsgenie_api_key строка | Ключ API OpsGenie. | |
| opsgenie_auto_close булево |
| Автоматически закрывать оповещения в OpsGenie, когда состояние изменится на «ok». |
| opsgenie_override_priority булево |
| Разрешить установку приоритета оповещения с помощью тега og_priority. |
| opsgenie_url строка | Webhook URL OpsGenie. | |
| org_id целое число | По умолчанию: 1 | ID организации Grafana, где будет импортироваться/экспортироваться панель. Не используется, когда задан grafana_api_key, поскольку grafana_api_key относится только к одной организации. |
| pagerduty_auto_resolve булево |
| Разрешать инциденты в PagerDuty, когда состояние изменится на «ok». |
| pagerduty_integration_key строка | Ключ интеграции PagerDuty. | |
| pagerduty_message_in_details булево |
| Переместить сообщение об оповещении из сводки PD в пользовательские детали. Это изменяет объект пользовательских деталей и может нарушить правила событий, которые вы настроили. |
| pagerduty_severity список / элементы=строка |
| Уровень серьезности оповещения в PagerDuty. |
| prometheus_password строка | Пароль Prometheus. | |
| prometheus_url строка | URL API Prometheus. | |
| prometheus_username строка | Имя пользователя Prometheus. | |
| pushover_alert_sound строка | Звук оповещения в Pushover. L(https://pushover.net/api#sounds) | |
| pushover_api_token строка | Токен API Pushover. | |
| pushover_devices список / элементы=строка | Список устройств в Pushover. | |
| pushover_expire целое число | Срок действия оповещения в n минутах.Только при приоритете emergency. | |
| pushover_ok_sound строка | Звук «ok» в Pushover. L(https://pushover.net/api#sounds) | |
| pushover_priority список / элементы=строка |
| Приоритет оповещения в Pushover. |
| pushover_retry целое число | Повтор через n минут.Только при приоритете emergency. | |
| pushover_user_key строка | Ключ пользователя Pushover. | |
| reminder_frequency строка | Дополнительный интервал уведомлений для срабатывающих оповещений. Например, 15m. | |
| sensu_handler строка | Имя обработчика Sensu. | |
| sensu_password строка | Пароль Sensu. | |
| sensu_source строка | Источник в Sensu. | |
| sensu_url строка | Webhook URL Sensu. | |
| sensu_username строка | Пользователь Sensu. | |
| slack_icon_emoji строка | Эмоджи для использования в сообщении бота. | |
| slack_icon_url строка | URL изображения, используемого в качестве значка для сообщения бота. | |
| slack_mention_channel список / элементы=строка |
| Упоминание всего канала или только активных участников. |
| slack_mention_groups список / элементы=строка | Список групп для упоминания. | |
| slack_mention_users список / элементы=строка | Список пользователей для упоминания. | |
| slack_recipient строка | Переопределение по умолчанию канала или пользователя Slack. | |
| slack_token строка | Токен Slack. | |
| slack_url строка | Webhook URL Slack. | |
| slack_username строка | Установите имя пользователя для сообщения бота. | |
| state строка |
| Статус канала уведомлений. |
| teams_url строка | Webhook URL Microsoft Teams. | |
| telegram_bot_token строка | Токен бота Telegram. | |
| telegram_chat_id строка | ID чата Telegram. | |
| threema_api_secret строка | Секретный ключ API шлюза Threema. | |
| threema_gateway_id строка | 8-значный ID шлюза Threema (начинается с *). | |
| threema_recepient_id строка | 8-значный ID Threema получателя оповещений. |
| тип строка |
| Тип уведомления канала. Требуется, когда состояние равно present. |
| uid строка | Уникальный идентификатор канала. | |
| url строка / обязательно | URL Grafana. псевдонимы: grafana_url | |
| url_password строка | Значение по умолчанию: "admin" | Пароль Grafana для аутентификации API. псевдонимы: grafana_password |
| url_username строка | Значение по умолчанию: "admin" | Пользователь Grafana для аутентификации API. псевдонимы: grafana_user |
| use_proxy булево |
| Если no, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены.Это следует установить только в no на сайтах с собственным контролем, использующих самозаверяющие сертификаты. |
| victorops_auto_resolve булево |
| Разрешить инциденты в VictorOps, когда оповещение вернется в состояние ok. |
| victorops_url строка | URL веб-хука VictorOps. | |
| webhook_http_method список / элементы=строка |
| HTTP-глагол веб-хука для использования. |
| webhook_password строка | Пароль веб-хука. | |
| webhook_url строка | URL веб-хука | |
| webhook_username строка | Имя пользователя веб-хука. |
Примеры
- name: Create slack notification channel
register: result
grafana_notification_channel:
uid: slack
name: slack
type: slack
slack_url: https://hooks.slack.com/services/xxx/yyy/zzz
grafana_url: "{{ grafana_url }}"
grafana_user: "{{ grafana_username }}"
grafana_password: "{{ grafana_password}}"
- name: Delete slack notification channel
register: result
grafana_notification_channel:
state: absent
uid: slack
grafana_url: "{{ grafana_url }}"
grafana_user: "{{ grafana_username }}"
grafana_password: "{{ grafana_password}}"
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| notification_channel словарь | изменено | Созданный или обновленный модулем канал уведомлений. Пример: { "created": "2020-11-10T21:10:19.675308051+03:00", "disableResolveMessage": false, "frequency": "", "id": 37, "isDefault": false, "name": "Oops", "secureFields": {}, "sendReminder": false, "settings": { "uploadImage": false, "url": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER" }, "type": "slack", "uid": "slack-oops", "updated": "2020-11-10T21:10:19.675308112+03:00" } |
Авторы
- Алиаксандар Мянжинский (@amenzhinsky)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/grafana/grafana_notification_channel_module.html
