ログ

Spring Boot からのデフォルトのログ出力は、次の例のようになります。

次の項目が出力されます。

デフォルトのログ構成では、メッセージが書き込まれるとコンソールにエコーされます。デフォルトでは、ERROR -level、WARN -level、および INFO -level メッセージがログに記録されます。--debug フラグを使用してアプリケーションを起動することにより、「デバッグ」モードを有効にすることもできます。

デバッグモードを有効にすると、コアロガー（埋め込みコンテナー、Hibernate、Spring Boot）の選択がより多くの情報を出力するように構成されます。デバッグモードを有効にしても、DEBUG レベルのすべてのメッセージをログに記録するようにアプリケーションが設定されるわけではありません。

または、--trace フラグ（または application.properties の trace=true）を使用してアプリケーションを開始することにより、「トレース」モードを有効にすることができます。これにより、選択されたコアロガー（埋め込みコンテナー、Hibernate スキーマ生成、Spring ポートフォリオ全体）のトレースログが有効になります。

デフォルトでは、Spring Boot はコンソールにのみログを記録し、ログファイルに書き込みません。コンソール出力に加えてログファイルにも書き込みたい場合は、logging.file.name または logging.file.path プロパティを設定する必要があります (たとえば、application.properties で)。両方のプロパティが設定されている場合、logging.file.path は無視され、logging.file.name のみが使用されます。

次の表は、logging.* プロパティを一緒に使用する方法を示しています。

ログファイルは 10MB に達するとローテーションし、コンソール出力と同様に、ERROR -level、WARN -level、および INFO -level メッセージがデフォルトでログに記録されます。

Logback を使用している場合は、application.properties または application.yaml ファイルを使用してログローテーション設定を微調整することができます。他のすべてのロギングシステムでは、ローテーション設定を自分で直接構成する必要があります (たとえば、Log4j2 を使用している場合は、log4j2.xml または log4j2-spring.xml ファイルを追加できます)。

次のローテーションポリシープロパティがサポートされています。

サポートされているすべてのロギングシステムでは、level が TRACE、DEBUG、INFO、WARN、ERROR、FATAL、OFF のいずれかである logging.level.<logger-name>=<level> を使用して、Spring Environment （たとえば application.properties）にロガーレベルを設定できます。root ロガーは、logging.level.root を使用して構成できます。

次の例は、application.properties の潜在的なロギング設定を示しています。

環境変数を使用してログレベルを設定することもできます。例: LOGGING_LEVEL_ORG_SPRINGFRAMEWORK_WEB=DEBUG は org.springframework.web を DEBUG に設定します。

関連するロガーをグループ化して、すべてを同時に構成できると便利なことがよくあります。例: Tomcat 関連のすべてのロガーのログレベルを一般的に変更する可能性がありますが、トップレベルのパッケージを簡単に覚えることはできません。

これを支援するために、Spring Boot では、Spring Environment でロギンググループを定義できます。例: application.properties に "tomcat" グループを追加して定義する方法は次のとおりです。

定義したら、グループ内のすべてのロガーのレベルを 1 行で変更できます。

Spring Boot には、すぐに使用できる次の事前定義されたロギンググループが含まれています。

アプリケーションの終了時にロギングリソースを解放するために、JVM の終了時にログシステムのクリーンアップをトリガーするシャットダウンフックが提供されています。このシャットダウンフックは、アプリケーションが war ファイルとしてデプロイされていない限り、自動的に登録されます。アプリケーションに複雑なコンテキスト階層がある場合、シャットダウンフックがニーズを満たさない可能性があります。そうでない場合は、シャットダウンフックを無効にして、基盤となるロギングシステムによって直接提供されるオプションを調べましょう。例: Logback は、各ロガーを独自のコンテキストで作成できるようにするコンテキストセレクターを提供 (英語) します。 logging.register-shutdown-hook プロパティを使用して、シャットダウンフックを無効にすることができます。false に設定すると、登録が無効になります。プロパティは、application.properties または application.yaml ファイルで設定できます。

さまざまなロギングシステムは、クラスパスに適切なライブラリを含めることでアクティブにでき、クラスパスのルートまたは次の Spring Environment プロパティで指定された場所に適切な構成ファイルを提供することでさらにカスタマイズできます: logging.config

org.springframework.boot.logging.LoggingSystem システムプロパティを使用して、Spring Boot に特定のログシステムを強制的に使用させることができます。値は、LoggingSystem 実装の完全修飾クラス名でなければなりません。none の値を使用して、Spring Boot のログ設定を完全に無効にすることもできます。

ロギングシステムに応じて、次のファイルがロードされます。

カスタマイズを容易にするために、他のいくつかのプロパティが Spring Environment からシステムプロパティに転送されます。これにより、システム構成のログ記録によってプロパティを使用できるようになります。例: 環境変数として application.properties または LOGGING_FILE_NAME に logging.file.name を設定すると、LOG_FILE システムプロパティが設定されます。転送されるプロパティについては、次の表で説明します。

Logback を使用する場合、次のプロパティも転送されます。

サポートされているすべてのログシステムは、構成ファイルを解析するときにシステムプロパティを参照できます。例については、spring-boot.jar のデフォルト構成を参照してください。

Spring Boot には、高度な構成に役立つ Logback の拡張機能が多数含まれています。これらの拡張機能を logback-spring.xml 構成ファイルで使用できます。

Spring Boot には、高度な構成に役立つ Log4j2 の拡張機能が多数含まれています。これらの拡張子は、任意の log4j2-spring.xml 構成ファイルで使用できます。