Перейти к содержанию

Настройка логирования

Для корректной работы аудита и логирования событий в системе TeamStorm необходимо настроить параметры логирования. Это можно сделать через файл .env (для Docker-установки) или через значения Helm-чарта (для Kubernetes).

Доступные способы логирования

В TeamStorm доступны следующие способы логирования:

  1. Логирование в стандартный вывод
    Логи аудита выводятся непосредственно в стандартный вывод контейнера сервиса cwm_public_gateway_api.

  2. Логирование в файл
    Логи аудита сохраняются в файл внутри контейнера сервиса cwm_public_gateway_api по пути /app/Logs/<имя сервиса>.log

  3. Логирование на внешний syslog-сервер
    Логи отправляются на внешний сервер по протоколу Syslog (UDP/TCP) для централизованного хранения и анализа событий (например, с помощью rsyslog, Graylog, ELK и др.).

Настройка логирования через .env

Для настройки откройте файл .env в корне установки TeamStorm. В файле .env присутствует блок настроек логирования. Для применения настроек после изменения параметров необходимо перезапустить сервисы TeamStorm.

Настройка способов логирования

В файле .env доступны следующие параметры для управления логированием:

  • LOGGING_CONSOLE_ENABLE — включает/отключает логирование в стандартный вывод (true/false)
  • LOGGING_FILE_ENABLE — включает/отключает логирование в файл (true/false)
  • LOGGING_SYSLOG_ENABLE — включает/отключает отправку логов на syslog-сервер (true/false)

Включение логирования в стандартный вывод

Для включения логирования в стандартный вывод установите значение true в LOGGING_CONSOLE_ENABLE 

    LOGGING_CONSOLE_ENABLE="true"

Включение логирования в файл

Для включения логирования в файл установите значение true в LOGGING_FILE_ENABLE 

    LOGGING_FILE_ENABLE="true"

Включение логирования на внешний syslog-сервер

По умолчанию параметры для отправки логов в syslog-сервер закомментированы. Для активации логирования на внешний syslog-сервер выполните следующие шаги:

  1. Установите значение true в LOGGING_SYSLOG_ENABLE

  2. Найдите секцию [ Audit Logging ]:

    ## [ Section ] ="[ Audit Logging ]"
# LOGGING_SYSLOG_CONNECTION_TYPE="UdpSyslog"
# LOGGING_SYSLOG_HOST="my-rsyslog-server.company.ru"
# LOGGING_SYSLOG_PORT="514"
# LOGGING_SYSLOG_FORMAT="RFC5424"
# LOGGING_SYSLOG_FACILITY="LogAudit"
LOGGING_SYSLOG_ENABLE="true"

  3. Раскомментируйте строки, связанные с syslog, и укажите параметры вашего syslog-сервера:

    ## [ Section ] ="[ Audit Logging ]"
LOGGING_SYSLOG_CONNECTION_TYPE="UdpSyslog"
LOGGING_SYSLOG_HOST="syslog.example.com"         # Укажите адрес вашего syslog-сервера
LOGGING_SYSLOG_PORT="514"                        # Укажите порт, обычно 514
LOGGING_SYSLOG_FORMAT="RFC5424"                  # Формат сообщений (обычно RFC5424)
LOGGING_SYSLOG_FACILITY="LogAudit"               # Facility для логов аудита
LOGGING_SYSLOG_ENABLE="true"                     # Включить отправку логов в syslog

2. Настройка логирования в Helm-чарте (Kubernetes)

Если вы используете TeamStorm в Kubernetes через Helm, параметры логирования настраиваются в файле values.yaml при установке/обновлении.

Пример блока настроек:

  logging:
    syslog_connection_type: "UdpSyslog"
    syslog_host: "my-rsyslog-server.company.ru"
    syslog_port: "514"
    syslog_format: "RFC5424"
    syslog_facility: "LogAudit"
    syslog_enable: "false"
    file_enable: "false"
    console_enable: "true"