Модуль community.grafana.grafana_notification_channel – Управление каналами уведомлений Grafana
Примечание
Этот модуль входит в коллекцию community.grafana (версия 1.9.1).
У вас может быть уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.grafana.
Чтобы использовать её в плейбуке, укажите: community.grafana.grafana_notification_channel.
Добавлена в community.grafana 1.1.0
Обзор
- Создание/обновление/удаление каналов уведомлений Grafana через API.
Параметры
Параметр | Комментарии |
|---|---|
client_cert path | Файл цепочки сертификатов в формате PEM, который будет использоваться для проверки подлинности клиента SSL. Этот файл также может включать ключ, и если ключ включен, client_key не требуется |
client_key path | Файл в формате PEM, содержащий ваш закрытый ключ, который будет использоваться для проверки подлинности клиента SSL. Если client_cert содержит и сертификат, и ключ, этот параметр не требуется. |
dingding_message_type list / elements=string | Тип сообщения DingDing. Варианты:
|
dingding_url string | URL веб-хука DingDing. |
disable_resolve_message boolean | Отключить сообщение о разрешении. Варианты:
|
discord_message_content string | Переопределяет содержимое сообщения. |
discord_url string | URL веб-хука Discord. |
email_addresses list / elements=string | Список получателей. |
email_single boolean | Отправить одно электронное письмо всем получателям. Варианты:
|
googlechat_url string | URL веб-хука Google Hangouts. |
grafana_api_key string | Ключ API Grafana. Если задано, |
hipchat_api_key string | Ключ API HipChat. |
hipchat_room_id string | ID комнаты HipChat. |
hipchat_url string | URL веб-хука HipChat. |
include_image boolean | Захватить изображение визуализации и прикрепить его к уведомлениям. Варианты:
|
is_default boolean | Использовать этот канал для всех оповещений. Варианты:
|
kafka_topic string | Имя темы Kafka. |
kafka_url string | URL прокси Kafka REST. |
line_token string | Токен LINE. |
name string | Название канала уведомлений. Требуется, когда state имеет значение |
opsgenie_api_key string | Ключ API OpsGenie. |
opsgenie_auto_close boolean | Автоматически закрывать оповещения в OpsGenie, как только оповещение вернется в состояние ok. Варианты:
|
opsgenie_override_priority boolean | Разрешить установку приоритета оповещения с помощью тега og_priority. Варианты:
|
opsgenie_url string | URL вебхука OpsGenie. |
org_id integer | Идентификатор организации Grafana, куда будет импортирована/экспортирована панель мониторинга. Не используется, если установлен grafana_api_key, поскольку grafana_api_key принадлежит только одной организации. Default: |
pagerduty_auto_resolve boolean | Автоматически разрешать инциденты в PagerDuty, как только оповещение вернется в состояние «ok». Choices:
|
pagerduty_integration_key string | Ключ интеграции PagerDuty. |
pagerduty_message_in_details boolean | Переместить сообщение оповещения из сводки PD в пользовательские детали. Это изменяет объект пользовательских деталей и может нарушить настроенные правила событий. Choices:
|
pagerduty_severity list / elements=string | Серьезность оповещения в PagerDuty. Choices:
|
prometheus_password string | Пароль Prometheus. |
prometheus_url string | URL API Prometheus. |
prometheus_username string | Имя пользователя Prometheus. |
pushover_alert_sound string | |
pushover_api_token string | Токен API Pushover. |
pushover_devices list / elements=string | Список устройств в Pushover. |
pushover_expire integer | Срок действия оповещения в Только когда приоритет равен |
pushover_ok_sound string | |
pushover_priority list / elements=string | Приоритет оповещения в Pushover. Choices:
|
pushover_retry integer | Повтор через Только когда приоритет равен |
pushover_user_key string | Ключ пользователя Pushover. |
reminder_frequency string | Интервал дополнительных уведомлений для активированных оповещений. Например, |
sensu_handler string | Имя обработчика Sensu. |
sensu_password string | Пароль Sensu. |
sensu_source string | Источник в Sensu. |
sensu_url string | URL вебхука Sensu. |
sensu_username string | Пользователь Sensu. |
slack_icon_emoji string | Emoji для использования в сообщении бота. |
slack_icon_url string | URL изображения, используемого в качестве значка для сообщения бота |
slack_mention_channel list / elements=string | Упоминать весь канал или только активных участников. Варианты:
|
slack_mention_groups list / elements=string | Список упоминаемых групп. |
slack_mention_users list / elements=string | Список упоминаемых пользователей. |
slack_recipient string | Переопределение значения канала или пользователя Slack по умолчанию. |
slack_token string | Токен Slack. |
slack_url string | URL вебхука Slack. |
slack_username string | Установка имени пользователя для сообщения бота. |
state string | Состояние канала уведомлений. Варианты:
|
teams_url string | URL вебхука Microsoft Teams. |
telegram_bot_token string | Токен бота Telegram. |
telegram_chat_id string | ID чата Telegram. |
threema_api_secret string | Секрет API шлюза Threema. |
threema_gateway_id string | 8-значный идентификатор шлюза Threema (начинается со звёздочки *). |
threema_recipient_id string | 8-значный идентификатор Threema, который должен получать оповещения. |
type string | Тип уведомления канала. Требуется, когда state равен Варианты:
|
uid string | Уникальный идентификатор канала. |
url aliases: grafana_url string / обязательно | URL Grafana. |
url_password aliases: grafana_password string | Пароль Grafana для аутентификации API. По умолчанию: |
url_username aliases: grafana_user string | Пользователь Grafana для аутентификации API. По умолчанию: |
use_proxy boolean | Если Варианты:
|
validate_certs boolean | Если Это следует устанавливать только в Варианты:
|
victorops_auto_resolve boolean | Разрешить инциденты в VictorOps, когда предупреждение вернётся к значению «ok». Варианты:
|
victorops_url string | URL вебхука VictorOps. |
webhook_http_method list / elements=string | HTTP-глагол вебхука для использования. Варианты:
|
webhook_password string | Пароль вебхука. |
webhook_url string | URL вебхука. |
webhook_username string | Имя пользователя вебхука. |
Примечания
Примечание
- Каналы уведомлений заменены точками контакта, начиная с Grafana 8.3, и данный модуль в настоящее время не может управлять точками контакта.
- Модуль будет сообщать об успешном выполнении, так как Grafana поддерживает обратную совместимость с предыдущей системой управления оповещениями, но
- ничего не будет видно в точках контакта, если включён новый механизм оповещений.
Примеры
- 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 dictionary | Созданный или обновлённый модулем канал уведомлений. Возвращаемое значение: changed Пример: |
Ссылки на коллекции
© 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/grafana/grafana_notification_channel_module.html