Модуль community.grafana.grafana_contact_point — Управление контактными точками Grafana

alertmanager_password

string

Пароль для доступа к Alertmanager.

alertmanager_url

string

URL для доступа к Alertmanager.

Обязателен, если type имеет значение alertmanager.

alertmanager_username

string

Имя пользователя для доступа к Alertmanager.

client_cert

path

Файл цепочки сертификатов в формате PEM для аутентификации SSL-клиента.

Этот файл также может содержать ключ; если ключ включён, параметр client_key не требуется

client_key

path

Файл в формате PEM, содержащий закрытый ключ для аутентификации SSL-клиента.

Если параметр client_cert содержит и сертификат, и ключ, этот параметр не требуется.

dingding_message

string

Сообщение для отправки через DingDing.

dingding_message_type

string

Тип сообщения для отправки через DingDing.

dingding_title

string

Заголовок сообщения DingDing.

dingding_url

string

URL веб-перехватчика DingDing.

Обязателен, если type имеет значение dingding.

disable_resolve_message

boolean

Отключает сообщение о разрешении проблемы.

Варианты:

• false ← (по умолчанию)
• true

discord_avatar_url

string

URL аватара для сообщений Discord.

discord_message

string

Сообщение для отправки через Discord.

discord_title

string

Заголовок сообщения Discord.

discord_url

string

URL веб-перехватчика Discord.

Обязателен, если type имеет значение discord.

discord_use_username

boolean

Использовать ли пользовательское имя в Discord.

Варианты:

• false ← (по умолчанию)
• true

email_addresses

list / elements=string

Список адресов электронной почты для отправки сообщения.

Обязателен, если type имеет значение email.

email_message

string

Содержимое сообщения электронной почты.

email_single

boolean

Отправлять одно общее письмо или отдельные письма.

Варианты:

• false ← (по умолчанию)
• true

email_subject

string

Тема письма.

googlechat_message

string

Сообщение для отправки через Google Chat.

googlechat_title

string

Заголовок сообщения Google Chat.

googlechat_url

string

URL веб-перехватчика Google Chat.

Обязателен, если type имеет значение webhook.

grafana_api_key

string

Ключ API Grafana.

Если задан, url_username и url_password будут проигнорированы.

include_image

boolean

Добавлять ли изображение в уведомление.

Варианты:

• false ← (по умолчанию)
• true

kafka_api_version

string

Версия API Kafka.

По умолчанию: "v2"

kafka_cluster_id

string

Идентификатор кластера Kafka.

kafka_description

string

Описание конфигурации Kafka.

kafka_details

string

Дополнительные сведения о Kafka.

kafka_password

string

Пароль для доступа к Kafka.

kafka_rest_proxy_url

string

URL Kafka REST Proxy.

Обязателен, если type имеет значение kafka.

kafka_topic

string

Тема Kafka для публикации.

Обязателен, если type имеет значение kafka.

kafka_username

string

Имя пользователя для доступа к Kafka.

line_description

string

Описание сообщения Line.

line_title

string

Заголовок сообщения Line.

line_token

string

Токен доступа для Line.

Обязателен, если type имеет значение line.

name

string

Название контактной точки.

Обязательно, если state имеет значение present.

opsgenie_api_key

string

Ключ API OpsGenie.

Обязателен, если type имеет значение opsgenie.

opsgenie_auto_close

boolean

Включить ли автоматическое закрытие оповещений в OpsGenie.

Варианты:

• false
• true

opsgenie_description

string

Описание оповещения OpsGenie.

opsgenie_message

string

Сообщение для отправки через OpsGenie.

opsgenie_override_priority

boolean

Переопределять ли приоритет в OpsGenie.

Варианты:

• false
• true

opsgenie_responders

list / elements=dictionary

Список ответственных за оповещения OpsGenie.

opsgenie_send_tags_as

string

Формат отправки тегов в OpsGenie.

opsgenie_url

string

URL веб-перехватчика OpsGenie.

Обязателен, если type имеет значение pagerduty.

org_id

integer

Идентификатор организации.

По умолчанию: 1

org_name

string

Название организации.

pagerduty_class

string

Класс оповещения PagerDuty.

pagerduty_client

string

Идентификатор клиента PagerDuty.

pagerduty_client_url

string

URL клиента PagerDuty.

pagerduty_component

string

Компонент, связанный с оповещением PagerDuty.

pagerduty_details

list / elements=dictionary

Список дополнительных сведений для PagerDuty.

pagerduty_group

string

Группа, связанная с оповещением PagerDuty.

pagerduty_integration_key

string

Ключ интеграции PagerDuty.

Обязателен, если type имеет значение pagerduty.

pagerduty_severity

string

Уровень серьёзности оповещения PagerDuty.

Варианты:

• "critical"
• "error"
• "warning"
• "info"

pagerduty_source

string

Источник оповещения PagerDuty.

pagerduty_summary

string

Краткое описание оповещения PagerDuty.

provisioning

boolean

Указывает, включена ли подготовка ресурсов.

Варианты:

• false
• true ← (по умолчанию)

pushover_api_token

string

Токен API Pushover.

Обязателен, если type имеет значение pushover.

pushover_devices

list / elements=string

Список устройств для уведомлений Pushover.

pushover_expire

integer

Время истечения срока действия уведомлений Pushover.

pushover_message

string

Сообщение для отправки через Pushover.

pushover_ok_priority

integer

Приоритет сообщений OK в Pushover.

pushover_ok_sound

string

Звук для сообщений OK в Pushover.

pushover_priority

integer

Приоритет сообщений Pushover.

pushover_retry

integer

Интервал повторной отправки сообщений Pushover.

pushover_sound

string

Звук для уведомлений Pushover.

pushover_title

string

Заголовок сообщения Pushover.

pushover_upload_image

boolean

Загружать ли изображение вместе с уведомлением Pushover.

Варианты:

• false
• true ← (по умолчанию)

pushover_user_key

string

Ключ пользователя Pushover.

Обязателен, если type — pushover.

sensugo_api_key

string

Ключ API для Sensu Go.

Обязателен, если type — pushover.

sensugo_check

string

Имя проверки для Sensu Go.

sensugo_entity

string

Имя сущности для Sensu Go.

sensugo_handler

string

Обработчик для Sensu Go.

sensugo_message

string

Сообщение для отправки через Sensu Go.

sensugo_namespace

string

Пространство имён для Sensu Go.

sensugo_url

string

URL для Sensu Go.

Обязателен, если type — sensugo.

slack_endpoint_url

string

URL конечной точки веб-перехватчика Slack.

slack_icon_emoji

string

Эмодзи значка для сообщений Slack.

slack_icon_url

string

URL значка для сообщений Slack.

slack_mention_channel

string

Упоминание канала в сообщениях Slack.

Варианты:

• "here"
• "channel"

slack_mention_groups

list / elements=string

Список групп для упоминания в сообщениях Slack.

slack_mention_users

list / elements=string

Список пользователей для упоминания в сообщениях Slack.

slack_recipient

string

Получатель сообщений Slack.

Обязателен, если type — slack.

slack_text

string

Текст сообщений Slack.

slack_title

string

Заголовок сообщения Slack.

slack_token

string

Токен для аутентификации в Slack.

Обязателен, если type — slack.

slack_url

string

URL веб-перехватчика Slack.

Обязателен, если type — slack.

slack_username

string

Имя пользователя для сообщений Slack.

state

string

Состояние контактной точки.

Варианты:

• "present" ← (по умолчанию)
• "absent"

teams_message

string

Сообщение для отправки через Microsoft Teams.

teams_section_title

string

Заголовок раздела сообщений Microsoft Teams.

teams_title

string

Заголовок сообщения Microsoft Teams.

teams_url

string

URL веб-перехватчика Microsoft Teams.

Обязателен, если type — teams.

telegram_chat_id

string

ID чата в Telegram.

Обязателен, если type — telegram.

telegram_disable_notifications

boolean

Отключать ли уведомления для сообщений Telegram.

Варианты:

• false
• true

telegram_message

string

Сообщение для отправки через Telegram.

telegram_parse_mode

string

Режим разбора сообщений Telegram.

telegram_protect_content

boolean

Защищать ли содержимое сообщений Telegram.

Варианты:

• false
• true

telegram_token

string

Токен для аутентификации в Telegram.

Обязателен, если type — telegram.

telegram_web_page_view

boolean

Включать ли предварительный просмотр веб-страниц в сообщениях Telegram.

Варианты:

• false
• true

threema_api_secret

string

Секретный ключ API для Threema.

Обязателен, если type — threema.

threema_description

string

Описание сообщений Threema.

threema_gateway_id

string

ID шлюза Threema.

Обязателен, если type — threema.

threema_recipient_id

string

ID получателя сообщений Threema.

Обязателен, если type — threema.

threema_title

string

Заголовок сообщения Threema.

type

string

Тип контактной точки.

Обязателен, если state — present.

Варианты:

• "alertmanager"
• "dingding"
• "discord"
• "email"
• "googlechat"
• "kafka"
• "line"
• "opsgenie"
• "pagerduty"
• "pushover"
• "sensugo"
• "slack"
• "teams"
• "telegram"
• "threema"
• "victorops"
• "webex"
• "webhook"
• "wecom"

uid

string / обязательный

Уникальный идентификатор контактной точки.

Обычно uid генерируется случайным образом, но для управления контактной точкой через API он обязателен.

url

псевдонимы: grafana_url

string / обязательный

URL Grafana.

url_password

псевдонимы: grafana_password

string

Пароль Grafana для аутентификации через API.

По умолчанию: "admin"

url_username

псевдонимы: grafana_user

string

Пользователь Grafana для аутентификации через API.

По умолчанию: "admin"

use_proxy

boolean

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

Варианты:

• false
• true ← (по умолчанию)

validate_certs

boolean

Если false, сертификаты SSL не будут проверяться.

Устанавливайте это значение в false только на сайтах под личным управлением, использующих самоподписанные сертификаты.

Варианты:

• false
• true ← (по умолчанию)

victorops_description

string

Описание сообщений VictorOps.

victorops_message_type

string

Тип сообщения для VictorOps.

Варианты:

• "CRITICAL"
• "RECOVERY"

victorops_title

string

Заголовок сообщения VictorOps.

victorops_url

string

URL веб-перехватчика VictorOps.

Обязателен, если type — victorops.

webex_api_url

string

URL API для Webex.

webex_message

string

Сообщение для отправки через Webex.

webex_room_id

string

ID комнаты для сообщений Webex.

Обязателен, если type — webex.

webex_token

string

Токен для аутентификации в Webex.

Обязателен, если type — webex.

webhook_authorization_credentials

string

webhook_authorization_scheme

string

webhook_http_method

string

Метод HTTP для веб-перехватчика.

Варианты:

• "POST"
• "PUT"

webhook_max_alerts

integer

Максимальное количество оповещений для веб-перехватчика.

webhook_message

string

Сообщение для отправки через веб-перехватчик.

webhook_password

string

Пароль для аутентификации веб-перехватчика.

webhook_title

string

Заголовок сообщения веб-перехватчика.

webhook_url

string

URL веб-перехватчика.

Обязателен, если type — webhook.

webhook_username

string

Имя пользователя для аутентификации веб-перехватчика.

wecom_agent_id

string

ID агента WeCom.

Обязателен, если type — wecom.

wecom_corp_id

string

Идентификатор организации WeCom.

Обязателен, если type — wecom.

wecom_message

string

Сообщение для отправки через WeCom.

wecom_msg_type

string

Тип сообщения для WeCom.

wecom_secret

string

Секретный ключ для аутентификации в WeCom.

Обязателен, если type — wecom.

wecom_title

string

Заголовок сообщения WeCom.

wecom_to_user

list / elements=string

Список пользователей, которым нужно отправить сообщение WeCom.

wecom_url

string

URL веб-перехватчика WeCom.

Обязателен, если type — wecom.

contact_point

complex

Контактная точка, созданная или обновлённая модулем.

Возвращается: success

disableResolveMessage

boolean

Отключено ли сообщение о разрешении для контактной точки.

Возвращается: success

Пример: [false]

name

string

Имя контактной точки.

Возвращается: success

Пример: "['supportmail']"

secureFields

dictionary

Конфигурация защищённых полей контактной точки.

Возвращается: success

settings

dictionary

Настройки контактной точки, зависящие от её типа.

Возвращается: success

Пример: [{"addresses": "support@example.com", "singleEmail": false}]

type

string

Тип контактной точки.

Возвращается: success

Пример: "['email']"

uid

string

UID контактной точки.

Возвращается: success

Пример: "['ddmyrs0f74t8hc']"

diff

complex

Различия между предыдущей и обновлённой контактными точками.

Возвращается: changed

after

dictionary

Текущая контактная точка.

Возвращается: changed

Пример: [{"disableResolveMessage": true, "name": "supportmail", "secureFields": {}, "settings": {"addresses": "support123@example.com", "singleEmail": false}, "type": "email", "uid": "ddmyrs0f74t8hc"}]

before

dictionary

Предыдущая контактная точка.

Возвращается: changed

Пример: [{"disableResolveMessage": false, "name": "supportmail", "secureFields": {}, "settings": {"addresses": "support@example.com", "singleEmail": false}, "type": "email", "uid": "ddmyrs0f74t8hc"}]