Как настроить получение метрик в формате Prometheus?
Необходимые условия для выполнения процедуры
Сервисы в составе Аккаунта:
Права доступа вашей учетной записи пользователя:
1. Создайте API-токен пользователя с правом доступа к статистике для работы с API (если API-токен уже создавали ранее используйте его)¶
- Для получения API-токена необходимо в клиентском портале NGENIX Multidesk на странице Мой профиль пользователя сгенерировать новый API-токен.
Сохраните полученный токен локально, после закрытия окна с токеном повторно посмотреть его не удастся и придется создавать новый токен.
2. На своей инфраструктуре c Prometheus настройте отправку регулярных запросов к API мониторинга¶
- Используйте ручку API
/configurations/instant?customerId={id}из API мониторинга. При отправке запроса необходимо указывать:- URL - полный путь запроса до ручки API со всеми параметрами;
- Токен авторизации - API-токен пользователя;
- Частоту отправки запросов - рекомендуем устанавливать частоту запросов не чаще 1 раза в минуту.
-
Убедитесь в получении метрик
realtimeTrafficиrealtimeRequestsв формате Prometheus. В параметрах метрикиrealtimeRequestsуказывается также причина блокировки и код ответа. При необходимости из этих метрик вы можете самостоятельно посчитать показатели запросов в секунду (RPS) и запросов в минуту (RPM) используя стандартные функции Prometheus:- rate(ngenix_requests) - для RPS;
- increase(ngenix_requests[1m]) - для RPM.
3. В своём инструменте мониторинга своей инфраструктуры c Prometheus настройте необходимые вам графики и оповещения¶
При обработке запроса к API и получении данных по запросу возможна задержка до двух минут.