Конфигурация и Логи

Управление конфигурацией

Конфигурация и параметры системы (backend.properties) может обновляться и храниться разными способами. Система имеет два основных вида установки:

  • через Docker.

  • установка вручную (war-файлы). При установке системы вручную необходимо поменять права доступа на файл backend.properties.

При установке системы файл backend.properties не меняется напрямую. При установке системы через Docker используются два файла:

  • docker-compose.yaml - файл, который описывает настройки контейнера докера помимо параметров backend.properties.

  • файл .env содержит параметры, которые могут передаваться либо в backend.properties, либо в файл docker-compose.yaml, из которого будет собираться контейнер.

В версии без докера используется скрипт ./bin/setenv.sh, который отправляет значения параметров.

Оптимальным путем может стать хранение параметров в .env, так как файл docker-compose.yaml может редактироваться по причинам, не связанным с обновлением конфигурации. Это необходимо для поддержания совместимости при обновлении, чтобы настройки не удалялись, а новые параметры попадали в backend.properties.

Конфигурация в Docker

Относительный путь к конфигурациям в Docker: /usr/share/tomcat/conf/universe.

Каталог содержит:

  • backend.properties - Системные параметры (раздел "Параметры системы").

  • templates - Каталог шаблонов электронной почты.

  • enterprise-pipelines.json - Потоки выполнения.

  • logback.xml - Параметры логирования.

Конфигурация Backend

Система использует единственный конфигурационный файл backend.properties (имя предопределено). Содержимое файла смотрите в сборке системы, а также в интерфейсе пользователя (раздел "Параметры системы"). Описание некоторых параметров доступно в статье.

Если система устанавливается вручную, расположение файла может быть указано через флаги JVM: -Duniverse.conf="<path>/universe-conf".

Конфигурация Frontend

Используйте файл customer.json для настройки параметров пользовательского интерфейса. Он отображается как путь: /usr/share/nginx/html/customer.json при запуске приложения в Docker. Изменение файла в контейнере может привести к потере конфигурации после следующего запуска.

Для сохранения изменений:

  • Если вы запускаете приложение из репозитория, то поместите файл с изменениями (с другим именем, например: "my_customer.json") в каталог json_configs, а затем перезапустите приложение с помощью docker-compose:

    docker-compose -f docker-compose.yml -f docker-compose-json-generate.yml up -d
    
  • Если вы локально создаете пользовательский интерфейс, то необходимо просто изменить файл customer.json перед сборкой кода или образа docker (в этом случае измените файл customer.json в папке "Build").

Логи

Продукты Юниверс используют slf4j и logback classic для ведения общих логов системы.

Параметры логирования настраиваются в файле logback.xml.

Описание логгеров:

  • <logger name="org.apache.cxf" level="INFO"/> - вывод логов типа INFO + WARNING + ERROR для пакета CXF.

  • <logger name="org.universe" level="INFO"/> - вывод логов от модулей CE (модулей ядра системы).

  • <logger name="com.universe" level="INFO"/> и <logger name="com.universe" level="INFO"/> - вывод логов от модулей EE / SE.