メインコンテンツまでスキップ

ONLYOFFICE Docsでのデバッグログの有効化

概要​

特定のケースでは、ONLYOFFICE Docsをデバッグモードで実行する必要があります。例えば、パフォーマンスの問題をトラブルシューティングしたり、ログを確認したり、サポート用の情報を収集する場合です。

ONLYOFFICE Docsをデバッグモードで起動する方法は2つあります。

オプション1. 環境変数を使用する（Dockerのみ）​

DockerまたはDocker Composeを使用してONLYOFFICE Docsコンテナを管理している場合、環境変数を使用してデバッグログレベルを有効にするのが望ましいです：

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

    またはWindowsの場合、ONLYOFFICE DocumentServer Proxyサービスを再起動します：

    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（ボリュームをマウントした場合のホスト上）