第11章 JBoss EAP を用いたロギング
JBoss EAP は、EAP での内部使用とデプロイされたアプリケーションによる使用の両方で設定可能なロギング機能を提供します。logging
サブシステムは JBoss LogManager を基盤とし、JBoss Logging だけでなくサードパーティーアプリケーションのロギングフレームワークを複数サポートします。
11.1. サーバーロギング
11.1.1. サーバーロギング
デフォルトでは、すべての JBoss EAP ログエントリーは server.log
ファイルに書き込みされます。このファイルの場所は操作するモードによって異なります。
-
スタンドアロンサーバーの場合:
EAP_HOME/standalone/log/server.log
-
管理対象ドメインの場合:
EAP_HOME/domain/servers/SERVER_NAME/log/server.log
このファイルはサーバーログとも呼ばれます。詳細は ルートロガー を参照してください。
11.1.2. 起動時のロギング
起動中に JBoss EAP は Java 環境と各サービスの起動に関する情報をログに記録します。このログは、トラブルシューティングに役に立ちます。デフォルトでは、すべてのログエントリーが サーバーログ に書き込まれます。
起動時のロギング設定は logging.properties
設定ファイルに指定されます。これは、JBoss EAP logging
が開始され、継承するまでアクティブになります。このファイルの場所は操作するモードによって異なります。
-
スタンドアロンサーバーの場合:
EAP_HOME/standalone/configuration/logging.properties
管理対象ドメインの場合:
ドメインコントローラーおよびサーバーごとに 1 つの
logging.properties
ファイルがあります。-
ドメインコントローラー:
EAP_HOME/domain/configuration/logging.properties
-
サーバー:
EAP_HOME/domain/servers/SERVER_NAME/data/logging.properties
-
ドメインコントローラー:
logging.properties
ファイルは、直接編集する必要があるユースケース以外では直接編集しないことが推奨されます。直接編集する前に、Red Hat カスタマーポータル でサポートケースを作成することが推奨されます。
logging.properties
ファイルに手動で行った変更は起動時に上書きされます。
11.1.2.1. 起動エラーの表示
JBoss EAP をトラブルシューティングする場合、最初に行うべきことの 1 つは、起動時に発生したエラーをチェックすることです。提供された情報を使用して原因を診断し、解決します。起動時のエラーをトラブルシューティングする際にサポートが必要な場合はサポートケースを作成してください。
起動時のエラーを表示する方法は 2 つあり、どちらも利点があります。1 つは server.log
ファイルを確認する方法で、もう 1 つは read-boot-errors
管理 CLI コマンドを使用してブートエラーを確認する方法になります。
サーバーログファイルの確認
server.log
ファイルを開いて起動中に発生したエラーを確認します。
この方法では、各エラーメッセージおよび関連するメッセージを確認でき、エラーが発生した理由の詳細を知ることができます。また、エラーメッセージをプレーンテキスト形式で表示することもできます。
-
ファイルビューアーで
server.log
を開きます。 - ファイルの最後に移動します。
-
最後の起動シーケンスの開始を示す
WFLYSRV0049
メッセージ ID を後方検索します。 -
ログのその位置から
ERROR
を前方検索します。各検索一致箇所には、エラーの説明が示され、関連するモジュールがリストされます。
以下は、server.log
ログファイルのエラー説明の例です。
2016-03-16 14:32:01,627 ERROR [org.jboss.msc.service.fail] (MSC service thread 1-7) MSC000001: Failed to start service jboss.undertow.listener.default: org.jboss.msc.service.StartException in service jboss.undertow.listener.default: Could not start http listener at org.wildfly.extension.undertow.ListenerService.start(ListenerService.java:142) at org.jboss.msc.service.ServiceControllerImpl$StartTask.startService(ServiceControllerImpl.java:1948) at org.jboss.msc.service.ServiceControllerImpl$StartTask.run(ServiceControllerImpl.java:1881) at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1142) at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:617) at java.lang.Thread.run(Thread.java:745) Caused by: java.net.BindException: Address already in use ...
管理 CLI からのブートエラーの読み取り
サーバーが起動しても起動中にエラーが報告された場合、read-boot-errors
管理 CLI コマンドを使用してエラーを確認できます。
この方法では、サーバーのファイルシステムにアクセスする必要がありません。したがって、エラーを監視する担当者がファイルシステムアクセスを持ってない場合に役に立ちます。これは CLI コマンドであるため、スクリプトで使用できます。 たとえば、複数の JBoss EAP インスタンスを起動し、起動時に発生したエラーをチェックするスクリプトを記述できます。
次の管理 CLI コマンドを実行します。
/core-service=management:read-boot-errors
起動中に発生したすべてのエラーがリストされます。
{ "outcome" => "success", "result" => [ { "failed-operation" => { "operation" => "add", "address" => [ ("subsystem" => "undertow"), ("server" => "default-server"), ("http-listener" => "default") ] }, "failure-description" => "{\"WFLYCTL0080: Failed services\" => {\"jboss.undertow.listener.default\" => \"org.jboss.msc.service.StartException in service jboss.undertow.listener.default: Could not start http listener Caused by: java.net.BindException: Address already in use\"}}", "failed-services" => {"jboss.undertow.listener.default" => "org.jboss.msc.service.StartException in service jboss.undertow.listener.default: Could not start http listener Caused by: java.net.BindException: Address already in use"} } ... ] }
11.1.3. ガベッジコレクションのロギング
ガベッジコレクションロギングは、すべてのガベッジコレクションのアクティビティーをプレーンテキストのログファイルに記録します。これらのログファイルは診断を行うのに便利です。ガベッジコレクションロギングは、IBM の Java Development Kit を除くすべてのサポート対象設定の JBoss EAP スタンドアロンサーバーではデフォルトで有効になっています。
ガベッジコレクションログの場所は EAP_HOME/standalone/log/gc.log.DIGIT.current
です。ガベッジコレクションのログは 3 MB ずつに制限され、最大 5 つのファイルがローテーションされます。
トラブルシューティングに便利で、オーバーヘッドは最低限であるため、ガベッジコレクションのロギングを有効にすることが強く推奨されます。しかし、スタンドアロンサーバーのガベッジコレクションのロギングを無効にする場合は、サーバーを起動する前に GC_LOG
変数を false
に設定します。以下に例を示します。
$ export GC_LOG=false
$ EAP_HOME/bin/standalone.sh
11.1.4. デフォルトのログファイルの場所
以下のログファイルは、デフォルトのロギング設定に対して作成されます。デフォルトの設定では、periodic ログハンドラーを使用してサーバーログファイルが書き込まれます。
ログファイル | 説明 |
---|---|
EAP_HOME/standalone/log/server.log | サーバー起動メッセージを含むサーバーログメッセージが含まれます。 |
EAP_HOME/standalone/log/gc.log.DIGIT.current | ガベッジコレクションの詳細が含まれます。 |
ログファイル | 説明 |
---|---|
EAP_HOME/domain/log/host-controller.log | ホストコントローラーの起動に関連するログメッセージが含まれます。 |
EAP_HOME/domain/log/process-controller.log | プロセスコントローラーの起動に関連するログメッセージが含まれます。 |
EAP_HOME/domain/servers/SERVER_NAME/log/server.log | サーバー起動メッセージを含む、名前付きサーバーのログメッセージが含まれます。 |
11.1.5. サーバーのデフォルトロケールの設定
JVM プロパティーを適切な起動設定ファイルに設定すると、デフォルトのロケールを設定できます。起動設定ファイルは、スタンドアロンサーバーの場合は EAP_HOME/bin/standalone.conf
、管理対象ドメインの場合は EAP_HOME/bin/domain.conf
になります。
Windows Server の場合、JBoss EAP 起動設定ファイルは standalone.conf.bat
と domain.conf.bat
になります。
国際化または現地化されたログメッセージはこのデフォルトロケールを使用します。JBoss EAP開発ガイドの 国際化されたログメッセージの作成 に関する情報を参照してください。
言語の設定
言語を指定するには、JAVA_OPTS
変数を使用して user.language
プロパティーを設定します。たとえば、以下の行を起動設定ファイルに追加し、フランス語のロケールを設定します。
JAVA_OPTS="$JAVA_OPTS -Duser.language=fr"
国際化および現地化されたログメッセージがフランス語で出力されるようになります。
言語および国の設定
言語の他に、user.country
プロパティーを設定して国を指定することもできます。たとえば、以下の行を起動設定ファイルに追加すると、ポルトガル語のロケールがブラジルに設定されます。
JAVA_OPTS="$JAVA_OPTS -Duser.language=pt -Duser.country=BR"
国際化および現地化されたログメッセージがブラジルポルトガル語で出力されるようになります。
org.jboss.logging.locale プロパティーを使用したサーバーロケールの設定
org.jboss.logging.locale
プロパティーを使用すると、Boss EAP からのメッセージや JBoss EAP が所有する依存関係からのメッセージなど、JBoss Logging を使用してログに記録されたメッセージのロケールを上書きできます。JSF などの他の依存関係ではロケールを上書きできません。
JBoss EAP サーバーをシステムデフォルト以外のロケールで起動するには、操作モードに応じて EAP_HOME/bin/standalone.conf
または EAP_HOME/bin/domain.conf
ファイルを編集し、以下のコマンドを追加して必要なロケールの JVM パラメーターを設定します。プロパティーの値は BCP 47 形式で指定する必要があります。たとえば、ブラジルポルトガル語を設定する場合は pt-BR を使用します。
JAVA_OPTS="$JAVA_OPTS -Dorg.jboss.logging.locale=pt-BR"