Como habilitar o registro de depuração no ONLYOFFICE Docs

Visão geral

Em certos casos, é necessário executar o ONLYOFFICE Docs no modo de depuração — por exemplo, para solucionar problemas de desempenho, inspecionar logs ou coletar informações para suporte.

Existem duas opções para iniciar o ONLYOFFICE Docs no modo de depuração.

Opção 1. Usando a variável de ambiente (apenas Docker)

Se você estiver gerenciando o contêiner do ONLYOFFICE Docs via Docker ou Docker Compose, é preferível usar uma variável de ambiente para habilitar o nível de log de depuração:

Docker

1. Defina a variável de ambiente com docker run:

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

2. Reinicie o contêiner se ele já estiver em execução:

   docker restart <container>

3. Os logs podem ser visualizados com:

   docker logs -f <container>

Docker Compose

1. Defina a variável de ambiente no docker-compose.yml ao executar o contêiner:

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

2. Inicie o Docker Compose:

   docker-compose up -d

3. Reinicie o contêiner se ele já estiver em execução:

   docker-compose restart documentserver

4. Os logs podem ser visualizados com:

   docker-compose logs -f documentserver

Opção 2. Usando o arquivo de configuração log4js

Para iniciar o ONLYOFFICE Docs no modo de depuração:

1. Abra o arquivo de configuração log4js. O caminho para o arquivo depende do sistema operacional que você usa:

   • Para Windows - C:\Program Files\ONLYOFFICE\DocumentServer\config\log4js\production.json
   • Para Linux - /etc/onlyoffice/documentserver/log4js/production.json
   • Para Docker - /etc/onlyoffice/documentserver/log4js/production.json (dentro do contêiner Docker)

2. Consulte o bloco de código a seguir

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

3. Altere o valor level de "WARN" para "DEBUG".

4. Salve as alterações no arquivo de configuração production.json.

5. Aplique as alterações executando o seguinte comando:

   Linux

   systemctl restart ds-*

   Docker

   supervisorctl restart all

   Ou reinicie o serviço ONLYOFFICE DocumentServer Proxy para Windows:

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

6. Os logs são armazenados nos seguintes locais (dependendo do tipo de instalação):

   • Para Windows - C:\Program Files\ONLYOFFICE\DocumentServer\Log
   • Para Linux - /var/log/onlyoffice/documentserver
   • Para Docker - /var/log/onlyoffice/documentserver (dentro do contêiner Docker) e /app/onlyoffice/DocumentServer/logs/documentserver (no host se você montar o volume)