Cервис уведомлений
Сервис уведомлений использует набор конфигурационных переменных, которые определяют его поведение, параметры интеграции с Alertmanager, настройки хранения и группировки сообщений, а также параметры подключения к другим сервисам платформы.
Порядок применения значений
Значение каждой переменной определяется в следующем порядке приоритета:
- значение, сохранённое через UI — для переменных, доступных к изменению в интерфейсе;
- переменная окружения или значение из
.env; - значение по умолчанию, заданное в коде сервиса.
Таким образом:
- если параметр был изменён в UI, используется именно это значение;
- если параметр не задан в UI, используется значение из переменных среды;
- если и оно отсутствует, применяется значение по умолчанию.
- Переменные, достпные в UI
- Скрытые переменные
Переменные раздела API
BELL_URL
- Переменная среды:
BELL_URL- Тип: строка
- По умолчанию:
/user/notice/send - Описание: адрес в сервисе auth, куда отправляются события.
LOG_LEVEL
- Переменная среды:
NOTIFICATION_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования.
ACCESS_LOG_LEVEL
- Переменная среды:
NOTIFICATION_ACCESS_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования доступа к API.
RESOLVE_PERIOD
- Переменная среды:
RESOLVE_PERIOD- Тип: целое число
- По умолчанию:
2 - Описание: промежуток времени, на который продляется resolve, в минутах.
TASK_KEEP_PERIOD
- Переменная среды:
TASK_KEEP_PERIOD- Тип: целое число
- По умолчанию:
7 - Описание: продолжительность хранения записей о пришедших задачах (
task) в днях.
GROUP_PERSONAL_PERIOD
- Переменная среды:
GROUP_PERSONAL_PERIOD- Тип: целое число
- По умолчанию:
15 - Описание: длительность окна группировки персональных сообщений в секундах.
ALERT_MANAGER_CONFIG_KEY
- Переменная среды:
ALERT_MANAGER_CONFIG_KEY- Тип: строка
- По умолчанию:
/alertmanager - Описание: имя ключа в Redis для хранения конфигурации Alertmanager.
ALERT_MANAGER_TEMPLATE_KEY
- Переменная среды:
ALERT_MANAGER_TEMPLATE_KEY- Тип: строка
- По умолчанию:
/am_templates/template - Описание: имя ключа в Redis для хранения шаблона Alertmanager.
ALERTMANAGER_HOST
- Переменная среды:
ALERTMANAGER_HOST- Тип: строка
- По умолчанию:
alertmanager - Описание: адрес подключения к Alertmanager.
ALERTMANAGER_PORT
- Переменная среды:
ALERTMANAGER_PORT- Тип: целое число
- По умолчанию:
9093 - Описание: порт подключения к Alertmanager.
ALERTMANAGER_PATH
- Переменная среды:
ALERTMANAGER_PATH- Тип: строка
- По умолчанию:
/api/v2/alerts - Описание: путь подключения к Alertmanager.
Переменные раздела Sentry
PROFILE
- Переменная среды:
NOTIFICATION_PROFILE- Тип: булево значение
- По умолчанию:
False - Описание: включает профилирование через Sentry.
Скрытые переменные сервиса уведомлений
Следующие переменные используются сервисом уведомлений, но не отображаются в UI.
Их можно изменить только через .env-файлы.
Настройки подключения к PostgreSQL
POSTGRES_SCHEMA
- Переменная среды:
NOTIFICATION_POSTGRES_SCHEMA - Тип: строка
- По умолчанию:
notification - Описание: схема PostgreSQL, используемая сервисом уведомлений.
POSTGRES_POOL
- Переменная среды:
NOTIFICATION_POSTGRES_POOL - Тип: булево значение
- По умолчанию:
True - Описание: включает использование пула соединений PostgreSQL.
POSTGRES_POOL_SIZE
- Переменная среды:
NOTIFICATION_POSTGRES_POOL_CONNECT - Тип: целое число
- По умолчанию:
20 - Описание: размер пула соединений PostgreSQL.
POSTGRES_POOL_OVERFLOW
- Переменная среды:
NOTIFICATION_POSTGRES_POOL_OVERFLOW - Тип: целое число
- По умолчанию:
20 - Описание: количество дополнительных соединений сверх размера пула.
Общие параметры сервиса
PROJECT_NAME
- Переменная среды:
NOTIFICATION_PROJECT_NAME - Тип: строка
- По умолчанию:
NOTIFICATION - Описание: имя сервиса.
PROJECT_DESCRIPTION
- Переменная среды:
NOTIFICATION_PROJECT_DESCRIPTION - Тип: строка
- По умолчанию:
Сервис NOTIFICATION - Описание: описание сервиса.
USE_CONTAINER_IP_FOR_BIND
- Переменная среды:
NOTIFICATION_USE_CONTAINER_IP_FOR_BIND - Тип: булево значение
- По умолчанию:
True - Описание: использовать IP контейнера для bind-адреса сервиса.
BIND_HOST
- Переменная среды:
NOTIFICATION_BIND_HOST - Тип: строка
- По умолчанию: пустое значение
- Описание: адрес, на котором сервис принимает входящие подключения.
BIND_PORT
- Переменная среды:
NOTIFICATION_BIND_PORT - Тип: целое число
- По умолчанию:
8008 - Описание: порт входящих подключений сервиса.
ROOT_PATH
- Переменная среды:
NOTIFICATION_ROOT_PATH - Тип: строка
- По умолчанию:
/api/notification - Описание: корневой путь публикации API сервиса.
DOCS_PREFIX
- Переменная среды:
NOTIFICATION_DOCS_PREFIX - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации документации сервиса.
WORKERS
- Переменная среды:
NOTIFICATION_WORKERS - Тип: целое число
- По умолчанию:
1 - Описание: количество worker-процессов сервиса.
DEBUG
- Переменная среды:
NOTIFICATION_DEBUG - Тип: булево значение
- По умолчанию:
False - Описание: режим отладки.
SHOW_DEBUG_SETTING
- Переменная среды:
NOTIFICATION_SHOW_DEBUG_SETTING - Тип: булево значение
- По умолчанию:
False - Описание: управляет отображением debug-настроек.
RELOAD
- Переменная среды:
NOTIFICATION_RELOAD - Тип: булево значение
- По умолчанию:
False - Описание: включает автоматическую перезагрузку сервиса при изменении кода.
EVENT_HANDLING
- Переменная среды:
NOTIFICATION_EVENT_HANDLING - Тип: булево значение
- По умолчанию:
True - Описание: включает обработку событий внутри сервиса.
STATIC_PATH
- Переменная среды:
NOTIFICATION_STATIC_PATH - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации статических файлов.
STATIC_DIR
- Тип: строка
- По умолчанию:
static - Описание: директория статических файлов сервиса.
AMTOOL_PATH
- Переменная среды:
AMTOOL_PATH - Тип: строка
- По умолчанию:
/usr/bin/amtool - Описание: путь к утилите
amtool.
PUBLIC_API_URL
- Переменная среды:
PUBLIC_API_URL - Тип: строка
- По умолчанию: пустое значение
- Описание: публичный URL API сервиса уведомлений.
OUTBOX_CONTEXT_DETACH
- Переменная среды:
OUTBOX_CONTEXT_DETACH - Тип: булево значение
- По умолчанию:
True - Описание: управляет отделением контекста при обработке outbox-сообщений.
OUTBOX_BATCH_SIZE
- Переменная среды:
OUTBOX_BATCH_SIZE - Тип: целое число
- По умолчанию:
20 - Описание: размер пакета при обработке outbox-сообщений.
BACKGROUND_TYPE
- Переменная среды:
BACKGROUND_TYPE - Тип: перечисление
- По умолчанию:
MEMORY - Описание: тип механизма фоновой обработки.
IN_APP_SCHEDULER_ENABLED
- Переменная среды:
IN_APP_SCHEDULER_ENABLED - Тип: булево значение
- По умолчанию:
True - Описание: включает встроенный планировщик фоновых задач.
Внутренние адреса сервисов
MONITORING_HOST
- Переменная среды:
MONITORING_HOST - Тип: строка
- По умолчанию:
monitoring - Описание: внутренний адрес сервиса мониторинга.
MONITORING_PORT
- Переменная среды:
MONITORING_PORT - Тип: целое число
- По умолчанию:
8004 - Описание: внутренний порт сервиса мониторинга.
MONITORING_VERSION_PREFIX
- Переменная среды:
MONITORING_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API сервиса мониторинга.
SRM_HOST
- Переменная среды:
SRM_HOST - Тип: строка
- По умолчанию:
srm - Описание: внутренний адрес SRM-сервиса.
SRM_PORT
- Переменная среды:
SRM_PORT - Тип: целое число
- По умолчанию:
8002 - Описание: внутренний порт SRM-сервиса.
SRM_VERSION_PREFIX
- Переменная среды:
SRM_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API SRM-сервиса.
AUTH_HOST
- Переменная среды:
AUTH_HOST - Тип: строка
- По умолчанию:
auth - Описание: внутренний адрес auth-сервиса.
AUTH_PORT
- Переменная среды:
AUTH_PORT - Тип: целое число
- По умолчанию:
8001 - Описание: внутренний порт auth-сервиса.
AUTH_VERSION_PREFIX
- Переменная среды:
AUTH_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API auth-сервиса.
AUTH_ROOT_PATH
- Переменная среды:
AUTH_ROOT_PATH - Тип: строка
- По умолчанию:
/api/auth - Описание: корневой путь API auth-сервиса.
Параметры интеграции с Sentry
SENTRY_DSN
- Переменная среды:
NOTIFICATION_SENTRY_DSN - Тип: строка
- По умолчанию: пустое значение
- Описание: DSN для отправки событий сервиса уведомлений в Sentry.