Как настроить получение метрик в формате Prometheus для ПО WebmonitorX?

1. Создайте API-токен пользователя с правом доступа к статистике для работы с API (если API-токен уже создавали ранее используйте его)¶

1. Для получения API-токена необходимо в клиентском портале NGENIX Multidesk на странице Мой профиль пользователя сгенерировать новый API-токен.

2. На своей инфраструктуре c Prometheus настройте отправку регулярных запросов к API мониторинга¶

1. Используйте GET запрос к ручке API /caf/instant?customerId={id} из API мониторинга. 

   При отправке запроса необходимо указывать:

   • URL - полный путь запроса до ручки API со всеми параметрами;
   • Токен авторизации - API-токен пользователя;
   • Частоту отправки запросов - рекомендуем устанавливать частоту запросов не чаще 1 раза в минуту.

2. Убедитесь в получении метрик в формате Prometheus от ПО WebmonitorX WAF. 

   К выгрузке доступны все метрики, указанные в документации WMX с метками:

   • customer_id - идентификатор Аккаунта заказчика на Платформе;
   • app_id - идентификатор приложения в личном кабинете ПО WebmonitorX, совпадает с идентификатором объекта облачный WAF на Платформе;
   • client_uuid - идентификатор экземпляра ПО WAF WebmonitorX на Платформе.

   Например, метрики в формате Prometheus в сочетании с меткой app_id, позволяют настраивать на своей стороне мониторинг трафика в разрезе по доменам. Чтобы настроить такой мониторинг для ПО WAF WebmonitorX на Платформе, требуется обслуживание каждого домена на отдельной Сервисной конфигурации и использование в качестве источника данных объекта облачный WAF с типом ПО WebmonitorX. Метка app_id при этом позволяет фильтровать метрики веб-ресурсов по доменам.

3. В своём инструменте мониторинга своей инфраструктуры c Prometheus настройте необходимые вам графики и оповещения¶