Включение журналирования отладки в ONLYOFFICE Docs

Обзор

В некоторых случаях необходимо запустить ONLYOFFICE Docs в режиме отладки — например, чтобы устранить проблемы с производительностью, изучить журналы или собрать информацию для службы поддержки.

Запустить ONLYOFFICE Docs в режиме отладки можно двумя способами.

Способ 1. С помощью переменной окружения (только Docker)

Если вы управляете контейнером ONLYOFFICE Docs через Docker или Docker Compose, для включения уровня журналирования отладки предпочтительнее использовать переменную окружения:

Docker

1. Задайте переменную окружения в команде docker run:

   docker run -i -t -d -p 8080:80 \
     -e DS_LOG_LEVEL=DEBUG \
     onlyoffice/documentserver-de:latest

2. Перезапустите контейнер, если он уже запущен:

   docker restart <container>

3. Журналы можно просмотреть с помощью команды:

   docker logs -f <container>

Docker Compose

1. Задайте переменную окружения в файле docker-compose.yml при запуске контейнера:

   services:
       documentserver:
         image: onlyoffice/documentserver-de:latest
         container_name: documentserver
         restart: always
         environment:
           - DS_LOG_LEVEL=DEBUG
         ports:
           - "8080:80"

2. Запустите Docker Compose:

   docker-compose up -d

3. Перезапустите контейнер, если он уже запущен:

   docker-compose restart documentserver

4. Журналы можно просмотреть с помощью команды:

   docker-compose logs -f documentserver

Способ 2. С помощью файла конфигурации log4js

Чтобы запустить ONLYOFFICE Docs в режиме отладки:

1. Откройте файл конфигурации log4js. Путь к файлу зависит от используемой операционной системы:

   • Для Windows — C:\Program Files\ONLYOFFICE\DocumentServer\config\log4js\production.json
   • Для Linux — /etc/onlyoffice/documentserver/log4js/production.json
   • Для Docker — /etc/onlyoffice/documentserver/log4js/production.json (внутри контейнера Docker)

2. Найдите следующий блок кода

   {
     "categories": {
       "default": {
         "appenders": [
           "default"
         ],
         "level": "WARN"
       }
     }
   }

3. Измените значение level с "WARN" на "DEBUG".

4. Сохраните изменения в файле конфигурации production.json.

5. Примените изменения, выполнив следующую команду:

   Linux

   systemctl restart ds-*

   Docker

   supervisorctl restart all

   Или перезапустите службу ONLYOFFICE DocumentServer Proxy в Windows:

   net stop DsProxySvc
   net start DsProxySvc
   net stop DsConverterSvc
   net start DsConverterSvc
   net stop DsDocServiceSvc
   net start DsDocServiceSvc

6. Журналы хранятся в следующих расположениях (в зависимости от типа установки):

   • Для Windows — C:\Program Files\ONLYOFFICE\DocumentServer\Log
   • Для Linux — /var/log/onlyoffice/documentserver
   • Для Docker — /var/log/onlyoffice/documentserver (внутри контейнера Docker) и /app/onlyoffice/DocumentServer/logs/documentserver (на хосте, если вы подключаете том)