ログ

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 ファイルを追加できます)。

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

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

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

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

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

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

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

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

In order to release logging resources when your application terminates, a shutdown hook that will trigger log system cleanup when the JVM exits is provided. This shutdown hook is registered automatically unless your application is deployed as a war file. If your application has complex context hierarchies the shutdown hook may not meet your needs. If it does not, disable the shutdown hook and investigate the options provided directly by the underlying logging system. For example, Logback offers context selectors (英語) which allow each Logger to be created in its own context. You can use the logging.register-shutdown-hook property to disable the shutdown hook. Setting it to false will disable the registration. You can set the property in your application.properties or application.yaml file:

The various logging systems can be activated by including the appropriate libraries on the classpath and can be further customized by providing a suitable configuration file in the root of the classpath or in a location specified by the following Spring Environment (Javadoc) property: logging.config.

You can force Spring Boot to use a particular logging system by using the org.springframework.boot.logging.LoggingSystem system property. The value should be the fully qualified class name of a LoggingSystem (Javadoc) implementation. You can also disable Spring Boot’s logging configuration entirely by using a value of none.

Depending on your logging system, the following files are loaded:

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

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

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

構造化ログは、ログ出力が明確に定義され、多くの場合は機械可読な形式で書き込まれる手法です。Spring Boot は構造化ログをサポートしており、次の JSON 形式をすぐに使用できます。

構造化ログを有効にするには、プロパティ logging.structured.format.console (コンソール出力の場合) または logging.structured.format.file (ファイル出力の場合) を、使用する形式の ID に設定します。

カスタムログ設定を使用している場合は、CONSOLE_LOG_STRUCTURED_FORMAT および FILE_LOG_STRUCTURED_FORMAT システムプロパティを考慮するように構成を更新します。CONSOLE_LOG_STRUCTURED_FORMAT を例に挙げます。

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

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