Aller au contenu principal

Activer la journalisation de débogage dans ONLYOFFICE Docs

Présentation​

Dans certains cas, il est nécessaire d'exécuter ONLYOFFICE Docs en mode débogage, par exemple pour résoudre des problèmes de performance, examiner les journaux ou collecter des informations pour le support.

Il existe deux options pour lancer ONLYOFFICE Docs en mode débogage.

Option 1. Utiliser la variable d'environnement (Docker uniquement)​

Si vous gérez le conteneur ONLYOFFICE Docs via Docker ou Docker Compose, il est préférable d'utiliser une variable d'environnement pour activer le niveau de journalisation de débogage :

Docker​

  1. Définissez la variable d'environnement avec docker run :

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

  2. Redémarrez le conteneur s'il est déjà en cours d'exécution :

    docker restart <container>

  3. Les journaux peuvent être consultés avec :

    docker logs -f <container>

Docker Compose​

  1. Définissez la variable d'environnement dans docker-compose.yml lors de l'exécution du conteneur :

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

  2. Démarrez Docker Compose :

    docker-compose up -d

  3. Redémarrez le conteneur s'il est déjà en cours d'exécution :

    docker-compose restart documentserver

  4. Les journaux peuvent être consultés avec :

    docker-compose logs -f documentserver

Option 2. Utiliser le fichier de configuration log4js​

Pour lancer ONLYOFFICE Docs en mode débogage :

  1. Ouvrez le fichier de configuration log4js. Le chemin d'accès au fichier dépend du système d'exploitation que vous utilisez :

    • Pour Windows - C:\Program Files\ONLYOFFICE\DocumentServer\config\log4js\production.json
    • Pour Linux - /etc/onlyoffice/documentserver/log4js/production.json
    • Pour Docker - /etc/onlyoffice/documentserver/log4js/production.json (à l'intérieur du conteneur Docker)

  2. Consultez le bloc de code suivant

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

  3. Modifiez la valeur level de "WARN" à "DEBUG".

  4. Enregistrez les modifications dans le fichier de configuration production.json.

  5. Appliquez les modifications en exécutant la commande suivante :

    Linux

    systemctl restart ds-*

    Docker

    supervisorctl restart all

    Ou redémarrez le service ONLYOFFICE DocumentServer Proxy sous Windows :

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

  6. Les journaux sont stockés aux emplacements suivants (selon le type d'installation) :

    • Pour Windows - C:\Program Files\ONLYOFFICE\DocumentServer\Log
    • Pour Linux - /var/log/onlyoffice/documentserver
    • Pour Docker - /var/log/onlyoffice/documentserver (à l'intérieur du conteneur Docker) et /app/onlyoffice/DocumentServer/logs/documentserver (sur l'hôte si vous montez le volume)