Журналы и мониторинг
Журналирование, отправка ошибок в Sentry, метрики Prometheus, параметры страницы состояния системы и пороги уведомлений о сроках действия сертификатов и ключей.
Как изменить параметры и применить изменения, описано в разделе Параметры .env.
Журналирование
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
LOG_LEVEL |
Выбор из списка | info |
Нет | Минимальный уровень записей журнала: debug, info, warning, error или critical. Регистр не важен; неизвестное значение равносильно info.При установке на сервер значение задаёт конфигурация supervisor, и значение из .env не действует (см. Приоритет источников). |
SQL_LOGGING |
Логический | False |
Нет | Запись в журнал всех SQL-запросов. Только для диагностики: резко увеличивает объём журнала. |
FORCE_COLOR |
Логический | False |
Нет | Цветной текстовый вывод журнала вместо формата JSON. Только для разработки. |
REQUEST_LOG_REDIS_TTL_DAYS |
Целое число, дни | 1 |
Нет | Срок хранения журнала исходящих запросов к интеграциям: обработчику событий диалога, HTTP-серверу отправки почты, ИИ-сервисам и суфлёрам. Для каждой интеграции хранятся 10 последних запросов; журнал показывается в настройках интеграции. |
Sentry
Webim может отправлять сведения об ошибках и производительности в систему мониторинга Sentry. Отправка включается, если задан SENTRY_DSN.
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
SENTRY_DSN |
URL | Не задано | Нет | Адрес проекта Sentry (DSN), например https://<ключ>@sentry.example.local/2. Если параметр не задан, данные в Sentry не отправляются. |
SENTRY_ENABLED |
Логический | True |
Нет | Позволяет отключить отправку данных в Sentry, не удаляя SENTRY_DSN. |
SENTRY_ENV |
Строка | Не задано | Да, если задан SENTRY_DSN |
Имя окружения в Sentry, например production. Обязателен, если задан SENTRY_DSN и SENTRY_ENABLED=True: без него Webim не запускается. |
SENTRY_SAMPLE_RATE |
Дробное число | 0.01 |
Нет | Доля ошибок, которые отправляются в Sentry: от 0 до 1. Значение 0.01 соответствует 1 % ошибок. |
SENTRY_TRACES_SAMPLE_RATE |
Дробное число | 0.1 |
Нет | Доля запросов и задач, для которых в Sentry отправляются данные о производительности (трассировки): от 0 до 1. |
SENTRY_PROFILES_SAMPLE_RATE |
Дробное число | 0.1 |
Нет | Доля трассировок, для которых собирается профиль выполнения кода: от 0 до 1. |
SENTRY_MAX_BREADCRUMBS |
Целое число | 20 |
Нет | Максимальное число предшествующих ошибке событий (breadcrumbs), которые прикладываются к отчёту об ошибке. |
SENTRY_MIDDLEWARE_SPANS |
Логический | False |
Нет | Детализация трассировок по каждому промежуточному обработчику (middleware) Django. Увеличивает время обработки каждого запроса на 5–10 мс. |
SENTRY_SEND_DEFAULT_PII |
Логический | False |
Нет | Отправка в Sentry персональных данных: IP-адресов, cookie и сведений о пользователе. |
BACKEND_NAME |
Строка | unknown |
Нет | Имя сервера, которое передаётся в Sentry в заголовке запроса X-Backend. Помогает определить, на каком сервере произошла ошибка. |
Prometheus
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
PROMETHEUS_URL |
URL | Пусто | Нет | Адрес сервера Prometheus, например http://prometheus.example.local:9090. Из Prometheus берёт показатели прежняя версия панели приборов, а проверка работоспособности /health учитывает его доступность. Пустое значение — прежняя версия панели приборов показывает нулевые значения. |
PROMETHEUS_PUSH_GATEWAY |
URL | Пусто | Нет | Адрес Prometheus Pushgateway, например http://pushgateway.example.local:9091. В него Webim отправляет показатели для прежней версии панели приборов, а обработчики очередей — статистику выполнения задач. Пустое значение — метрики не отправляются. |
PROMETHEUS_SAMPLE_RATE |
Дробное число | 0.1 |
Нет | Доля HTTP-запросов, для которых собираются метрики Prometheus: от 0 (сбор выключен) до 1 (все запросы). |
PROMETHEUS_MULTIPROC_DIR |
Путь к каталогу | /tmp/ |
Нет | Каталог для файлов метрик Prometheus при работе в нескольких процессах. Переменная окружения процесса важнее значения из .env: при установке на сервер каталог задаёт конфигурация supervisor, в Kubernetes — манифест контейнера. |
PROMETHEUS_HTTP_TIMEOUT_SECONDS |
Дробное число, секунды | 10.0 |
Нет | Тайм-аут запросов к PROMETHEUS_URL. |
INSTANCE_ID |
Строка | 1 |
Нет | Значение метки instance_id в метриках. Если несколько установок отправляют метрики в один Pushgateway, задайте каждой своё значение. |
Состояние системы
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
SYSTEM_STATUS_SNAPSHOT_CACHE_TTL_SECONDS |
Целое число, секунды | 30 |
Нет | Срок хранения в кэше результатов проверок для страницы состояния системы. |
SYSTEM_STATUS_REDIS_PROBE_TTL_SECONDS |
Целое число, секунды | 5 |
Нет | Срок жизни служебной записи, которую страница состояния системы создаёт в Redis для проверки его доступности. |
SYSTEM_STATUS_ES_TIMEOUT_SECONDS |
Целое число, секунды | 5 |
Нет | Тайм-аут проверки Elasticsearch или OpenSearch на странице состояния системы. |
CHANNEL_HEALTH_CACHE_TTL_HOURS |
Целое число, часы | 26 |
Нет | Срок хранения показателей работы каналов: опроса, входящих и исходящих сообщений, фоновой проверки. |
CHANNEL_PENDING_ALERT_TTL_HOURS |
Целое число, часы | 1 |
Нет | Срок хранения предупреждения о накоплении необработанных обновлений в каналах Telegram (см. настройку Constance TELEGRAM_PENDING_UPDATES_ALERT_THRESHOLD в разделе Каналы). |
Уведомления о сроках действия
Пороги уведомлений, которые Webim показывает в интерфейсе перед истечением сроков действия сертификатов и ключей. После истечения срока предупреждение сменяется критическим уведомлением.
| Параметр | Тип | По умолчанию | Обязательный | Описание |
|---|---|---|---|---|
NOTIF_CERT_WARNING_THRESHOLD_DAYS |
Целое число, дни | 7 |
Нет | За сколько дней до истечения срока действия сертификата пуш-уведомлений iOS появляется предупреждение. |
NOTIF_PRIVATE_KEY_WARNING_THRESHOLD_DAYS |
Целое число, дни | 7 |
Нет | За сколько дней до истечения срока действия закрытого ключа появляется предупреждение. Действует для ключа подписи запросов к обработчику событий диалога и ключей идентификации посетителей. |
NOTIF_VISITOR_HASH_RECENT_THRESHOLD_DAYS |
Целое число, дни | 1 |
Нет | Уведомления об истечении срока действия ключей идентификации посетителей показываются только для ключей, которые использовались в течение этого периода. |