Параметры Prometheus#

Параметры создания и редактирования канала уведомлений#

Эти параметры указываются в качестве parameters в методах CreateNotificationChannel и ModifyNotificationChannel

При создании нового канала уведомлений нужно обязательно указать все параметры, отмеченные как Необходимые. При изменении существующего канала уведомлений нужно обязательно передать все параметры, для которых предусмотрена возможность редактирования. Если параметр не передан, то его значение будет очищено. Параметры, для которых редактирование недоступно, передавать не обязательно, но при их передаче значение должно соответствовать текущему.

type#

Тип канала.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да	Нет	String	email Telegram webhook

is_default#

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

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет	Есть	Boolean	true false

send_resolved#

Указывает, уведомлять ли о решённых проблемах.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет	Есть	Boolean	true false

bot_token#

Роль для анонимного доступа.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Да	Есть	String	Telegram	Корректный токен Telegram

chat_id#

Идентификатор чата Telegram.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Да	Есть	Integer	Telegram	Корректный идентификатор чата Telegram

url#

URL, на который направляется запрос при срабатывании предупреждения.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Да	Есть	String	webhook	Корректный URL

max_alerts#

Максимальное количество предупреждений в сообщении. Предупреждения сверх этого количества будут утеряны.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Нет	Есть	Integer	webhook	Положительное число

to#

Адрес отправки писем.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Да	Есть	String	email	Корректный адрес электронной почты

from#

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

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Нет	Есть	String	email	Корректный адрес электронной почты

smarthost#

Адрес SMTP-сервера, через который будут отправляться письма.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Да	Есть	String	email	Корректный адрес SMTP-сервера с обязательным указанием порта

hello#

Имя хоста для идентификации на SMTP-сервере.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Нет	Есть	String	email	Корректное имя хоста или IP-адрес

require_tls#

Использовать зашифрованное соединение с SMTP-сервером.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Да, если указаны auth_username и auth_password	Есть	Boolean	email	true false

auth_username#

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

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Нет	Есть	String	email	Строка длиной до 256 символов

auth_password#

Пароль пользователя для аутентификации на SMTP-сервере.

Необходимо	Возможность редактирования	Тип данных	Тип канала	Допустимые значения
Нет	Есть	String	email	Строка длиной до 256 символов

monitoring#

Подключение к сервису мониторинга.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения	По умолчанию
Для всех сервисов, кроме Prometheus	Есть	Boolean	true false	false

monitor_by#

Идентификатор сервиса мониторинга. Указанный сервис должен быть развёрнут в том же проекте, что и текущий сервис.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да, если передан параметр `monitoring = true`. Если `monitoring = false`, передача параметра невозможна	Есть	String	ID сервиса мониторинга, расположенного в том же VPC, что и текущий сервис

monitoring_labels#

Метки, которые будут назначены метрикам мониторируемого сервиса в сервисе мониторинга.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет. Если `monitoring = false`, передача параметра невозможна	Есть	Dict	Имя метки может содержать цифры, латинские буквы, символ подчёркивания. Значение метки может содержать любые ASCII-символы.

options#

Контейнер для других параметров ELK.

Примечание

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

Необходимо	Тип данных	Допустимые значения
Нет	Dict	N/A

Параметры создания и редактирования маршрута#

Эти параметры указываются в качестве parameters в методах CreatePrometheusRoute и ModifyPrometheusRoute

matchers#

Критерии, по которым происходит выбор получателя уведомлений. Фильтр matchers может содержать одно либо несколько условий, определяющих, будет ли отправлено предупреждение данному получателю. Условие состоит из названия метки, оператора и значения. Поддерживаемые операторы: =, !=, =~, !~. Если условий несколько, применяется операция «логическое И».
Пример matchers:

alertname = "Node down"
severity =~ "warning|critical"

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да	Есть	List of strings	Корректный критерий выбора маршрута Prometheus

receiver#

Получатель уведомлений.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да	Есть	String	Должно быть именем одного из каналов уведомлений данного сервиса

continue#

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

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да	Есть	Boolean	true false

group_by#

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

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет	Есть	Array of strings	Список корректных меток Prometheus

group_wait#

Время ожидания перед отправкой первого уведомления о группе предупреждений. Указывается в формате Time duration

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет	Есть	String	Строка в формате Time duration. Разрешённые диапазоны: 1-30d, 1-24h, 1-60m, 1-60s, 1-99999ms. Возможна их комбинация, например 30d24h60m60s99999ms.

group_interval#

Время ожидания перед отправкой уведомления после добавления предупреждения в группу, для которой уже осуществлялась отправка уведомления. Указывается в формате Time duration

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет	Есть	String	Строка в формате Time duration. Разрешённые диапазоны: 1-30d, 1-24h, 1-60m, 1-60s, 1-99999ms. Возможна их комбинация, например 30d24h60m60s99999ms.

repeat_interval#

Время ожидания перед повторной отправкой уведомления о группе предупреждений. Указывается в формате Time duration

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Нет	Есть	String	Строка в формате Time duration. Разрешённые диапазоны: 1-30d, 1-24h, 1-60m, 1-60s, 1-99999ms. Возможна их комбинация, например 30d24h60m60s99999ms.

Параметры создания и редактирования задания на сбор данных#

Эти параметры указываются в качестве parameters в методах CreatePrometheusScrapeJob и ModifyPrometheusScrapeJob

targets#

Список адресов сторонних сервисов для подключения к мониторингу.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да	Есть	Array of strings	Список корректных адресов

labels#

Метки, которые будут присвоены получаемым метрикам. Имена меток могут содержать цифры, латинские буквы, символ подчёркивания. Имя не может начинаться с двойного символа подчёркивания. Значение метки должно быть не более 256 символов в длину.

Необходимо	Возможность редактирования	Тип данных	Допустимые значения
Да	Есть	Dict	Список корректных меток (см. описание параметра)