В данной статье описано взаимодействие с внешними каналами и запросами для оповещений в Системе: как их добавить, просмотреть, найти, отредактировать, копировать и удалить.

Общие сведения

Система позволяет отправлять оповещения об определенных событиях во внешние системы, такие как Zabbix, Jira, Telegram и т.д.

Для управления внешними каналами и запросами необходимо перейти на вкладку Мониторинг → Внешние запросы.

На вкладке Внешние запросы расположена таблица со списком всех существующих внешних каналов оповещений и запросов. Вся информация представлена в виде древа с двумя уровнями вложенности: первый уровень отвечает за каналы оповещений, второй уровень отвечает за HTTP-запросы, с помощью которых оповещения отправляются в данные каналы.

Добавление канала для оповещений

Для того, чтобы добавить новый канал для оповещений, нажмите кнопку + в левой части таблицы и в выпадающем списке выберите Создать канал. После этого откроется модальное окно для конфигурации канала оповещений.

В данном окне вам доступны следующие параметры для конфигурации:

• Название — название канала, которое будет отображаться в списке каналов и запросов;
• Описание — описание канала, которое будет отображаться в подробной информации о канале;
• URL — адрес для доступа к API внешнего канала для оповещений; 
• Метод аутентификации — метод, который будет использоваться для аутентификации в данном канале:
  • No Auth — доступ без аутентификации;
  • Bearer Token — аутентификация с помощью токена в заголовке Authorization;
  • Basic Auth — аутентификация с помощью имени пользователя и пароля;
  • Custom Headers — аутентификация с помощью произвольных HTTP-заголовков;
  • Cookies — аутентификация с помощью куков.
• Аутентификационные данные — данные поля используются для ввода аутентификационных данных и различаются для каждого из методов аутентификации:
  • No Auth — для данного метода аутентификации поля отсутствуют;
  • Bearer Token:
    • Токен — поле для ввода токена аутентификации (пример значения: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzd...36POk6yJV_adQssw5c). 
  • Basic Auth:
    • Логин — поле для ввода имени пользователя для аутентификации (пример значения: username);
    • Пароль — поле для ввода пароля для аутентификации (пример значения: $00perPa$$wd).
  • Custom Headers:
    • Ключ — поле для ввода параметра, который будет использоваться для аутентификации (пример значения: X-API-Key);
    • Значение — поле для ввода значения параметра (пример значения: apicnnctsuppwd).
  • Cookies:
    • Значение — поле для ввода параметра и его значения для аутентификации (пример значения: PHPSESSID:n1goi0vnc9man9vcu01rvgdfr4).
• Ограничение запросов — максимальное количество запросов, которые должны отправляться по данному каналу в указанное количество минут/часов/дней;
• Проверка TLS — с помощью данного параметра вы можете отключить принудительную проверку SSL-сертификата при использовании протокола HTTPS.

Чтобы сохранить изменения, нажмите кнопку Сохранить в правом нижнем углу страницы. После этого вы будете автоматически перенаправлены на страницу со списком всех добавленных каналов и запросов. Нажмите кнопку Отменить, чтобы сбросить все внесенные изменения.

Добавление запроса

Для того, чтобы добавить новый HTTP-запрос, нажмите кнопку + в левой части таблицы и в выпадающем списке выберите Создать запрос. Вы также можете нажать кнопку + справа от имени канала в списке, чтобы автоматически выбрать канал для запроса. После этого откроется модальное окно для конфигурации запроса.

В данном окне вам доступны следующие параметры для конфигурации:

1. Название — название запроса, которое будет отображаться в списке каналов и запросов;
2. Описание — описание запроса, которое будет отображаться в подробной информации о запросе;
3. Канал — канал, в который будет отправляться данный запрос;
4. URL — путь для отправки запроса;
5. Таймаут — время в секундах до завершения запроса при отсутствии ответа;
6. Повторять при ошибке — количество повторных отправок запроса при ошибке;
7. Тип контента — тип содержимого тела запроса. Возможные значения:
   • application/json;
   • text/plain.
8. Тело запроса — поле для ввода HTTP-запроса.

Для того, чтобы проверить работу написанного вами запроса, нажмите Тест запроса. Чтобы сохранить изменения, нажмите кнопку Сохранить в правом нижнем углу страницы. После этого вы будете автоматически перенаправлены на страницу со списком всех добавленных каналов и запросов. Нажмите кнопку Отменить, чтобы сбросить все внесенные изменения.

Переменные для запросов

При формировании HTTP-запросов вы можете использовать следующие переменные:

• status — статус проблемы;
• level — уровень критичности;
• executedAt — время срабатывания;
• closedAt — время восстановления;
• executionCondition — условие срабатывания оповещения;
• closingCondition — условие восстановления оповещения;
• link — ссылка на проблему;
• rule.name — название правила;
• rule.description — описание правила;
• rule.labels — список меток правила;
• rule.tenants — список тенантов, к которым привязано правило;
• interval.from — интервал поиска от;
• interval.to — интервал поиска до.

Поиск каналов и запросов

Для того, чтобы найти определенный канал или запрос в списке, нажмите на форму поиска в левом верхнем углу таблицы и введите ключевое слово, после чего нажмите Enter.

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

Просмотр каналов и запросов

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

При просмотре канала все доступные данные будут отображены на одной вкладке. При просмотре HTTP-запроса на основной вкладке будут отображены основные параметры запроса, а его тело будет отображено на вкладке Запрос. В режиме просмотра вы также можете протестировать написанный вами запрос.

Редактирование канала и запроса

Для того, чтобы отредактировать ранее добавленный канал или запрос:

• Нажмите на канал или запрос в списке, после чего нажмите кнопку Изменить в левом нижнем углу:

• Нажмите на три точки справа от канала или запроса в списке, после чего в выпадающем списке выберите Изменить:

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

Чтобы сохранить изменения, нажмите кнопку Сохранить в правом нижнем углу страницы. После этого вы будете автоматически перенаправлены на страницу со списком всех добавленных каналов и запросов. Нажмите кнопку Отменить, чтобы сбросить все внесенные изменения.

Копирование запроса

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

После этого откроется страница редактирования скопированного запроса. Для сохранения копии нажмите Сохранить после внесения всех изменений.

Удаление канала и запроса

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

После этого, во всплывающем окне нажмите кнопку Да, удалить для подтверждения удаления. Если вы передумали удалять канал или запрос, нажмите кнопку Отменить.