Cервис мониторинга
Сервис мониторинга использует набор конфигурационных переменных, которые определяют его поведение, параметры обработки индикаторов здоровья, подключения к источникам данных и внешним сервисам, а также параметры хранения истории и фоновой обработки.
Порядок применения значений
Значение каждой переменной определяется в следующем порядке приоритета:
- значение, сохранённое через UI — для переменных, доступных к изменению в интерфейсе;
- переменная окружения или значение из
.env; - значение по умолчанию, заданное в коде сервиса.
Таким образом:
- если параметр был изменён в UI, используется именно это значение;
- если параметр не задан в UI, используется значение из переменных среды;
- если и оно отсутствует, применяется значение по умолчанию.
- Переменные, достпные в UI
- Скрытые переменные
Переменные раздела API
LOG_LEVEL
- Переменная среды:
MONITORING_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования.
ACCESS_LOG_LEVEL
- Переменная среды:
MONITORING_ACCESS_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования доступа к API.
CHECK_ALERT_EXPIRED
- Переменная среды:
CHECK_ALERT_EXPIRED- Тип: целое число
- По умолчанию:
5 - Описание: периодичность проверки просроченных
resolveв history.
CHECK_ALERT_MANAGER_EXPIRED
- Переменная среды:
CHECK_ALERT_MANAGER_EXPIRED- Тип: целое число
- По умолчанию:
1 - Описание: периодичность проверки просроченных
resolveв активных alert.
CHECK_HI_HISTORY_CONSISTENT
- Переменная среды:
CHECK_HI_HISTORY_CONSISTENT- Тип: целое число
- По умолчанию:
10 - Описание: периодичность проверки консистентности истории HI и её связей в минутах.
CHECK_HI_HISTORY
- Переменная среды:
CHECK_HI_HISTORY- Тип: целое чис��о
- По умолчанию:
60 - Описание: периодичность проверки несуществующих и не закрытых индикаторов в истории индикаторов.
DATASOURCE_URL
- Переменная среды:
DATASOURCE_URL- Тип: URL
- По умолчанию:
http://metrics-storage:8428/ - Описание: адрес источника данных для получения метрик.
OPENSEARCH_URLS
- Переменная среды:
OPENSEARCH_URLS- Тип: строка
- По умолчанию:
https://opensearch:9200 - Описание: адреса нод OpenSearch, перечисленные через точку с запятой.
OPENSEARCH_TIMEOUT
- Переменная среды:
OPENSEARCH_TIMEOUT- Тип: целое число
- По умолчанию:
10 - Описание: таймаут запросов к OpenSearch в секундах.
OUTBOX_PROCESS_INTERVAL
- Переменная среды:
OUTBOX_PROCESS_INTERVAL- Тип: целое число
- По умолчанию:
30 - Описание: интервал обработки событий outbox в секундах.
HI_OUTBOX_PROCESS_INTERVAL
- Переменная среды:
HI_OUTBOX_PROCESS_INTERVAL- Тип: целое число
- По умолчанию:
30 - Описание: интервал обработки событий пересчёта HI в секундах.
HI_OUTBOX_BATCH_SIZE
- Переменная среды:
HI_OUTBOX_BATCH_SIZE- Тип: целое число
- По умолчанию:
100 - Описание: размер пакета событий пересчёта HI.
NOTIFICATION_EXPIRATION
- Переменная среды:
MONITORING_NOTIFICATION_EXPIRATION- Тип: целое число
- По умолчанию:
10 - Описание: время хранения истории уведомлений в сутках.
Переменные раздела Cleanup
HISTORY_DELETE_DAYS
- Переменная среды:
HISTORY_DELETE_DAYS- Тип: целое число
- По умолчанию:
365 - Описание: количество дней хранения истории индикаторов.
Переменные раздела Sentry
PROFILE
- Переменная среды:
MONITORING_PROFILE- Тип: булево значение
- По умолчанию:
False - Описание: включает профилирование через Sentry.
Скрытые переменные сервиса мониторинга
Следующие переменные используются сервисом мониторинга, но не отображаются в UI.
Их можно изменить только через .env-файлы.
Настройки подключения к PostgreSQL
POSTGRES_SCHEMA
- Переменная среды:
MONITORING_POSTGRES_SCHEMA - Тип: строка
- По умолчанию:
monitoring - Описание: схема PostgreSQL, используемая сервисом мониторинга.
POSTGRES_POOL
- Переменная среды:
MONITORING_POSTGRES_POOL - Тип: булево значение
- По умолчанию:
True - Описание: включает использование пула соединений PostgreSQL.
POSTGRES_POOL_SIZE
- Переменная среды:
MONITORING_POSTGRES_POOL_CONNECT - Тип: целое число
- По умолчанию:
20 - Описание: размер пула соединений PostgreSQL.
POSTGRES_POOL_OVERFLOW
- Переменная среды:
MONITORING_POSTGRES_POOL_OVERFLOW - Тип: целое число
- По умолчанию:
20 - Описание: количество дополнительных соединений сверх размера пула.
Общие параметры сервиса
PROJECT_NAME
- Переменная среды:
MONITORING_PROJECT_NAME - Тип: строка
- По умолчанию:
MONITORING - Описание: имя сервиса.
PROJECT_DESCRIPTION
- Переменная среды:
MONITORING_PROJECT_DESCRIPTION - Тип: строка
- По умолчанию:
Сервис мониторинга - Описание: описание сервиса.
USE_CONTAINER_IP_FOR_BIND
- Переменная среды:
MONITORING_USE_CONTAINER_IP_FOR_BIND - Тип: булево значение
- По умолчанию:
True - Описание: использовать IP контейнера для bind-адреса сервиса.
BIND_HOST
- Переменная среды:
MONITORING_BIND_HOST - Тип: строка
- По умолчанию: пустое значение
- Описание: адрес, на котором сервис принимает входящие подключения.
BIND_PORT
- Переменная среды:
MONITORING_BIND_PORT - Тип: целое число
- По умолчанию:
8004 - Описание: порт входящих подключений сервиса.
ROOT_PATH
- Переменная среды:
MONITORING_ROOT_PATH - Тип: строка
- По умолчанию:
/api/monitoring - Описание: корневой путь публикации API сервиса.
DOCS_PREFIX
- Переменная среды:
MONITORING_DOCS_PREFIX - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации документации сервиса.
WORKERS
- Переменная среды:
MONITORING_WORKERS - Тип: целое число
- По умолчанию:
1 - Описание: количество worker-процессов сервиса.
SHOW_DEBUG_SETTING
- Переменная среды:
MONITORING_SHOW_DEBUG_SETTING - Тип: булево значение
- По умолчанию:
False - Описание: управляет отображением debug-настроек.
RELOAD
- Переменная среды:
MONITORING_RELOAD - Тип: булево значение
- По умолчанию:
False - Описание: включает автоматическую перезагрузку сервиса при изменении кода.
EVENT_HANDLING
- Переменная среды:
MONITORING_EVENT_HANDLING - Тип: булево значение
- По умолчанию:
True - Описание: включает обработку событий внутри сервиса.
STATIC_PATH
- Переменная среды:
MONITORING_STATIC_PATH - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации статических файлов.
STATIC_DIR
- Тип: строка
- По умолчанию:
static - Описание: директория статических файлов сервиса.
CIS_GROUP_LIFE_TIME
- Переменная среды:
CIS_GROUP_LIFE_TIME - Тип: целое число
- По умолчанию:
20 - Описание: время отслеживания изменений после запроса данных по группе КЕ в минутах.
KEEP_ALIVE_TQL_IN_CACHE
- Переменная среды:
KEEP_ALIVE_TQL_IN_CACHE - Тип: целое число
- По умолчанию:
5 - Описание: периодичность обновления TQL в кэше.
VMAGENT_PATH
- Переменная среды:
VMAGENT_PATH - Тип: строка
- По умолчанию:
/usr/bin/vmagent - Описание: путь к утилите
vmagentдля валидации конфигурации.
VMALERT_PATH
- Переменная среды:
VMALERT_PATH - Тип: строка
- По умолчанию:
/usr/bin/vmalert - Описание: путь к утилите
vmalertдля валидации правил алертов.
INIT_RULES_PATH
- Переменная среды:
INIT_RULES_PATH - Тип: строка
- По умолчанию:
monitoring/init/rules.yml - Описание: путь к файлу начальных правил.
INIT_RULE_TEMPLATE_PATH
- Переменная среды:
INIT_RULE_TEMPLATE_PATH - Тип: строка
- По умолчанию:
monitoring/init/rule_template.yml - Описание: путь к шаблону начального правила.
MONITORING_USER_ID
- Тип: UUID
- По умолчанию:
00000000-0000-0000-8004-000000000000 - Описание: пользователь, от имени которого выполняются запросы к TQL в рамках мониторинга.
CELERY_RUN_LOCAL
- Переменная среды:
CELERY_RUN_LOCAL - Тип: булево значение
- По умолчанию:
False - Описание: запуск Celery локально.
OUTBOX_CONTEXT_DETACH
- Переменная среды:
OUTBOX_CONTEXT_DETACH - Тип: булево значение
- По умолчанию:
True - Описание: управляет отделением контекста при обработке outbox-сообщений.
OUTBOX_BATCH_SIZE
- Переменная среды:
OUTBOX_BATCH_SIZE - Тип: целое число
- По умолчанию:
20 - Описание: размер пакета при обработке outbox-сообщений.
PUBLIC_API_URL
- Переменная среды:
PUBLIC_API_URL - Тип: строка
- По умолчанию: пустое значение
- Описание: публичный URL API сервиса мониторинга.
Параметры интеграции с OpenSearch
OPENSEARCH_VERIFY_CERTS
- Переменная среды:
OPENSEARCH_VERIFY_CERTS - Тип: булево значение
- По умолчанию:
False - Описание: проверять TLS-сертификаты OpenSearch при подключении.
OPENSEARCH_USER_ROLE_ATTRIBUTE
- Переменная среды:
OPENSEARCH_USER_ROLE_ATTRIBUTE - Тип: строка
- По умолчанию:
role - Описание: имя пользовательского атрибута, значение которого используется как роль при интеграции с OpenSearch.
Внутренние адреса сервисов
MONITORING_HOST
- Переменная среды:
MONITORING_HOST - Тип: строка
- По умолчанию:
localhost - Описание: внутренний адрес сервиса мониторинга.
MONITORING_PORT
- Переменная среды:
MONITORING_PORT - Тип: целое число
- По умолчанию:
8004 - Описание: внутренний порт сервиса мониторинга.
MONITORING_VERSION_PREFIX
- Переменная среды:
MONITORING_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API сервиса мониторинга.
SRM_HOST
- Переменная среды:
SRM_HOST - Тип: строка
- По умолчанию:
localhost - Описание: внутренний адрес SRM-сервиса.
SRM_PORT
- Переменная среды:
SRM_PORT - Тип: целое число
- По умолчанию:
8002 - Описание: внутренний порт SRM-сервиса.
SRM_VERSION_PREFIX
- Переменная среды:
SRM_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API SRM-сервиса.
AUTH_HOST
- Переменная среды:
AUTH_HOST - Тип: строка
- По умолчанию:
localhost - Описание: внутренний адрес auth-сервиса.
AUTH_PORT
- Переменная среды:
AUTH_PORT - Тип: целое число
- По умолчанию:
8001 - Описание: внутренний порт auth-сервиса.
AUTH_VERSION_PREFIX
- Переменная среды:
AUTH_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API auth-сервиса.
DOCKER_TOOL_HOST
- Переменная среды:
DOCKER_TOOL_HOST - Тип: строка
- По умолчанию:
localhost - Описание: внутренний адрес сервиса Docker tool.
DOCKER_TOOL_PORT
- Переменная среды:
DOCKER_TOOL_PORT - Тип: целое число
- По умолчанию:
8006 - Описание: внутренний порт сервиса Docker tool.
DOCKER_TOOL_VERSION_PREFIX
- Переменная среды:
DOCKER_TOOL_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API сервиса Docker tool.
Параметры интеграции с Sentry
SENTRY_DSN
- Переменная среды:
MONITORING_SENTRY_DSN - Тип: строка
- По умолчанию: пустое значение
- Описание: DSN для отправки событий сервиса мониторинга в Sentry.