Apache Tomcat 10

• はじめに
  1. JavaロギングAPI — java.util.logging
  2. サーブレットロギングAPI
  3. コンソール
  4. アクセスログ
• java.util.loggingの使用（デフォルト）
  1. ドキュメントリファレンス
  2. 本番環境での使用に関する考慮事項

Apache Tomcatの内部ロギングは、java.util.loggingフレームワークを使用するようにハードコードされた、Apache Commons Loggingの名前を変更したパッケージ化されたフォークであるJULIを使用します。これにより、WebアプリケーションがApache Commons Loggingを使用している場合でも、Tomcatの内部ロギングとWebアプリケーションのロギングは独立したままになります。

Tomcatが内部ロギングに代替ロギングフレームワークを使用するように設定するには、java.util.loggingを使用するアプリケーションのロギングをリダイレクトするための、代替ロギングフレームワークによって提供される手順に従ってください。代替ロギングフレームワークは、同じ名前の異なるロガーが異なるクラスローダーに存在する可能性のある環境で動作できる必要があることに注意してください。

Apache Tomcatで実行されているWebアプリケーションは、

• 任意のロギングフレームワークを使用できます。
• システムロギングAPI、java.util.loggingを使用できます。
• Java Servlets仕様で提供されるロギングAPI、jakarta.servlet.ServletContext.log(...)を使用できます。

異なるWebアプリケーションで使用されるロギングフレームワークは独立しています。詳細については、クラスローディングを参照してください。このルールの例外は、java.util.loggingです。ロギングライブラリで直接的または間接的に使用されている場合、システムクラスローダーによってロードされるため、その要素はWebアプリケーション間で共有されます。

org.apache.catalina.core.ContainerBase.[${engine}].[${host}].[${context}]

JDKで提供されているjava.util.loggingのデフォルト実装は、役に立たないほど制限されています。主な制限は、設定がVMごとであるため、Webアプリケーションごとのロギングができないことです。その結果、Tomcatはデフォルト構成で、デフォルトのLogManager実装を、これらの欠点を addressed するJULIと呼ばれるコンテナフレンドリーな実装に置き換えます。

JULIは、プログラムによるアプローチまたはプロパティファイルを使用して、標準のJDK java.util.loggingと同じ構成メカニズムをサポートしています。主な違いは、クラスローダーごとのプロパティファイルを設定できること（再デプロイメントに適したWebアプリケーションの構成が容易になる）、およびプロパティファイルがハンドラーを定義し、ロガーに割り当てるためのより自由な拡張コンストラクトをサポートすることです。

JULIはデフォルトで有効になっており、通常のグローバルjava.util.logging構成に加えて、クラスローダーごとの構成をサポートしています。これは、ロギングを次のレイヤーで構成できることを意味します

• グローバル。これは通常、${catalina.base}/conf/logging.propertiesファイルで行われます。ファイルは、スタートアップスクリプトによって設定されるjava.util.logging.config.fileシステムプロパティによって指定されます。読み取れない場合、または構成されていない場合、デフォルトではJREの${java.home}/lib/logging.propertiesファイルが使用されます。
• Webアプリケーション内。ファイルはWEB-INF/classes/logging.propertiesになります

JREのデフォルトのlogging.propertiesは、ロギングをSystem.errにルーティングするConsoleHandlerを指定します。Apache Tomcatのデフォルトのconf/logging.propertiesも、ファイルに書き込むいくつかのAsyncFileHandlerを追加します。

ハンドラーのログレベルのしきい値はデフォルトでINFOであり、SEVERE、WARNING、INFO、CONFIG、FINE、FINER、FINEST、またはALLを使用して設定できます。ロギングを収集する特定のパッケージをターゲットにして、レベルを指定することもできます。

Tomcat内部の一部でデバッグロギングを有効にするには、適切なロガーと適切なハンドラーの両方をFINESTまたはALLレベルを使用するように構成する必要があります。例：

org.apache.catalina.session.level=ALL
java.util.logging.ConsoleHandler.level=ALL

デバッグロギングを有効にする場合は、デバッグロギングによって大量の情報が生成される可能性があるため、可能な限り狭い範囲で有効にすることをお勧めします。

JULIで使用される構成は、プレーンjava.util.loggingでサポートされている構成と同じですが、ロガーとハンドラーをより柔軟に構成できるように、いくつかの拡張機能を使用します。主な違いは次のとおりです。

• プレフィックスをハンドラー名に追加して、単一クラスの複数のハンドラーをインスタンス化できるようにすることができます。プレフィックスは、数字で始まり「。」で終わる文字列です。たとえば、22foobar.は有効なプレフィックスです。
• ${systemPropertyName}を含むプロパティ値に対して、システムプロパティの置換が実行されます。
• org.apache.juli.WebappPropertiesインターフェースを実装するクラスローダー（TomcatのWebアプリケーションクラスローダーは実装します）を使用する場合、Webアプリケーション名、ホスト名、およびサービス名にそれぞれ置き換えられる${classloader.webappName}、${classloader.hostName}、および${classloader.serviceName}のプロパティ置換も実行されます。
• デフォルトでは、ロガーに関連付けられたハンドラーがある場合、ロガーは親に委任しません。これは、ブール値を受け入れるloggerName.useParentHandlersプロパティを使用して、ロガーごとに変更できます。
• ルートロガーは、.handlersプロパティを使用してハンドラーのセットを定義できます。
• デフォルトでは、ログファイルはファイルシステムに90日間保持されます。これは、handlerName.maxDaysプロパティを使用してハンドラごとに変更できます。プロパティに指定された値が≤0の場合、ログファイルはファイルシステムに永久に保持されます。それ以外の場合は、指定された最大日数保持されます。

Javaによって提供されるものと一緒に使用できる追加の実装クラスがいくつかあります。注目すべきものは、org.apache.juli.FileHandlerとorg.apache.juli.AsyncFileHandlerです。

org.apache.juli.FileHandlerはログのバッファリングをサポートします。バッファリングはデフォルトでは有効になっていません。設定するには、ハンドラのbufferSizeプロパティを使用します。値0はシステムのデフォルトバッファリングを使用します（通常は8Kバッファが使用されます）。値<0は、ログ書き込みごとにライターを強制的にフラッシュします。値>0は、定義された値でBufferedOutputStreamを使用しますが、システムのデフォルトバッファリングも適用されることに注意してください。

org.apache.juli.AsyncFileHandlerは、FileHandlerのサブクラスであり、ログメッセージをキューに入れてログファイルに非同期で書き込みます。追加の動作は、いくつかのシステムプロパティを設定することで構成できます。

`$CATALINA_BASE/conf`に配置するlogging.propertiesファイルの例

handlers = 1catalina.org.apache.juli.FileHandler, \
           2localhost.org.apache.juli.FileHandler, \
           3manager.org.apache.juli.FileHandler, \
           java.util.logging.ConsoleHandler

.handlers = 1catalina.org.apache.juli.FileHandler, java.util.logging.ConsoleHandler

############################################################
# Handler specific properties.
# Describes specific configuration info for Handlers.
############################################################

1catalina.org.apache.juli.FileHandler.level = FINE
1catalina.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
1catalina.org.apache.juli.FileHandler.prefix = catalina.
1catalina.org.apache.juli.FileHandler.maxDays = 90
1catalina.org.apache.juli.FileHandler.encoding = UTF-8

2localhost.org.apache.juli.FileHandler.level = FINE
2localhost.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
2localhost.org.apache.juli.FileHandler.prefix = localhost.
2localhost.org.apache.juli.FileHandler.maxDays = 90
2localhost.org.apache.juli.FileHandler.encoding = UTF-8

3manager.org.apache.juli.FileHandler.level = FINE
3manager.org.apache.juli.FileHandler.directory = ${catalina.base}/logs
3manager.org.apache.juli.FileHandler.prefix = manager.
3manager.org.apache.juli.FileHandler.bufferSize = 16384
3manager.org.apache.juli.FileHandler.maxDays = 90
3manager.org.apache.juli.FileHandler.encoding = UTF-8

java.util.logging.ConsoleHandler.level = FINE
java.util.logging.ConsoleHandler.formatter = java.util.logging.OneLineFormatter
java.util.logging.ConsoleHandler.encoding = UTF-8

############################################################
# Facility specific properties.
# Provides extra control for each logger.
############################################################

org.apache.catalina.core.ContainerBase.[Catalina].[localhost].level = INFO
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].handlers = \
   2localhost.org.apache.juli.FileHandler

org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].level = INFO
org.apache.catalina.core.ContainerBase.[Catalina].[localhost].[/manager].handlers = \
   3manager.org.apache.juli.FileHandler

# For example, set the org.apache.catalina.util.LifecycleBase logger to log
# each component that extends LifecycleBase changing state:
#org.apache.catalina.util.LifecycleBase.level = FINE

servlet-examples Webアプリケーションのlogging.propertiesの例。Webアプリケーション内の`WEB-INF/classes`に配置します。

handlers = org.apache.juli.FileHandler, java.util.logging.ConsoleHandler

############################################################
# Handler specific properties.
# Describes specific configuration info for Handlers.
############################################################

org.apache.juli.FileHandler.level = FINE
org.apache.juli.FileHandler.directory = ${catalina.base}/logs
org.apache.juli.FileHandler.prefix = ${classloader.webappName}.

java.util.logging.ConsoleHandler.level = FINE
java.util.logging.ConsoleHandler.formatter = java.util.logging.OneLineFormatter