1 Уровни логирования
2 Описание основных аппендеров для включения логирования при анализе проблем
3 Настройка через веб-интерфейс WildFly
- 3.1 JBoss
4 Настройка логирования через конфигурационный файл standalone.xml
- 4.1 Все события из лог-файлов в server.log
  - 4.1.1 Описание настройки паттернов custom-handler
5 Асинхронное логирование
6 Логирование REST и SOAP-запросов

Уровни логирования

Основные уровни логирования для анализа:

ERROR - в программе произошла ошибка
WARN - предупреждение перед критической ошибкой
INFO - общая информация о выполнении программы
DEBUG - детальная информация для отладки
TRACE - наиболее полная информация.

Установка категории определенного уровня означает следующее – сообщения, выводимые с этим или более высоким уровнем, попадут в лог-файл.

Сообщения, выводимые с уровнем ниже установленного в лог-файл не попадут.

Описание основных аппендеров для включения логирования при анализе проблем

Наименование аппендера

Наименование аппендера
Общее логирование	SERVER-FILE
Вывод ошибок	SERVER-ERROR-FILE
Карты	SET-CARDS-FILE
Настройки для кассы	SET-RETAILX-CASH-FILE
Настройки сервера Ооборудование ХАСП-ключи	SET-RETAILX-FILE
Рекламные акции и лояльность	SET-DISCOUNTS-FILE
Экспорт данных в ERP	ERP-EXPORT (только в конфигурационном файле standalone.xml)
Импорт данных из ERP	SET-RETAILX-ERPI-FILE
Экспорт данных операционного дня в ERP	SET-OPERDAY-FILE
Гифтоман	GIFTOMAN-FILE
Печать ценников и документов	SET-RETAILX-PRINTING-FILE
Отчеты	SET-REPORT-FILE
Весы	SET-RETAILX-SCALES-FILE
Реестр модулей	SET-RETAILX-REGISTER-FILE
Плагинные свойства сервера	SET-RETAILX-PLUGINS-FILE
Транспорт товаров	SET-RETAILX-PRODUCTS-FILE
ESL Hanshow	SET-RETAILX-ESL-FILE
События в рекламных акциях	SET-EVENT-ACTIONS-FILE
Пользователи	SET-RETAILX-USERS-FILE
Топология	SET-RETAILX-TOPOLOGY-FILE
Транспорт	TRANSPORT-FILE

Настройка через веб-интерфейс WildFly

1. Откройте веб-браузер и наберите следующий адрес http://IP-адрес SetRetail:9990

2. Введите логин и пароль:

Логин: tc
Пароль: <уточните в службе поддержки CSI>

3. Перейдите в Configuration → Subsystems → Logging → Configuration → View.

4. Настройки root-логера находятся в разделе Root Logger.

Статус всегда должен быть INFO.

5. Для настройки логгеров кликните Categories → выберите логгер → кликните Edit.

6. Выберите уровень логгирования → кликните Save.

7. Например в лог-файле set-cards.log будут отображаться события в соответствии с выбранным уровнем логирования.

JBoss

1. Откройте веб-браузер и наберите следующий адрес http://IP-адрес SetRetail:9990

2. Введите логин и пароль:

Логин: tc
Пароль: <уточните в службе поддержки CSI>

3. Кликните Profile.

4. Кликните Core → Logging

5. Перейдите на вкладку Log Categories

6. В зависимости от того, какой аппендер требуется расширить, выберите его → Кликните Edit.

7. Выберите необходимый уровень логирования и нажмите Save.

8. В лог-файле set-cards.log будут отображаться события в соответствии с выбранным уровнем логирования.

Настройка логирования через конфигурационный файл standalone.xml

1. Основные лог-файлы работы сервера находятся в \SetRetail10\standalone\log

2. Файл с настройками уровня логирования находится в \SetRetail10\standalone\configuration\standalone.xml

3. Установите уровень логирования в той категории, в зависимости от функциональности, которую требуется проанализировать (см. выше "Описание основных аппендеров для включения логирования при анализе проблем")

Для корректной работы необходимо расширить аппендер в двух местах.

ВАЖНО!

В конфигурационном файле standalone.xml необходимо учитывать регистр для логгеров НЕЛЬЗЯ ИСПОЛЬЗОВАТЬ - error, допустимо только ERROR

Например, для того, чтобы расширить аппендер по транспорту, необходимо это сделать в следующих секциях:

<custom-handler name="TRANSPORT-FILE" class="ru.crystals.logging.CrystalSizeRotationHandler" module="ru.crystals">
                <level name="TRACE"/>
                <encoding value="UTF-8"/>
                <formatter>
                    <pattern-formatter pattern="%d{dd.MM HH:mm:ss} %-5p [%c] %m %n"/>
                </formatter>
                <properties>
                    <property name="maxBackupNumber" value="9"/>
                    <property name="rotateFileSize" value="50m"/>
                    <property name="fileName" value="transport.log"/>
                </properties>

           <logger category="ru.crystals.transport.file">
                <level name="TRACE"/>
                <handlers>
                    <handler name="TRANSPORT-FILE"/>
                </handlers>
            </logger>

4. Сохраните изменения в файле

5. Перезапустите службу сервера SETv10 Application server (JBOSS_SVC)

6. Все события будут записываться в файл transport.log

Все события из лог-файлов в server.log

Установите в секции <custom-handler name="SERVER-ERROR-FILE" уровень логирования TRACE и перезапустите службу сервера SETv10 Application server (JBOSS_SVC).

           <custom-handler name="SERVER-FILE" class="ru.crystals.logging.CrystalSizeRotationHandler" module="ru.crystals">
                <level name="TRACE"/>
                <encoding value="UTF-8"/>
                <formatter>
                    <pattern-formatter pattern="%d{dd.MM HH:mm:ss} %-5p [%c] %m %n"/>
                </formatter>
                <properties>
                    <property name="maxBackupNumber" value="9"/>
                    <property name="rotateFileSize" value="50m"/>
                    <property name="fileName" value="server.log"/>
                </properties>
            </custom-handler>

Описание настройки паттернов custom-handler

Настройка	Описание

Настройка	Описание
`<level name="INFO"/>`	Приоритет сообщений для этого аппендера
`<param name="Encoding" value="UTF-8"/>`	Формат кодировки отображения сообщений
`<pattern-formatter pattern="%d{dd.MM HH:mm:ss} %-5p [%c] %m %n"/>`	Формат отображения даты и времени сообщения в лог-файле
`<property name="maxBackupNumber" value="9"/>`	Глубина ротации лог-файлов
`<property name="rotateFileSize" value="50m"/>`	Размер каждого ротируемого лог-файла
`<property name="fileName" value="server.log"/>`	Наименование файла логирования

Асинхронное логирование

https://crystals.atlassian.net/browse/SRTS-828

https://crystals.atlassian.net/browse/CR-8055

10.3.15.0

Начиная с версии SetRetail 10.3.15.0 на сервере включено асинхронное логирование, для ускорения работы.

Конфигурация логгеров в файле standalone.xml:

До версии 10.3.15.0
- logger → handler (file)
С версии 10.3.15.0
- logger → async-handler → handler (file)

<async-handler name="TRANSPORT-FILE-ASYNC">
    <level name="TRACE"/>
    <queue-length value="1024"/>
    <overflow-action value="discard"/>
    <subhandlers>
        <handler name="TRANSPORT-FILE"/>
    </subhandlers>
</async-handler>

<logger category="ru.crystals.transport.file">
    <level name="ERROR"/>
    <handlers>
        <handler name="TRANSPORT-FILE-ASYNC"/>
    </handlers>
</logger>

Логирование REST и SOAP-запросов

Смотрите в статье Логирование REST и SOAP запросов в WildFly.

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