Контрольные метрики

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

Для настройки интеграции с системами мониторинга необходимо:

  1. Указать URL HTTP-сервиса в конфигурации системы мониторинга.
  2. Настроить параметры запросов и интервалы опроса.
  3. Определить ключевые метрики, которые будут собираться и анализироваться.

 

Публикация на веб-сервере

Для работы сервиса необходимо выполнить его публикацию на веб-сервере.

Инструкции для публикации информационной базы на веб-сервере доступны в Руководстве администратора на сайте Информационно-технологического сопровождения 1C.

Для публикации сервиса необходимо:

  1. в режиме конфигуратора перейти: «Администрирование/ Публикация на веб. сервере…»;
  2. в открывшемся окне выбрать вкладку http-сервисы, и установить флаг напротив сервиса «хс_Метрики»;
  3. сохранить настройки и перезагрузить веб-сервер.

Настройка контрольной метрики

Для получения контрольной метрики необходимо выполнить ее настройку.

Список контрольных метрик находится: «Главное/ Настройки/ Контрольные метрики».

Для добавления или изменения контрольной метрики пользователь должен иметь роль «Добавление изменение метрик».

Реквизиты контрольной метрики:

  • «Наименование» — наименование контрольной метрики;
  • «Ключ» — уникальный идентификатор контрольной метрики. Используется для поиска метрики;
  • «Текст запроса» — текст запроса на языке запросов . Запрос выполняется при получении метрики. Результатом запроса может быть:
    • Структура, если в результате выполнения запроса одна строка. Ключи структуры соответствуют полям выборки запроса;
    • Массив из Структура, если в результате запроса более одной строки. Ключи структуры соответствуют полям выборки запроса;
  • «После выполнения запроса» — текст обработчика на языке . Выполняется после выполнения запроса. Предназначен для обработки результата выполнения запроса.

Получение контрольной метрики

Для получения контрольной метрики необходимо отправить http-запрос на адрес: «/metrics/get_data».

Пользователь для подключения должен иметь одну из ролей «Добавление изменение метрик» или «Чтение метрик».

В случае удачного получения сервис вернет код состояния 200 и значение метрики. В противном случае сервис вернет текст ошибки.

Сервис логирует свои действия в журнал регистрации. Имя области: «Контрольные метрики».

Пример JSON для получения метрики:

{
"КлючМетрики1": {
"Параметр1": "ЗначениеПараметра1"
},
"КлючМетрики2": null
}