Cервис СРМ
Сервис SRM использует набор конфигурационных переменных, которые определяют его поведение, параметры обработки TQL, хранения истории атрибутов, подключения к внешним сервисам и параметры отладки.
Порядок применения значений
Значение каждой переменной определяется в следующем порядке приоритета:
- значение, сохранённое через UI — для переменных, доступных к изменению в интерфейсе;
- переменная окружения или значение из
.env; - значение по умолчанию, заданное в коде сервиса.
Таким образом:
- если параметр был изменён в UI, используется именно это значение;
- если параметр не задан в UI, используется значение из переменных среды;
- если и оно отсутствует, применяется значение по умолчанию.
- Переменные, достпные в UI
- Скрытые переменные
Переменные раздела API
LOG_LEVEL
- Переменная среды:
SRM_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования.
ACCESS_LOG_LEVEL
- Переменная среды:
SRM_ACCESS_LOG_LEVEL- Тип: строка
- По умолчанию:
INFO - Описание: уровень логирования доступа к API.
CI_NAME_IF_NOT_SET
- Переменная среды:
CI_NAME_IF_NOT_SET- Тип: строка
- По умолчанию:
имя не назначено - Описание: имя, возвращаемое для КЕ при отсутствии значения в БД.
NOTIFICATION_EXPIRATION
- Переменная среды:
SRM_NOTIFICATION_EXPIRATION- Тип: целое число
- По умолчанию:
10 - Описание: время хранения истории уведомлений в сутках.
TQL_CHECK_QUANTIFIER
- Переменная среды:
SRM_TQL_CHECK_QUANTIFIER- Тип: булево значение
- По умолчанию:
False - Описание: выполнять проверку соответствия квантификаторов для TQL V3.
TQL_DEFAULT_VERSION
- Переменная среды:
SRM_TQL_DEFAULT_VERSION- Тип: целое число
- По умолчанию:
3 - Описание: глобальная версия обработчика TQL.
TQL_FULL_EXCEPT
- Переменная среды:
SRM_TQL_FULL_EXCEPT- Тип: булево значение
- По умолчанию:
False - Описание: вычитать КЕ при обработке квантификатора
0..0.
Переменные раздела Attribute History
ATTRIBUTE_HISTORY_LIMIT
- Переменная среды:
SRM_ATTRIBUTE_HISTORY_LIMIT- Тип: булево значение
- По умолчанию:
False - Описание: включить лимит для истории изменения атрибутов.
ATTRIBUTE_HISTORY_EXPIRATION
- Переменная среды:
SRM_ATTRIBUTE_HISTORY_EXPIRATION- Тип: целое число
- По умолчанию:
10 - Описание: время хранения истории изменения атрибутов.
ATTRIBUTE_HISTORY_DEPTH
- Переменная среды:
SRM_ATTRIBUTE_HISTORY_DEPTH- Тип: целое число
- По умолчанию:
10 - Описание: глубина хранения истории изменения атрибутов.
Переменные раздела Sentry
PROFILE
- Переменная среды:
SRM_PROFILE- Тип: булево значение
- По умолчанию:
False - Описание: включает профилирование через Sentry.
Скрытые переменные сервиса SRM
Следующие переменные используются сервисом SRM, но не отображаются в UI.
Их можно изменить только через .env-файлы.
Настройки подключения к PostgreSQL
POSTGRES_SCHEMA
- Переменная среды:
SRM_POSTGRES_SCHEMA - Тип: строка
- По умолчанию:
public - Описание: схема PostgreSQL, используемая сервисом SRM.
POSTGRES_POOL
- Переменная среды:
SRM_POSTGRES_POOL - Тип: булево значение
- По умолчанию:
True - Описание: включает использование пула соединений PostgreSQL.
POSTGRES_POOL_SIZE
- Переменная среды:
SRM_POSTGRES_POOL_CONNECT - Тип: целое число
- По умолчанию:
20 - Описание: размер пула соединений PostgreSQL.
POSTGRES_POOL_OVERFLOW
- Переменная среды:
SRM_POSTGRES_POOL_OVERFLOW - Тип: целое число
- По умолчанию:
20 - Описание: количество дополнительных соединений сверх размера пула.
Общие параметры сервиса
PROJECT_NAME
- Переменная среды:
SRM_PROJECT_NAME - Тип: строка
- По умолчанию:
SRM - Описание: имя сервиса.
PROJECT_DESCRIPTION
- Переменная среды:
SRM_PROJECT_DESCRIPTION - Тип: строка
- По умолчанию:
Сервис SRM - Описание: описание сервиса.
USE_CONTAINER_IP_FOR_BIND
- Переменная среды:
SRM_USE_CONTAINER_IP_FOR_BIND - Тип: булево значение
- По умолчанию:
True - Описание: использовать IP контейнера для bind-адреса сервиса.
BIND_HOST
- Переменная среды:
SRM_BIND_HOST - Тип: строка
- По умолчанию: пустое значение
- Описание: адрес, на котором сервис принимает входящие подключения.
BIND_PORT
- Переменная среды:
SRM_BIND_PORT - Тип: целое число
- По умолчанию:
8002 - Описание: порт входящих подключений сервиса.
ROOT_PATH
- Переменная среды:
SRM_ROOT_PATH - Тип: строка
- По умолчанию:
/api/srm - Описание: корневой путь публикации API сервиса.
DOCS_PREFIX
- Переменная среды:
SRM_DOCS_PREFIX - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации документации сервиса.
WORKERS
- Переменная среды:
SRM_WORKERS - Тип: целое число
- По умолчанию:
1 - Описание: количество worker-процессов сервиса.
SHOW_DEBUG_SETTING
- Переменная среды:
SRM_SHOW_DEBUG_SETTING - Тип: булево значение
- По умолчанию:
False - Описание: управляет отображением debug-настроек.
RELOAD
- Переменная среды:
SRM_RELOAD - Тип: булево значение
- По умолчанию:
False - Описание: включает автоматическую перезагрузку сервиса при изменении кода.
EVENT_HANDLING
- Переменная среды:
SRM_EVENT_HANDLING - Тип: булево значение
- По умолчанию:
True - Описание: включает обработку событий внутри сервиса.
STATIC_PATH
- Переменная среды:
SRM_STATIC_PATH - Тип: строка
- По умолчанию:
/docs - Описание: путь публикации статических файлов.
STATIC_DIR
- Тип: строка
- По умолчанию:
static - Описание: директория статических файлов сервиса.
CI_DELETE_TIMEOUT
- Переменная среды:
CI_DELETE_TIMEOUT - Тип: целое число
- По умолчанию:
60 - Описание: таймаут в минутах перед физическим удалением CI.
CELERY_RUN_LOCAL
- Переменная среды:
CELERY_RUN_LOCAL - Тип: булево значение
- По умолчанию:
False - Описание: запуск Celery локально.
TQL_LIFE_TIME
- Тип: целое число
- По умолчанию:
86400 - Описание: время отслеживания изменений запрошенного TQL.
WIDGET_LIFE_TIME
- Тип: целое число
- По умолчанию:
86400 - Описание: время хранения данных виджета в кеше.
RABBITMQ_PROBE_EXCHANGE
- Переменная среды:
RABBITMQ_PROBE_EXCHANGE - Тип: строка
- По умолчанию:
probe_exchange - Описание: имя exchange для probe-сообщений RabbitMQ.
PLUGINS_PATH
- Переменная среды:
PLUGINS_PATH - Тип: строка
- По умолчанию:
plugins/uploads - Описание: путь к загруженным плагинам.
PLUGINS_INSTALL_PATH
- Переменная среды:
PLUGINS_INSTALL_PATH - Тип: строка
- По умолчанию:
plugins - Описание: путь установки плагинов.
VERIFY_IMPORTS
- Переменная среды:
VERIFY_IMPORTS - Тип: булево значение
- По умолчанию:
False - Описание: выполнять проверку импортов.
CELL_TOWERS_DATA_PATH
- Переменная среды:
CELL_TOWERS_DATA_PATH - Тип: строка
- По умолчанию:
app/init/250_cell_towers.csv - Описание: путь к файлу с данными базовых станций.
OUTBOX_CONTEXT_DETACH
- Переменная среды:
OUTBOX_CONTEXT_DETACH - Тип: булево значение
- По умолчанию:
True - Описание: управляет отделением контекста при обработке outbox-сообщений.
Внутренние адреса сервисов
AUTH_HOST
- Переменная среды:
AUTH_HOST - Тип: строка
- По умолчанию:
auth - Описание: внутренний адрес auth-сервиса.
AUTH_PORT
- Переменная среды:
AUTH_PORT - Тип: целое число
- По умолчанию:
8001 - Описание: внутренний порт auth-сервиса.
AUTH_VERSION_PREFIX
- Переменная среды:
AUTH_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API auth-сервиса.
MONITORING_HOST
- Переменная среды:
MONITORING_HOST - Тип: строка
- По умолчанию:
monitoring - Описание: внутренний адрес сервиса мониторинга.
MONITORING_PORT
- Переменная среды:
MONITORING_PORT - Тип: целое число
- По умолчанию:
8004 - Описание: внутренний порт сервиса мониторинга.
MONITORING_VERSION_PREFIX
- Переменная среды:
MONITORING_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API сервиса мониторинга.
NOTIFICATION_HOST
- Переменная среды:
NOTIFICATION_HOST - Тип: строка
- По умолчанию:
notification - Описание: внутренний адрес сервиса уведомлений.
NOTIFICATION_PORT
- Переменная среды:
NOTIFICATION_PORT - Тип: целое число
- По умолчанию:
8008 - Описание: внутренний порт сервиса уведомлений.
NOTIFICATION_VERSION_PREFIX
- Переменная среды:
NOTIFICATION_VERSION_PREFIX - Тип: строка
- По умолчанию:
/v3 - Описание: версионный префикс API сервиса уведомлений.
Параметры интеграции с Sentry
SENTRY_DSN
- Переменная среды:
SRM_SENTRY_DSN - Тип: строка
- По умолчанию: пустое значение
- Описание: DSN для отправки событий сервиса SRM в Sentry.