バージョン:

ロギング設定

Quarkus でのロギング API の使用、ロギング出力の設定、および他のロギング API からの出力を一元化するためのロギングアダプターの使用について説明します。

このドキュメントは、これや他のオブザーバビリティー関連コンポーネントを特徴とする Quarkus におけるオブザーバビリティーリファレンスガイドの一部です。

Quarkus は、アプリケーションとフレームワークのログを発行するために JBoss Log Manager ロギングバックエンドを使用します。 Quarkus は JBoss Logging API と他の複数のロギング API をサポートしており、これらは JBoss Log Manager とシームレスに統合されています。

これは、アプリケーションに適切なアダプターを追加すれば、Quarkus でお好みのロギング API を使用できることを意味します。

ロギング API アダプター

ロギング API	アダプター
JBoss Logging	組み込み
JDK `java.util.logging` (JUL)	組み込み
SLF4J	SLF4J アダプター
Apache Commons Logging	Commons Logging アダプター
Apache Log4j 2	Log4j 2 アダプター
Apache Log4j 1	Log4j 1 アダプター

JBoss Logging

組み込み

JDK java.util.logging (JUL)

組み込み

SLF4J

SLF4J アダプター

Apache Commons Logging

Commons Logging アダプター

アプリケーションロギングへの JBoss Logging の使用

JBoss Logging API を使用する場合、 Quarkus が自動的に提供するため、アプリケーションに追加の依存関係は必要ありません。

JBoss Logging API を使用してメッセージをログに記録する例。

import org.jboss.logging.Logger;

import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.MediaType;

@Path("/hello")
public class ExampleResource {

    private static final Logger LOG = Logger.getLogger(ExampleResource.class);

    @GET
    @Produces(MediaType.TEXT_PLAIN)
    public String hello() {
        LOG.info("Hello");
        return "hello";
    }
}

JBoss Logging はログメッセージを直接 JBoss Log Manager にルーティングしますが、ライブラリーの 1 つが別のロギング API に依存している場合があります。そのような場合は、ロギングアダプターを使用して、そのログメッセージも JBoss Log Manager にルーティングされるようにする必要があります。

アプリケーションロガーの取得

Quarkus でアプリケーションロガーを取得するには、次のいずれかのアプローチを選択します。

ロガーフィールドの宣言
簡易ロギング
設定されたロガーの注入

ロガーフィールドの宣言

この古典的なアプローチでは、特定の API を使用してロガーインスタンスを取得し、それをクラスの静的フィールドに格納して、そのインスタンスに対してロギング操作を呼び出します。

同じフローを、いずれのサポートされているロギング API にも適用できます。

JBoss Logging API を使用して、ロガーインスタンスを静的フィールドに格納する例。

package com.example;

import org.jboss.logging.Logger;

public class MyService {
    private static final Logger log = Logger.getLogger(MyService.class); (1)

    public void doSomething() {
        log.info("It works!"); (2)
    }
}

1	ロガーフィールドの定義
2	`log` オブジェクトに対して、必要なロギングメソッドを呼び出します。

Logger インスタンスを作成すると、Quarkus はアプリケーションの全ライフサイクルにわたって、その Logger 名に関連付けられたメタデータをメモリー内に保持します。

ロガーに対して、 for (int i …) { Logger.getLogger("logger-name." + i).info("my log") } のような、制限のない動的な名前を使用しないでください。

簡易ロギング

Quarkus は、 io.quarkus.logging.Log を使用するクラスにロガーフィールドを自動的に追加することで、ロギングを簡素化します。これにより、反復的なボイラープレートコードが不要になり、ロギング設定の利便性が向上します。

静的メソッド呼び出しを使用した簡素化されたロギングの例。

package com.example;

import io.quarkus.logging.Log; (1)

class MyService { (2)
    public void doSomething() {
        Log.info("Simple!"); (3)
    }
}

1	`io.quarkus.logging.Log` クラスは JBoss Logging と同じメソッドを提供しますが、これらは静的メソッドです。
2	このクラスはロガーフィールドを宣言しません。アプリケーションのビルド中に、Quarkus は `Log` API を使用する各クラスに `private static final org.jboss.logging.Logger` フィールドを作成します。Quarkus は、呼び出し元のクラスの完全修飾名をロガー名として使用します。この例では、ロガー名は `com.example.MyService` です。
3	アプリケーションのビルド中に、Quarkus は `Log` メソッドへの呼び出しを、生成されたロガーフィールド上の JBoss Logging 呼び出しに書き換えます。

Log API は外部依存関係ではなく、アプリケーションクラスでのみ使用してください。ビルド時に Quarkus によって処理されない Log メソッド呼び出しは例外の原因となります。

エクステンションでの io.quarkus.logging.Log の使用

Log API はアプリケーションクラスでのロギングを簡素化しますが、エクステンションモジュールや外部依存関係での使用は推奨されません。

以下の考慮事項が適用されます。

io.quarkus.logging.Log は、ビルド時に発生する Quarkus のバイトコード変換に依存しています。
エクステンションモジュールでは、モジュールに Jandex インデックスが含まれている場合にのみ Log が機能します。ただし、この動作はサポートされておらず、信頼性の低いロギングにつながる可能性があります。

エクステンションの開発では、 io.quarkus.logging.Log の代わりに org.jboss.logging.Logger.getLogger(String) を使用してください。

設定されたロガーの注入

ロガーフィールドを宣言する代わりに、別の方法として @Inject を使用して設定済みの org.jboss.logging.Logger インスタンスを注入できます。この方法は CDI Bean にのみ適用されます。

ロガー名を制御するには、以下の注入パターンのいずれかを選択してください。

ロガー名を注入先のクラス名にしたい場合は、 @Inject Logger log を使用します。
ロガー名を明示的に設定したい場合は、 @LoggerName("…") Logger log を使用します。

すでに Logger に @LoggerName("…") を付与している場合、 @Inject は必須ではありません。

注入された後は、 log オブジェクトを使用してロギングメソッドを呼び出すことができます。

2 つの異なるタイプのロガー注入の例。

package com.example;

import org.jboss.logging.Logger;

@ApplicationScoped
class SimpleBean {

   @Inject
   Logger log; (1)

   @LoggerName("foo")
   Logger fooLog; (2)

   public void ping() {
     log.info("Simple!");
     fooLog.info("Goes to _foo_ logger!");
   }
}

1	ロガーは `org.jboss.logging.Logger.getLogger(SimpleBean.class)` で作成されます。
2	この場合、 "foo" という名前がロガー名として使用されます。ロガーは `org.jboss.logging.Logger.getLogger("foo")` で作成されます。

Quarkus は内部的にロガーインスタンスをキャッシュします。 @RequestScoped Bean にロガーを注入する場合、ロガーの繰り返し生成によるパフォーマンス低下を避けるため、Quarkus は Bean インスタンス間でそのロガーを共有します。

ログレベルの使用

Quarkus は、イベントの重要性に基づいてログに記録される情報の量を制御するために、複数のログレベルを提供します。

利用可能なログレベル。

OFF	ロギングをオフにするために設定で使用される特別なレベル。
FATAL	重大なサービス障害、またはあらゆるリクエストを処理できない状態。
ERROR	処理における重大な問題、またはリクエストを完了できない状態。
WARN	重大ではないサービスエラー、または即時の修正を必要としない可能性のある問題。
INFO	サービスのライフサイクルイベント、またはその他の重要な低頻度の情報。
DEBUG	ライフサイクルイベントに関する追加情報、または特定のリクエストに紐付かないイベントで、デバッグに役立つもの。
TRACE	リクエストごとの詳細なデバッグ情報。非常に高い頻度で発生する可能性があります。
ALL	カスタムレベルを含むすべてのメッセージのロギングをオンにするための特別なレベル。

java.util.logging を使用するアプリケーションやライブラリーに対して、以下のレベルを設定することもできます。

SEVERE	ERROR と同じ。
WARNING	WARN と同じ。
CONFIG	サービス設定情報。
FINE	DEBUG と同じ。
FINER	TRACE と同じ。
FINEST	`TRACE` よりも詳細なデバッグ出力。さらに高頻度になる可能性があります。

Table 1. レベル間のマッピング
数値レベル値	標準レベル名	対応する `java.util.logging` (JUL) レベル名
1100	FATAL	該当なし
1000	ERROR	SEVERE
900	WARN	WARNING
800	INFO	INFO
700	該当なし	CONFIG
500	DEBUG	FINE
400	TRACE	FINER
300	該当なし	FINEST

ログレベル、カテゴリー、フォーマットの設定

Quarkus に統合された JBoss Logging は、利用可能なすべてのエクステンションを設定する単一の設定ファイルを通じて、すべてのサポートされているロギング API に対して統一された設定を提供します。

ランタイムロギングを調整するには、 application.properties ファイルを編集します。

デフォルトのログレベルを INFO ロギングに設定し、 Hibernate の DEBUG ログを含める方法の例。

quarkus.log.level=INFO
quarkus.log.category."org.hibernate".level=DEBUG

Quarkus YAML エクステンションが含まれていると仮定すると、同等の YAML 設定は以下のようになります。

quarkus:
  log:
    level: INFO
    category:
      org.hibernate: # Using org.hibernate as a single key is required
        level: DEBUG

ログレベルを DEBUG 未満 (例えば TRACE) に設定する場合は、最小ログレベルも調整する必要があります。

quarkus.log.min-level 設定プロパティーを使用して最小ログレベルをグローバルに設定するか、カテゴリーごとに設定します。

quarkus.log.category."org.hibernate".min-level=TRACE

最小ログレベルは、Quarkus がサポートコードを生成する基準となるフロアレベルを設定するビルド時設定オプションです。これにより、ネイティブイメージのビルド時のデッドコード削除など、さらなるビルド時の最適化が可能になります。

ネイティブ実行可能ファイルの例。

最小ログレベルとして INFO を設定すると、 isTraceEnabled() などのより低いレベルのチェックが常に false を返すよう強制されます。

その結果、 if (logger.isDebugEnabled()) callMethod(); のようなコードは決して実行されないと識別され、デッドコードとして扱われます。

これらのプロパティーをコマンドラインで追加する場合は、 " 文字が正しくエスケープされていることを確認してください。

-Dquarkus.log.category.\"org.hibernate\".level=TRACE

設定可能なすべてのプロパティーは、ロギング設定リファレンスセクションにリストされています。

ロギングカテゴリー

ロギングはカテゴリーごとに設定されます。あるカテゴリーの設定は、より具体的なサブカテゴリーの設定が存在しない限り、すべてのサブカテゴリーに再帰的に適用されます。

すべてのロギングカテゴリーの親は「ルートカテゴリー」と呼ばれます。究極の親として、このカテゴリーには他のすべてのカテゴリーにグローバルに適用される設定を含めることができます。これには、グローバルに設定されたハンドラーやフォーマッターが含まれます。

Example 1. すべてのカテゴリーに適用されるグローバル設定の例。

quarkus.log.handlers=con,mylog

quarkus.log.handler.console.con.enable=true
quarkus.log.handler.file.mylog.enable=true

この例では、ルートカテゴリーが con と mylog という 2 つの名前付きハンドラーを使用するように設定されています。

Example 2. カテゴリーごとの設定例。

quarkus.log.category."org.apache.kafka.clients".level=INFO
quarkus.log.category."org.apache.kafka.common.utils".level=INFO

この例は、 org.apache.kafka.clients および org.apache.kafka.common.utils カテゴリーの最小ログレベルを設定する方法を示しています。

詳細については、ロギング設定リファレンスを参照してください。

特定のカテゴリーに対して特別な設定を行いたい場合は、 quarkus.log.handler.[console|file|syslog].<your-handler-name>.* のような名前付きハンドラーを作成し、 quarkus.log.category.<my-category>.handlers を使用してそのカテゴリーに設定します。

ユースケースの例として、ファイルに保存されるログメッセージに対して、他のハンドラーで使用される形式とは異なるタイムスタンプ形式を使用したい場合などが挙げられます。

さらに詳しいデモについては、カテゴリーへの名前付きハンドラーのアタッチの例の出力を参照してください。

プロパティー名デフォルト説明

プロパティー名	デフォルト	説明
`quarkus.log.category."<category-name>".level`	`INFO ^[1]`	`<category-name>` という名前のカテゴリーを設定するために使用するレベル。引用符は必須です。
`quarkus.log.category."<category-name>".min-level`	`DEBUG`	`<category-name>` という名前のカテゴリーを設定するために使用する最小ロギングレベル。引用符は必須です。
`quarkus.log.category."<category-name>".use-parent-handlers`	`true`	このロガーが出力を親ロガーに送信するかどうかを指定します。
`quarkus.log.category."<category-name>".handlers=[<handler>]`	`empty ^[2]`	特定のカテゴリーにアタッチするハンドラーの名前。

quarkus.log.category."<category-name>".level

INFO ^[1]

<category-name> という名前のカテゴリーを設定するために使用するレベル。引用符は必須です。

quarkus.log.category."<category-name>".min-level

DEBUG

<category-name> という名前のカテゴリーを設定するために使用する最小ロギングレベル。引用符は必須です。

quarkus.log.category."<category-name>".use-parent-handlers

true

このロガーが出力を親ロガーに送信するかどうかを指定します。

quarkus.log.category."<category-name>".handlers=[<handler>]

empty ^[2]

特定のカテゴリーにアタッチするハンドラーの名前。

. 記号は設定プロパティー内の特定の部分を区切ります。プロパティー名に含まれる引用符は、 quarkus.log.category."io.quarkus.smallrye.jwt".level=TRACE のようなカテゴリー指定をそのまま維持するために必要なエスケープとして使用されます。

ルートロガーの設定

ルートロガーカテゴリーは個別に扱われ、以下のプロパティーを使用して設定されます。

プロパティー名デフォルト説明

プロパティー名	デフォルト	説明
`quarkus.log.level`	`INFO`	各ログカテゴリーのデフォルトのログレベル。
`quarkus.log.min-level`	`DEBUG`	各ログカテゴリーのデフォルトの最小ログレベル。

quarkus.log.level

INFO

各ログカテゴリーのデフォルトのログレベル。

quarkus.log.min-level

DEBUG

各ログカテゴリーのデフォルトの最小ログレベル。

特定のロガーカテゴリーに対してレベル設定が存在しない場合、親カテゴリーが調べられます。
カテゴリーおよびその親カテゴリーのいずれにも特定の設定が提供されていない場合、ルートロガーの設定が使用されます。

ルートロガーのハンドラーは通常 quarkus.log.console 、 quarkus.log.file 、 quarkus.log.syslog を通じて直接設定されますが、 quarkus.log.handlers プロパティーを使用して追加の名前付きハンドラーをアタッチすることもできます。

ロギングフォーマット

人間が読めるテキスト

Quarkus は、デフォルトで人間が読めるテキストログを生成するパターンベースのロギングフォーマッターを使用しますが、専用のプロパティーを使用して各ログハンドラーのフォーマットを設定することもできます。

コンソールハンドラーの場合、プロパティーは quarkus.log.console.format です。

ロギングフォーマット文字列は以下の記号をサポートしています。

記号概要説明

記号	概要	説明
`%%`	`%`	単純な `%` 文字をレンダリングします。
`%c`	カテゴリー	カテゴリー名をレンダリングします。
`%C`	ソースクラス	ソースクラス名をレンダリングします。 ^[3]
`%d{xxx}`	日付	`java.text.SimpleDateFormat` で定義された構文を使用する、指定された日付形式文字列で日付をレンダリングします。
`%e`	例外	スローされた例外があればレンダリングします。
`%F`	ソースファイル	ソースファイル名をレンダリングします。 ^[3]
`%h`	ホスト名	システムの単純なホスト名をレンダリングします。
`%H`	修飾ホスト名	システムの完全修飾ホスト名をレンダリングします。OS の設定によっては単純なホスト名と同じになる場合があります。
`%i`	プロセス ID	現在のプロセスの PID をレンダリングします。
`%l`	ソースの場所	ソースファイル名、行番号、クラス名、メソッド名を含むソースの場所情報をレンダリングします。 ^[3]
`%L`	ソース行	ソースの行番号をレンダリングします。 ^[3]
`%m`	フルメッセージ	ログメッセージと、もしあれば例外をレンダリングします。
`%M`	ソースメソッド	ソースメソッド名をレンダリングします。 ^[3]
`%n`	改行	プラットフォーム固有の改行文字列をレンダリングします。
`%N`	プロセス名	現在のプロセスの名前をレンダリングします。
`%p`	レベル	メッセージのログレベルをレンダリングします。
`%r`	相対時間	アプリケーションログの開始からの時間をミリ秒単位でレンダリングします。
`%s`	シンプルなメッセージ	ログメッセージのみをレンダリングし、例外トレースは含めません。
`%t`	スレッド名	スレッド名をレンダリングします。
`%t{id}`	スレッド ID	スレッド ID をレンダリングします。
`%z{<zone name>}`	タイムゾーン	出力のタイムゾーンを `<zone name>` に設定します。
`%X{<MDC property name>}`	マッピングされた診断コンテキスト値	Mapped Diagnostic Context から値をレンダリングします。
`%X`	マッピングされた診断コンテキスト値	Mapped Diagnostic Context からのすべての値を `{property.key=property.value}` フォーマットでレンダリングします。
`%x`	ネストされた診断コンテキスト値	Nested Diagnostics Context からのすべての値を `{value1.value2}` フォーマットでレンダリングします。

%%

%

単純な % 文字をレンダリングします。

%c

カテゴリー

カテゴリー名をレンダリングします。

%C

ソースクラス

ソースクラス名をレンダリングします。 ^[3]

%d{xxx}

日付

java.text.SimpleDateFormat で定義された構文を使用する、指定された日付形式文字列で日付をレンダリングします。

%e

例外

スローされた例外があればレンダリングします。

%F

ソースファイル

ソースファイル名をレンダリングします。 ^[3]

%h

ホスト名

システムの単純なホスト名をレンダリングします。

%H

修飾ホスト名

システムの完全修飾ホスト名をレンダリングします。OS の設定によっては単純なホスト名と同じになる場合があります。

%i

プロセス ID

現在のプロセスの PID をレンダリングします。

%l

ソースの場所

ソースファイル名、行番号、クラス名、メソッド名を含むソースの場所情報をレンダリングします。 ^[3]

%L

ソース行

ソースの行番号をレンダリングします。 ^[3]

%m

フルメッセージ

ログメッセージと、もしあれば例外をレンダリングします。

%M

ソースメソッド

ソースメソッド名をレンダリングします。 ^[3]

%n

改行

プラットフォーム固有の改行文字列をレンダリングします。

%N

プロセス名

現在のプロセスの名前をレンダリングします。

%p

レベル

メッセージのログレベルをレンダリングします。

%r

相対時間

アプリケーションログの開始からの時間をミリ秒単位でレンダリングします。

%s

シンプルなメッセージ

ログメッセージのみをレンダリングし、例外トレースは含めません。

%t

スレッド名

スレッド名をレンダリングします。

%t{id}

スレッド ID

スレッド ID をレンダリングします。

%z{<zone name>}

タイムゾーン

出力のタイムゾーンを <zone name> に設定します。

%X{<MDC property name>}

マッピングされた診断コンテキスト値

Mapped Diagnostic Context から値をレンダリングします。

%X

マッピングされた診断コンテキスト値

Mapped Diagnostic Context からのすべての値を {property.key=property.value} フォーマットでレンダリングします。

%x

ネストされた診断コンテキスト値

Nested Diagnostics Context からのすべての値を {value1.value2} フォーマットでレンダリングします。

JSON ログフォーマット

quarkus-logging-json エクステンションを使用すると、JSON ログフォーマットとその関連設定のサポートを追加できます。

以下のスニペットのように、このエクステンションをビルドファイルに追加してください。
pom.xml
```
<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-logging-json</artifactId>
</dependency>
```
build.gradle
```
implementation("io.quarkus:quarkus-logging-json")
```
デフォルトでは、このエクステンションはコンソールの出力フォーマット設定をオーバーライドし、フォーマット文字列や色設定は無視されます。非同期ロギングやログレベルを制御する項目を含む、その他のコンソール設定項目は引き続き適用されます。

開発モードでは人間が読める構造化されていないロギングを使用し、本番モードでは JSON 構造化ロギングを使用したい場合は、以下の設定のようにプロファイルを使用して設定してください。
dev および test モードで application.properties の JSON ロギングを無効にする。
```
%dev.quarkus.log.console.json.enabled=false
%test.quarkus.log.console.json.enabled=false
```
設定プロパティーを設定して、JSON コンソールログフォーマットを選択します。
```
quarkus.log.console.json.log-format
```
このプロパティーは、コンソールの JSON ログフォーマットを設定します。

指定可能な値は以下の通りです。
- default: ログレコードに含まれる key,values に基づいて構造化ログを生成します。Mapped Diagnostic Context (MDC) および Nested Diagnostic Context (NDC) のデータは、mdc および ndc フィールドに含まれます。
- ecs: Elastic Common Schema (ECS) フォーマットを使用します。このフォーマットは、一部のデフォルトフィールド名を変更し、ECS に合わせるために他のフィールドを追加します。
  
  フィールドには、@timestamp, log.logger, log.level, process.pid, process.name, process.thread.name, process.thread.id, host.hostname, event.sequence, error.message, error.stack_trace, ecs.version, data_stream.type, service.name, service.version, service.environment が含まれます。
- gcp: Google Cloud フォーマットを使用します。このフォーマットは default フォーマットに従います。
  
  OpenTelemetry を使用すると、Quarkus は mdc フィールドにあるトレースデータをフラット化し、spanId、traceSampled、trace にコピーします。trace の値にはプレフィックスが含まれます。
  
  Google Cloud では、trace フィールドが "projects/<my-trace-project>/traces/12345" フォーマットである必要があります。<my-trace-project> には quarkus.application.name 設定プロパティーの値が使用されます。

設定

サポートされているプロパティーを使用して JSON ロギングエクステンションを設定し、その動作をカスタマイズします。

ビルド時に固定される設定プロパティー - 他のすべての設定プロパティーは実行時にオーバーライド可能

Configuration property	型	デフォルト
Console logging	型	デフォルト
`quarkus.log.console.json.enabled` Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_ENABLED` Show more	boolean
`quarkus.log.console.json.pretty-print` Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_PRETTY_PRINT` Show more	boolean	`false`
`quarkus.log.console.json.date-format` The date format to use. The special string "default" indicates that the default format should be used. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_DATE_FORMAT` Show more	string	`default`
`quarkus.log.console.json.record-delimiter` The special end-of-record delimiter to be used. By default, newline is used. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_RECORD_DELIMITER` Show more	string
`quarkus.log.console.json.zone-id` The zone ID to use. The special string "default" indicates that the default zone should be used. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_ZONE_ID` Show more	string	`default`
`quarkus.log.console.json.exception-output-type` The exception output type to specify. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_EXCEPTION_OUTPUT_TYPE` Show more	`detailed`, `formatted`, `detailed-and-formatted`	`detailed`
`quarkus.log.console.json.print-details` Enable printing of more details in the log. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_PRINT_DETAILS` Show more	boolean	`false`
`quarkus.log.console.json.key-overrides` Override keys with custom values. Omitting this value indicates that no key overrides will be applied. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_KEY_OVERRIDES` Show more	string
`quarkus.log.console.json.excluded-keys` Keys to be excluded from the JSON output. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_EXCLUDED_KEYS` Show more	文字列のリスト
`quarkus.log.console.json.additional-field."field-name".value` Additional field value. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE` Show more	string	required
`quarkus.log.console.json.additional-field."field-name".type` Additional field type specification. Supported types: `string`, `int`, and `long`. String is the default if not specified. Environment variable: `QUARKUS_LOG_CONSOLE_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE` Show more	`string`, `int`, `long`	`string`
`quarkus.log.console.json.log-format` Specify the format of the produced JSON Environment variable: `QUARKUS_LOG_CONSOLE_JSON_LOG_FORMAT` Show more	`default`, `ecs`, `gcp`	`default`
File logging	型	デフォルト
`quarkus.log.file.json.enabled` Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting. Environment variable: `QUARKUS_LOG_FILE_JSON_ENABLED` Show more	boolean
`quarkus.log.file.json.pretty-print` Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output. Environment variable: `QUARKUS_LOG_FILE_JSON_PRETTY_PRINT` Show more	boolean	`false`
`quarkus.log.file.json.date-format` The date format to use. The special string "default" indicates that the default format should be used. Environment variable: `QUARKUS_LOG_FILE_JSON_DATE_FORMAT` Show more	string	`default`
`quarkus.log.file.json.record-delimiter` The special end-of-record delimiter to be used. By default, newline is used. Environment variable: `QUARKUS_LOG_FILE_JSON_RECORD_DELIMITER` Show more	string
`quarkus.log.file.json.zone-id` The zone ID to use. The special string "default" indicates that the default zone should be used. Environment variable: `QUARKUS_LOG_FILE_JSON_ZONE_ID` Show more	string	`default`
`quarkus.log.file.json.exception-output-type` The exception output type to specify. Environment variable: `QUARKUS_LOG_FILE_JSON_EXCEPTION_OUTPUT_TYPE` Show more	`detailed`, `formatted`, `detailed-and-formatted`	`detailed`
`quarkus.log.file.json.print-details` Enable printing of more details in the log. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number. Environment variable: `QUARKUS_LOG_FILE_JSON_PRINT_DETAILS` Show more	boolean	`false`
`quarkus.log.file.json.key-overrides` Override keys with custom values. Omitting this value indicates that no key overrides will be applied. Environment variable: `QUARKUS_LOG_FILE_JSON_KEY_OVERRIDES` Show more	string
`quarkus.log.file.json.excluded-keys` Keys to be excluded from the JSON output. Environment variable: `QUARKUS_LOG_FILE_JSON_EXCLUDED_KEYS` Show more	文字列のリスト
`quarkus.log.file.json.additional-field."field-name".value` Additional field value. Environment variable: `QUARKUS_LOG_FILE_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE` Show more	string	required
`quarkus.log.file.json.additional-field."field-name".type` Additional field type specification. Supported types: `string`, `int`, and `long`. String is the default if not specified. Environment variable: `QUARKUS_LOG_FILE_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE` Show more	`string`, `int`, `long`	`string`
`quarkus.log.file.json.log-format` Specify the format of the produced JSON Environment variable: `QUARKUS_LOG_FILE_JSON_LOG_FORMAT` Show more	`default`, `ecs`, `gcp`	`default`
Syslog logging	型	デフォルト
`quarkus.log.syslog.json.enabled` Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_ENABLED` Show more	boolean
`quarkus.log.syslog.json.pretty-print` Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_PRETTY_PRINT` Show more	boolean	`false`
`quarkus.log.syslog.json.date-format` The date format to use. The special string "default" indicates that the default format should be used. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_DATE_FORMAT` Show more	string	`default`
`quarkus.log.syslog.json.record-delimiter` The special end-of-record delimiter to be used. By default, newline is used. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_RECORD_DELIMITER` Show more	string
`quarkus.log.syslog.json.zone-id` The zone ID to use. The special string "default" indicates that the default zone should be used. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_ZONE_ID` Show more	string	`default`
`quarkus.log.syslog.json.exception-output-type` The exception output type to specify. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_EXCEPTION_OUTPUT_TYPE` Show more	`detailed`, `formatted`, `detailed-and-formatted`	`detailed`
`quarkus.log.syslog.json.print-details` Enable printing of more details in the log. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_PRINT_DETAILS` Show more	boolean	`false`
`quarkus.log.syslog.json.key-overrides` Override keys with custom values. Omitting this value indicates that no key overrides will be applied. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_KEY_OVERRIDES` Show more	string
`quarkus.log.syslog.json.excluded-keys` Keys to be excluded from the JSON output. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_EXCLUDED_KEYS` Show more	文字列のリスト
`quarkus.log.syslog.json.additional-field."field-name".value` Additional field value. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE` Show more	string	required
`quarkus.log.syslog.json.additional-field."field-name".type` Additional field type specification. Supported types: `string`, `int`, and `long`. String is the default if not specified. Environment variable: `QUARKUS_LOG_SYSLOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE` Show more	`string`, `int`, `long`	`string`
`quarkus.log.syslog.json.log-format` Specify the format of the produced JSON Environment variable: `QUARKUS_LOG_SYSLOG_JSON_LOG_FORMAT` Show more	`default`, `ecs`, `gcp`	`default`
Socket logging	型	デフォルト
`quarkus.log.socket.json.enabled` Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting. Environment variable: `QUARKUS_LOG_SOCKET_JSON_ENABLED` Show more	boolean
`quarkus.log.socket.json.pretty-print` Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output. Environment variable: `QUARKUS_LOG_SOCKET_JSON_PRETTY_PRINT` Show more	boolean	`false`
`quarkus.log.socket.json.date-format` The date format to use. The special string "default" indicates that the default format should be used. Environment variable: `QUARKUS_LOG_SOCKET_JSON_DATE_FORMAT` Show more	string	`default`
`quarkus.log.socket.json.record-delimiter` The special end-of-record delimiter to be used. By default, newline is used. Environment variable: `QUARKUS_LOG_SOCKET_JSON_RECORD_DELIMITER` Show more	string
`quarkus.log.socket.json.zone-id` The zone ID to use. The special string "default" indicates that the default zone should be used. Environment variable: `QUARKUS_LOG_SOCKET_JSON_ZONE_ID` Show more	string	`default`
`quarkus.log.socket.json.exception-output-type` The exception output type to specify. Environment variable: `QUARKUS_LOG_SOCKET_JSON_EXCEPTION_OUTPUT_TYPE` Show more	`detailed`, `formatted`, `detailed-and-formatted`	`detailed`
`quarkus.log.socket.json.print-details` Enable printing of more details in the log. Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number. Environment variable: `QUARKUS_LOG_SOCKET_JSON_PRINT_DETAILS` Show more	boolean	`false`
`quarkus.log.socket.json.key-overrides` Override keys with custom values. Omitting this value indicates that no key overrides will be applied. Environment variable: `QUARKUS_LOG_SOCKET_JSON_KEY_OVERRIDES` Show more	string
`quarkus.log.socket.json.excluded-keys` Keys to be excluded from the JSON output. Environment variable: `QUARKUS_LOG_SOCKET_JSON_EXCLUDED_KEYS` Show more	文字列のリスト
`quarkus.log.socket.json.additional-field."field-name".value` Additional field value. Environment variable: `QUARKUS_LOG_SOCKET_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE` Show more	string	required
`quarkus.log.socket.json.additional-field."field-name".type` Additional field type specification. Supported types: `string`, `int`, and `long`. String is the default if not specified. Environment variable: `QUARKUS_LOG_SOCKET_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE` Show more	`string`, `int`, `long`	`string`
`quarkus.log.socket.json.log-format` Specify the format of the produced JSON Environment variable: `QUARKUS_LOG_SOCKET_JSON_LOG_FORMAT` Show more	`default`, `ecs`, `gcp`	`default`

Configuration property

型

デフォルト

Console logging

型

デフォルト

quarkus.log.console.json.enabled

Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_ENABLED

boolean

quarkus.log.console.json.pretty-print

Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_PRETTY_PRINT

boolean

false

quarkus.log.console.json.date-format

The date format to use. The special string "default" indicates that the default format should be used.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_DATE_FORMAT

string

default

quarkus.log.console.json.record-delimiter

The special end-of-record delimiter to be used. By default, newline is used.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_RECORD_DELIMITER

string

quarkus.log.console.json.zone-id

The zone ID to use. The special string "default" indicates that the default zone should be used.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_ZONE_ID

string

default

quarkus.log.console.json.exception-output-type

The exception output type to specify.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_EXCEPTION_OUTPUT_TYPE

detailed, formatted, detailed-and-formatted

detailed

quarkus.log.console.json.print-details

Enable printing of more details in the log.

Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_PRINT_DETAILS

boolean

false

quarkus.log.console.json.key-overrides

Override keys with custom values. Omitting this value indicates that no key overrides will be applied.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_KEY_OVERRIDES

string

quarkus.log.console.json.excluded-keys

Keys to be excluded from the JSON output.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_EXCLUDED_KEYS

文字列のリスト

quarkus.log.console.json.additional-field."field-name".value

Additional field value.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE

string

required

quarkus.log.console.json.additional-field."field-name".type

Additional field type specification. Supported types: string, int, and long. String is the default if not specified.

Environment variable: QUARKUS_LOG_CONSOLE_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE

string, int, long

string

quarkus.log.console.json.log-format

Specify the format of the produced JSON

Environment variable: QUARKUS_LOG_CONSOLE_JSON_LOG_FORMAT

default, ecs, gcp

default

File logging

型

デフォルト

quarkus.log.file.json.enabled

Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.

Environment variable: QUARKUS_LOG_FILE_JSON_ENABLED

boolean

quarkus.log.file.json.pretty-print

Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.

Environment variable: QUARKUS_LOG_FILE_JSON_PRETTY_PRINT

boolean

false

quarkus.log.file.json.date-format

The date format to use. The special string "default" indicates that the default format should be used.

Environment variable: QUARKUS_LOG_FILE_JSON_DATE_FORMAT

string

default

quarkus.log.file.json.record-delimiter

The special end-of-record delimiter to be used. By default, newline is used.

Environment variable: QUARKUS_LOG_FILE_JSON_RECORD_DELIMITER

string

quarkus.log.file.json.zone-id

The zone ID to use. The special string "default" indicates that the default zone should be used.

Environment variable: QUARKUS_LOG_FILE_JSON_ZONE_ID

string

default

quarkus.log.file.json.exception-output-type

The exception output type to specify.

Environment variable: QUARKUS_LOG_FILE_JSON_EXCEPTION_OUTPUT_TYPE

detailed, formatted, detailed-and-formatted

detailed

quarkus.log.file.json.print-details

Enable printing of more details in the log.

Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.

Environment variable: QUARKUS_LOG_FILE_JSON_PRINT_DETAILS

boolean

false

quarkus.log.file.json.key-overrides

Override keys with custom values. Omitting this value indicates that no key overrides will be applied.

Environment variable: QUARKUS_LOG_FILE_JSON_KEY_OVERRIDES

string

quarkus.log.file.json.excluded-keys

Keys to be excluded from the JSON output.

Environment variable: QUARKUS_LOG_FILE_JSON_EXCLUDED_KEYS

文字列のリスト

quarkus.log.file.json.additional-field."field-name".value

Additional field value.

Environment variable: QUARKUS_LOG_FILE_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE

string

required

quarkus.log.file.json.additional-field."field-name".type

Additional field type specification. Supported types: string, int, and long. String is the default if not specified.

Environment variable: QUARKUS_LOG_FILE_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE

string, int, long

string

quarkus.log.file.json.log-format

Specify the format of the produced JSON

Environment variable: QUARKUS_LOG_FILE_JSON_LOG_FORMAT

default, ecs, gcp

default

Syslog logging

型

デフォルト

quarkus.log.syslog.json.enabled

Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_ENABLED

boolean

quarkus.log.syslog.json.pretty-print

Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_PRETTY_PRINT

boolean

false

quarkus.log.syslog.json.date-format

The date format to use. The special string "default" indicates that the default format should be used.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_DATE_FORMAT

string

default

quarkus.log.syslog.json.record-delimiter

The special end-of-record delimiter to be used. By default, newline is used.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_RECORD_DELIMITER

string

quarkus.log.syslog.json.zone-id

The zone ID to use. The special string "default" indicates that the default zone should be used.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_ZONE_ID

string

default

quarkus.log.syslog.json.exception-output-type

The exception output type to specify.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_EXCEPTION_OUTPUT_TYPE

detailed, formatted, detailed-and-formatted

detailed

quarkus.log.syslog.json.print-details

Enable printing of more details in the log.

Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_PRINT_DETAILS

boolean

false

quarkus.log.syslog.json.key-overrides

Override keys with custom values. Omitting this value indicates that no key overrides will be applied.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_KEY_OVERRIDES

string

quarkus.log.syslog.json.excluded-keys

Keys to be excluded from the JSON output.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_EXCLUDED_KEYS

文字列のリスト

quarkus.log.syslog.json.additional-field."field-name".value

Additional field value.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE

string

required

quarkus.log.syslog.json.additional-field."field-name".type

Additional field type specification. Supported types: string, int, and long. String is the default if not specified.

Environment variable: QUARKUS_LOG_SYSLOG_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE

string, int, long

string

quarkus.log.syslog.json.log-format

Specify the format of the produced JSON

Environment variable: QUARKUS_LOG_SYSLOG_JSON_LOG_FORMAT

default, ecs, gcp

default

Socket logging

型

デフォルト

quarkus.log.socket.json.enabled

Determine whether to enable the JSON console formatting extension, which disables "normal" console formatting.

Environment variable: QUARKUS_LOG_SOCKET_JSON_ENABLED

boolean

quarkus.log.socket.json.pretty-print

Enable "pretty printing" of the JSON record. Note that some JSON parsers will fail to read the pretty printed output.

Environment variable: QUARKUS_LOG_SOCKET_JSON_PRETTY_PRINT

boolean

false

quarkus.log.socket.json.date-format

The date format to use. The special string "default" indicates that the default format should be used.

Environment variable: QUARKUS_LOG_SOCKET_JSON_DATE_FORMAT

string

default

quarkus.log.socket.json.record-delimiter

The special end-of-record delimiter to be used. By default, newline is used.

Environment variable: QUARKUS_LOG_SOCKET_JSON_RECORD_DELIMITER

string

quarkus.log.socket.json.zone-id

The zone ID to use. The special string "default" indicates that the default zone should be used.

Environment variable: QUARKUS_LOG_SOCKET_JSON_ZONE_ID

string

default

quarkus.log.socket.json.exception-output-type

The exception output type to specify.

Environment variable: QUARKUS_LOG_SOCKET_JSON_EXCEPTION_OUTPUT_TYPE

detailed, formatted, detailed-and-formatted

detailed

quarkus.log.socket.json.print-details

Enable printing of more details in the log.

Printing the details can be expensive as the values are retrieved from the caller. The details include the source class name, source file name, source method name, and source line number.

Environment variable: QUARKUS_LOG_SOCKET_JSON_PRINT_DETAILS

boolean

false

quarkus.log.socket.json.key-overrides

Override keys with custom values. Omitting this value indicates that no key overrides will be applied.

Environment variable: QUARKUS_LOG_SOCKET_JSON_KEY_OVERRIDES

string

quarkus.log.socket.json.excluded-keys

Keys to be excluded from the JSON output.

Environment variable: QUARKUS_LOG_SOCKET_JSON_EXCLUDED_KEYS

文字列のリスト

quarkus.log.socket.json.additional-field."field-name".value

Additional field value.

Environment variable: QUARKUS_LOG_SOCKET_JSON_ADDITIONAL_FIELD__FIELD_NAME__VALUE

string

required

quarkus.log.socket.json.additional-field."field-name".type

Additional field type specification. Supported types: string, int, and long. String is the default if not specified.

Environment variable: QUARKUS_LOG_SOCKET_JSON_ADDITIONAL_FIELD__FIELD_NAME__TYPE

string, int, long

string

quarkus.log.socket.json.log-format

Specify the format of the produced JSON

Environment variable: QUARKUS_LOG_SOCKET_JSON_LOG_FORMAT

default, ecs, gcp

default

プリティプリントを有効にすると、特定のプロセッサーや JSON パーサーが失敗する可能性があります。

詳細の出力は、呼び出し元から値を取得するためコストがかかる場合があります。詳細には、ソースクラス名、ソースファイル名、ソースメソッド名、ソース行番号が含まれます。

ログハンドラー

ログハンドラーは、ログイベントを受信者に送出するロギングコンポーネントです。Quarkus には、console、file、syslog という数種類のログハンドラーが含まれています。

紹介されている例では、ロギングカテゴリーとして com.example を使用しています。

コンソールログハンドラー

コンソールログハンドラーはデフォルトで有効になっており、すべてのログイベントをアプリケーションのコンソール (通常はシステムの stdout) に送ります。

グローバル設定の例。

quarkus.log.console.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n

カテゴリーごとの設定の例。

quarkus.log.handler.console.my-console-handler.format=%d{yyyy-MM-dd HH:mm:ss} [com.example] %s%e%n

quarkus.log.category."com.example".handlers=my-console-handler
quarkus.log.category."com.example".use-parent-handlers=false

設定の詳細については、コンソールロギング設定リファレンスを参照してください。

ファイルログハンドラー

アプリケーションのホスト上のファイルにイベントを記録するには、Quarkus ファイルログハンドラーを使用します。ファイルログハンドラーはデフォルトで無効になっているため、最初に有効にする必要があります。

Quarkus ファイルログハンドラーはログファイルのローテーションをサポートしています。

ログファイルのローテーションは、指定された数のバックアップファイルを保持しながら、プライマリログファイルを最新の状態かつ管理可能なサイズに保つことで、効率的なログ管理を可能にします。

グローバル設定の例。

quarkus.log.file.enabled=true
quarkus.log.file.path=application.log
quarkus.log.file.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n

カテゴリーごとの設定の例。

quarkus.log.handler.file.my-file-handler.enabled=true
quarkus.log.handler.file.my-file-handler.path=application.log
quarkus.log.handler.file.my-file-handler.format=%d{yyyy-MM-dd HH:mm:ss} [com.example] %s%e%n

quarkus.log.category."com.example".handlers=my-file-handler
quarkus.log.category."com.example".use-parent-handlers=false

設定の詳細については、ファイルロギング設定リファレンスを参照してください。

Syslog ログハンドラー

Quarkus の syslog ハンドラーは、UNIX ライクなシステムでログメッセージを送信するために使用される Syslog プロトコルに従います。これは RFC 5424 で定義されたプロトコルを使用します。

デフォルトでは、syslog ハンドラーは無効になっています。有効にすると、すべてのログイベントを syslog サーバー (通常はアプリケーションのローカル syslog サーバー) に送信します。

グローバル設定の例。

quarkus.log.syslog.enabled=true
quarkus.log.syslog.app-name=my-application
quarkus.log.syslog.format=%d{yyyy-MM-dd HH:mm:ss} %-5p [%c] (%t) %s%e%n

カテゴリーごとの設定の例。

quarkus.log.handler.syslog.my-syslog-handler.enabled=true
quarkus.log.handler.syslog.my-syslog-handler.app-name=my-application
quarkus.log.handler.syslog.my-syslog-handler.format=%d{yyyy-MM-dd HH:mm:ss} [com.example] %s%e%n

quarkus.log.category."com.example".handlers=my-syslog-handler
quarkus.log.category."com.example".use-parent-handlers=false

設定の詳細については、Syslog ロギング設定リファレンスを参照してください。

Socket ログハンドラー

このハンドラーはログをソケットに送信します。ソケットログハンドラーはデフォルトで無効になっています。使用するには有効にする必要があります。有効にすると、すべてのログイベントを Logstash サーバーなどのソケットに送信します。

グローバル設定の例。

quarkus.log.socket.enabled=true
quarkus.log.socket.endpoint=localhost:4560

通常、このハンドラーは quarkus-logging-json エクステンションと併用して、ECS フォーマットのログを Elasticsearch インスタンスに送信するために使用されます。設定例については、集中ログ管理ガイドを参照してください。

ログハンドラーへのロギングフィルターの追加

コンソールハンドラーなどのログハンドラーにフィルターをアタッチできます。フィルターは、ハンドラーが特定のログレコードを記録するかどうかを決定します。

ロギングフィルターを登録する方法。

java.util.logging.Filter を実装する final クラスに @io.quarkus.logging.LoggingFilter を付与し、name プロパティーを設定します。
フィルターの実装例。
```
package com.example;

import io.quarkus.logging.LoggingFilter;
import java.util.logging.Filter;
import java.util.logging.LogRecord;

@LoggingFilter(name = "my-filter")
public final class TestFilter implements Filter {

    private final String part;

    public TestFilter(@ConfigProperty(name = "my-filter.part") String part) {
        this.part = part;
    }

    @Override
    public boolean isLoggable(LogRecord record) {
        return !record.getMessage().contains(part);
    }
}
```
この例では、特定のテキストを含むログレコードをコンソールログから除外します。フィルタリングする特定のテキストはハードコードされず、代わりに my-filter.part 設定プロパティーから読み込まれます。
application.properties でのフィルター設定例。
```
my-filter.part=TEST
```
application.properties にある filter 設定プロパティーを使用して、対応するハンドラーにフィルターをアタッチします。
```
quarkus.log.console.filter=my-filter
```

ロギング設定の例

以下の例は、Quarkus でロギングを設定する方法を示しています。

Quarkus ログ (INFO) を除くコンソールの DEBUG ロギング、色なし、短縮された時刻、短縮されたカテゴリープレフィックス

quarkus.log.console.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
quarkus.log.console.level=DEBUG
quarkus.console.color=false

quarkus.log.category."io.quarkus".level=INFO

コマンドラインでこれらのプロパティーを追加する場合は、" がエスケープされていることを確認してください。例えば、-Dquarkus.log.category.\"io.quarkus\".level=DEBUG のようにします。

ファイル TRACE ロギング設定

quarkus.log.file.enabled=true
# Send output to a trace.log file under the /tmp directory
quarkus.log.file.path=/tmp/trace.log
quarkus.log.file.level=TRACE
quarkus.log.file.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
# Set 2 categories (io.quarkus.smallrye.jwt, io.undertow.request.security) to TRACE level
quarkus.log.min-level=TRACE
quarkus.log.category."io.quarkus.smallrye.jwt".level=TRACE
quarkus.log.category."io.undertow.request.security".level=TRACE

ルートロガーを変更していないため、コンソールログには INFO 以上のレベルのログのみが含まれます。

カテゴリーにアタッチされた名前付きハンドラー

# Send output to a trace.log file under the /tmp directory
quarkus.log.file.path=/tmp/trace.log
quarkus.log.console.format=%d{HH:mm:ss} %-5p [%c{2.}] (%t) %s%e%n
# Configure a named handler that logs to console
quarkus.log.handler.console."STRUCTURED_LOGGING".format=%e%n
# Configure a named handler that logs to file
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".enabled=true
quarkus.log.handler.file."STRUCTURED_LOGGING_FILE".format=%e%n
# Configure the category and link the two named handlers to it
quarkus.log.category."io.quarkus.category".level=INFO
quarkus.log.category."io.quarkus.category".handlers=STRUCTURED_LOGGING,STRUCTURED_LOGGING_FILE

ルートロガーにアタッチされた名前付きハンドラー

# configure a named file handler that sends the output to 'quarkus.log'
quarkus.log.handler.file.CONSOLE_MIRROR.enabled=true
quarkus.log.handler.file.CONSOLE_MIRROR.path=quarkus.log
# attach the handler to the root logger
quarkus.log.handlers=CONSOLE_MIRROR

集中ログ管理

一元化された場所を使用して、さまざまなコンポーネントやアプリケーションインスタンスからのログデータを効率的に収集、保存、分析します。

Graylog、Logstash、Fluentd などの集中管理ツールにログを送信するには、Quarkus 集中ログ管理ガイドを参照してください。

OpenTelemetry ログ

すべてのアペンダーから OpenTelemetry Logging へのログエントリ送信を有効にできます。

詳細は、Quarkus OpenTelemetry Logging ガイドを参照してください。

`@QuarkusTest` のロギング設定

@QuarkusTest でロギングを有効にするには、起動プロセスの早い段階で java.util.logging.manager システムプロパティーを org.jboss.logmanager.LogManager に設定する必要があります。そうしないと、ロギングが期待通りに動作しません。

ビルドツールで次のように設定します。

Maven の場合。

Maven Surefire プラグインの設定でプロパティーを設定します。

Maven Surefire プラグインの設定で java.util.logging.manager を設定します。

<build>
  <plugins>
    <plugin>
      <artifactId>maven-surefire-plugin</artifactId>
      <version>${surefire-plugin.version}</version>
      <configuration>
        <systemPropertyVariables>
          <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager> (1)
          <quarkus.log.level>DEBUG</quarkus.log.level> (2)
          <maven.home>${maven.home}</maven.home>
        </systemPropertyVariables>
      </configuration>
    </plugin>
  </plugins>
</build>

1	`org.jboss.logmanager.LogManager` が使用されていることを確認してください。
2	すべてのロギングカテゴリーに対してデバッグロギングを有効にします。

Gradle の場合。

build.gradle ファイルでプロパティーを設定します。

test {
    systemProperty "java.util.logging.manager", "org.jboss.logmanager.LogManager"
}

詳細については、「アプリケーションのテスト」ガイドの IDE からの @QuarkusTest の実行セクションを参照してください。

他のロギング API の使用

Quarkus はロギングを JBoss Logging ライブラリーに依存しています。依存関係が Apache Commons Logging、Log4j、SLF4J などの他のロギング API を使用している場合は、それらのライブラリーを除外し、JBoss Logging アダプターを使用してください。ネイティブビルドが以下のようなエラーで失敗する可能性があるため、この手順はネイティブ実行可能ファイルにとって特に重要です。

Caused by java.lang.ClassNotFoundException: org.apache.commons.logging.impl.LogFactoryImpl

ネイティブ実行可能ファイルには、それらの API 用のロギング実装が含まれていません。この問題を解決するには、JBoss Logging アダプターを使用してください。

次のセクションでは、一般的なオープンソースロギング API 用のアダプターについて説明します。

アプリケーションへのロギングアダプターの追加

JBoss Logging 以外のロギング API ごとにロギングアダプターライブラリーを追加して、それらの API を介して記録されたメッセージが JBoss Log Manager バックエンドにルーティングされるようにします。その後、追加されたライブラリーによって生成されたログが、他の Quarkus ログと同じフォーマットに従っているか確認できます。

エクステンションが自動的に処理を行う Quarkus エクステンションの依存関係であるライブラリーについては、この手順は不要です。

SLF4J

SLF4J アダプターは、以下の依存関係によって提供されます。

pom.xml

<dependency>
    <groupId>org.jboss.slf4j</groupId>
    <artifactId>slf4j-jboss-logmanager</artifactId>
</dependency>

build.gradle

implementation("org.jboss.slf4j:slf4j-jboss-logmanager")

Apache Commons Logging

Commons Logging アダプターは、以下の依存関係によって提供されます。

pom.xml

<dependency>
    <groupId>org.jboss.logging</groupId>
    <artifactId>commons-logging-jboss-logging</artifactId>
</dependency>

build.gradle

implementation("org.jboss.logging:commons-logging-jboss-logging")

Log4j 2

Log4j 2 アダプターは、以下の依存関係によって提供されます。

pom.xml

<dependency>
    <groupId>org.jboss.logmanager</groupId>
    <artifactId>log4j2-jboss-logmanager</artifactId>
</dependency>

build.gradle

implementation("org.jboss.logmanager:log4j2-jboss-logmanager")

log4j2-jboss-logmanager ライブラリーには Log4j をロギング実装として使用するために必要なものがすべて含まれているため、Log4j の依存関係を含めないでください。

Log4j

Log4j 1.x は Quarkus でサポートされなくなりました。

MDC を使用したコンテキストログ情報の追加

Quarkus は、リアクティブコアとの互換性を向上させるために、ロギングの Mapped Diagnostic Context (MDC) をオーバーライドします。

MDC データの追加と読み取り

MDC にデータを追加し、ログ出力でそれを抽出する方法。

MDC クラスを使用してデータを設定します。

import org.jboss.logmanager.MDC; を追加します。

以下の例に示すように MDC.put(…) を設定します。

JBoss Logging と io.quarkus.logging.Log を使用した例

package me.sample;

import io.quarkus.logging.Log;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.Path;
import org.jboss.logmanager.MDC;

import java.util.UUID;

@Path("/hello/jboss")
public class GreetingResourceJbossLogging {

    @GET
    @Path("/test")
    public String greeting() {
        MDC.put("request.id", UUID.randomUUID().toString());
        MDC.put("request.path", "/hello/test");
        Log.info("request received");
        return "hello world!";
    }
}

%X{mdc-key} を使用するようにログフォーマットを設定します。

quarkus.log.console.format=%d{HH:mm:ss} %-5p request.id=%X{request.id} request.path=%X{request.path} [%c{2.}] (%t) %s%n

生成されるメッセージには MDC データが含まれます。

08:48:13 INFO request.id=c37a3a36-b7f6-4492-83a1-de41dbc26fe2 request.path=/hello/test [me.sa.GreetingResourceJbossLogging] (executor-thread-1) request received

MDC とサポートされるロギング API

使用しているロギング API に基づいて、以下の MDC クラスのいずれかを使用します。

Log4j 1 - org.apache.log4j.MDC.put(key, value)
Log4j 2 - org.apache.logging.log4j.ThreadContext.put(key, value)
SLF4J - org.slf4j.MDC.put(key, value)

MDC の伝搬

Quarkus では、MDC プロバイダーにリアクティブコンテキストを処理するための特定の実装があり、リアクティブおよび非同期処理中に MDC データが確実に伝搬されるようになっています。

その結果、以下のような様々なシナリオで MDC データに引き続きアクセスできます。

REST クライアントが Uni を返す場合などの非同期呼び出しの後。
org.eclipse.microprofile.context.ManagedExecutor にサブミットされたコード内。
vertx.executeBlocking() で実行されるコード内。

該当する場合、Quarkus は MDC データを Vert.x の複製コンテキストに保存します。これにより、単一のタスクまたはリクエストの処理が分離されます。

ロギング設定リファレンス

ビルド時に固定される設定プロパティー - 他のすべての設定プロパティーは実行時にオーバーライド可能

Configuration property	タイプ	デフォルト
`quarkus.log.metrics.enabled` If enabled and a metrics extension is present, logging metrics are published. Environment variable: `QUARKUS_LOG_METRICS_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.min-level` The default minimum log level. Environment variable: `QUARKUS_LOG_MIN_LEVEL` Show more	Level	`DEBUG`
`quarkus.log.decorate-stacktraces` This will decorate the stacktrace in dev mode to show the line in the code that cause the exception Environment variable: `QUARKUS_LOG_DECORATE_STACKTRACES` Show more	ブーリアン	`true`
`quarkus.log.level` The log level of the root category, which is used as the default log level for all categories. JBoss Logging supports Apache-style log levels: `org.jboss.logmanager.Level#FATAL` `org.jboss.logmanager.Level#ERROR` `org.jboss.logmanager.Level#WARN` `org.jboss.logmanager.Level#INFO` `org.jboss.logmanager.Level#DEBUG` `org.jboss.logmanager.Level#TRACE` In addition, it also supports the standard JDK log levels. Environment variable: `QUARKUS_LOG_LEVEL` Show more	Level	`INFO`
`quarkus.log.handlers` The names of additional handlers to link to the root category. These handlers are defined in consoleHandlers, fileHandlers, or syslogHandlers. Environment variable: `QUARKUS_LOG_HANDLERS` Show more	文字列のリスト
Minimum logging categories	タイプ	デフォルト
`quarkus.log.category."categories".min-level` The minimum log level for this category. By default, all categories are configured with `DEBUG` minimum level. To get runtime logging below `DEBUG`, e.g., `TRACE`, adjust the minimum level at build time. The right log level needs to be provided at runtime. As an example, to get `TRACE` logging, minimum level needs to be at `TRACE`, and the runtime log level needs to match that. Environment variable: `QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL` Show more	InheritableLevel	`inherit`
`quarkus.log.category."categories".level` The log level for this category. Note that to get log levels below `INFO`, the minimum level build-time configuration option also needs to be adjusted. Environment variable: `QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL` Show more	InheritableLevel	`inherit`
`quarkus.log.category."categories".handlers` The names of the handlers to link to this category. Environment variable: `QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS` Show more	文字列のリスト
`quarkus.log.category."categories".use-parent-handlers` Specify whether this logger should send its output to its parent Logger Environment variable: `QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS` Show more	ブーリアン	`true`
Console logging	タイプ	デフォルト
`quarkus.log.console.enabled` If console logging should be enabled Environment variable: `QUARKUS_LOG_CONSOLE_ENABLED` Show more	ブーリアン	`true`
`quarkus.log.console.stderr` If console logging should go to `System#err` instead of `System#out`. Environment variable: `QUARKUS_LOG_CONSOLE_STDERR` Show more	ブーリアン	`false`
`quarkus.log.console.format` The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: `QUARKUS_LOG_CONSOLE_FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n`
`quarkus.log.console.level` The console log level. Environment variable: `QUARKUS_LOG_CONSOLE_LEVEL` Show more	Level	`ALL`
`quarkus.log.console.darken` Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: `QUARKUS_LOG_CONSOLE_DARKEN` Show more	int	`0`
`quarkus.log.console.filter` The name of the filter to link to the console handler. Environment variable: `QUARKUS_LOG_CONSOLE_FILTER` Show more	string
`quarkus.log.console.async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_CONSOLE_ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.console.async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.console.async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
File logging	タイプ	デフォルト
`quarkus.log.file.enabled` If file logging should be enabled Environment variable: `QUARKUS_LOG_FILE_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.file.format` The log format Environment variable: `QUARKUS_LOG_FILE_FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n`
`quarkus.log.file.level` The level of logs to be written into the file. Environment variable: `QUARKUS_LOG_FILE_LEVEL` Show more	Level	`ALL`
`quarkus.log.file.path` The name of the file in which logs will be written. Environment variable: `QUARKUS_LOG_FILE_PATH` Show more	File	`quarkus.log`
`quarkus.log.file.filter` The name of the filter to link to the file handler. Environment variable: `QUARKUS_LOG_FILE_FILTER` Show more	string
`quarkus.log.file.encoding` The character encoding used Environment variable: `QUARKUS_LOG_FILE_ENCODING` Show more	Charset
`quarkus.log.file.async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_FILE_ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.file.async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.file.async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_FILE_ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
`quarkus.log.file.rotation.enabled` Whether log rotation is enabled. Environment variable: `QUARKUS_LOG_FILE_ROTATION_ENABLED` Show more	ブーリアン	`true`
`quarkus.log.file.rotation.max-file-size` The maximum log file size, after which a rotation is executed, up to `Long.MAX_VALUE` bytes. Note that the file is rotated after the log record is written. Thus, this isn’t a hard maximum on the file size; rather, it’s a hard minimum on the size of the file before it is rotated. Environment variable: `QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE` Show more	MemorySize	`10M`
`quarkus.log.file.rotation.max-backup-index` The maximum number of backups to keep. Environment variable: `QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX` Show more	int	`5`
`quarkus.log.file.rotation.file-suffix` The file handler rotation file suffix. When used, the file will be rotated based on its suffix. The suffix must be in a date-time format that is understood by `DateTimeFormatter`. Example fileSuffix: .yyyy-MM-dd Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. Environment variable: `QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX` Show more	string
`quarkus.log.file.rotation.rotate-on-boot` Indicates whether to rotate log files on server initialization. You need to either set a `max-file-size` or configure a `file-suffix` for it to work. Environment variable: `QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT` Show more	ブーリアン	`true`
Syslog logging	タイプ	デフォルト
`quarkus.log.syslog.enabled` If syslog logging should be enabled Environment variable: `QUARKUS_LOG_SYSLOG_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.syslog.endpoint` The IP address and port of the Syslog server Environment variable: `QUARKUS_LOG_SYSLOG_ENDPOINT` Show more	host:port	`localhost:514`
`quarkus.log.syslog.app-name` The app name used when formatting the message in RFC5424 format Environment variable: `QUARKUS_LOG_SYSLOG_APP_NAME` Show more	string
`quarkus.log.syslog.hostname` The name of the host the messages are being sent from Environment variable: `QUARKUS_LOG_SYSLOG_HOSTNAME` Show more	string
`quarkus.log.syslog.facility` Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 Environment variable: `QUARKUS_LOG_SYSLOG_FACILITY` Show more	`kernel`, `user-level`, `mail-system`, `system-daemons`, `security`, `syslogd`, `line-printer`, `network-news`, `uucp`, `clock-daemon`, `security2`, `ftp-daemon`, `ntp`, `log-audit`, `log-alert`, `clock-daemon2`, `local-use-0`, `local-use-1`, `local-use-2`, `local-use-3`, `local-use-4`, `local-use-5`, `local-use-6`, `local-use-7`	`user-level`
`quarkus.log.syslog.syslog-type` Set the `SyslogType syslog type` this handler should use to format the message sent Environment variable: `QUARKUS_LOG_SYSLOG_SYSLOG_TYPE` Show more	`rfc5424`, `rfc3164`	`rfc5424`
`quarkus.log.syslog.protocol` Sets the protocol used to connect to the Syslog server Environment variable: `QUARKUS_LOG_SYSLOG_PROTOCOL` Show more	`tcp`, `udp`, `ssl-tcp`	`tcp`
`quarkus.log.syslog.use-counting-framing` If enabled, the message being sent is prefixed with the size of the message Environment variable: `QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING` Show more	`true`, `false`, `protocol-dependent`	`protocol-dependent`
`quarkus.log.syslog.truncate` Set to `true` to truncate the message if it exceeds maximum length Environment variable: `QUARKUS_LOG_SYSLOG_TRUNCATE` Show more	ブーリアン	`true`
`quarkus.log.syslog.block-on-reconnect` Enables or disables blocking when attempting to reconnect a `Protocol#TCP TCP` or `Protocol#SSL_TCP SSL TCP` protocol Environment variable: `QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT` Show more	ブーリアン	`false`
`quarkus.log.syslog.format` The log message format Environment variable: `QUARKUS_LOG_SYSLOG_FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n`
`quarkus.log.syslog.level` The log level specifying what message levels will be logged by the Syslog logger Environment variable: `QUARKUS_LOG_SYSLOG_LEVEL` Show more	Level	`ALL`
`quarkus.log.syslog.filter` The name of the filter to link to the file handler. Environment variable: `QUARKUS_LOG_SYSLOG_FILTER` Show more	string
`quarkus.log.syslog.max-length` The maximum length, in bytes, of the message allowed to be sent, up to `Integer.MAX_VALUE` bytes. The length includes the header and the message. If not set, the default value is `2048` when `sys-log-type` is `rfc5424` (which is the default) and `1024` when `sys-log-type` is `rfc3164` Environment variable: `QUARKUS_LOG_SYSLOG_MAX_LENGTH` Show more	MemorySize
`quarkus.log.syslog.async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_SYSLOG_ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.syslog.async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.syslog.async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
Socket logging	タイプ	デフォルト
`quarkus.log.socket.enabled` If socket logging should be enabled Environment variable: `QUARKUS_LOG_SOCKET_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.socket.endpoint` The IP address and port of the server receiving the logs Environment variable: `QUARKUS_LOG_SOCKET_ENDPOINT` Show more	host:port	`localhost:4560`
`quarkus.log.socket.protocol` Sets the protocol used to connect to the syslog server Environment variable: `QUARKUS_LOG_SOCKET_PROTOCOL` Show more	`tcp`, `udp`, `ssl-tcp`	`tcp`
`quarkus.log.socket.block-on-reconnect` Enables or disables blocking when attempting to reconnect a `Protocol#TCP TCP` or `Protocol#SSL_TCP SSL TCP` protocol Environment variable: `QUARKUS_LOG_SOCKET_BLOCK_ON_RECONNECT` Show more	ブーリアン	`false`
`quarkus.log.socket.format` The log message format Environment variable: `QUARKUS_LOG_SOCKET_FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n`
`quarkus.log.socket.level` The log level specifying, which message levels will be logged by socket logger Environment variable: `QUARKUS_LOG_SOCKET_LEVEL` Show more	Level	`ALL`
`quarkus.log.socket.filter` The name of the filter to link to the file handler. Environment variable: `QUARKUS_LOG_SOCKET_FILTER` Show more	string
`quarkus.log.socket.async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_SOCKET_ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.socket.async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_SOCKET_ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.socket.async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_SOCKET_ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
Console handlers	タイプ	デフォルト
`quarkus.log.handler.console."console-handlers".enabled` If console logging should be enabled Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLED` Show more	ブーリアン	`true`
`quarkus.log.handler.console."console-handlers".stderr` If console logging should go to `System#err` instead of `System#out`. Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR` Show more	ブーリアン	`false`
`quarkus.log.handler.console."console-handlers".format` The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n`
`quarkus.log.handler.console."console-handlers".level` The console log level. Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL` Show more	Level	`ALL`
`quarkus.log.handler.console."console-handlers".darken` Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension). Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN` Show more	int	`0`
`quarkus.log.handler.console."console-handlers".filter` The name of the filter to link to the console handler. Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER` Show more	string
`quarkus.log.handler.console."console-handlers".async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.handler.console."console-handlers".async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.handler.console."console-handlers".async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
File handlers	タイプ	デフォルト
`quarkus.log.handler.file."file-handlers".enabled` If file logging should be enabled Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLED` Show more	ブーリアン	`false`
`quarkus.log.handler.file."file-handlers".format` The log format Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n`
`quarkus.log.handler.file."file-handlers".level` The level of logs to be written into the file. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL` Show more	Level	`ALL`
`quarkus.log.handler.file."file-handlers".path` The name of the file in which logs will be written. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH` Show more	File	`quarkus.log`
`quarkus.log.handler.file."file-handlers".filter` The name of the filter to link to the file handler. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER` Show more	string
`quarkus.log.handler.file."file-handlers".encoding` The character encoding used Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING` Show more	Charset
`quarkus.log.handler.file."file-handlers".async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.handler.file."file-handlers".async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.handler.file."file-handlers".async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
`quarkus.log.handler.file."file-handlers".rotation.enabled` Whether log rotation is enabled. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ENABLED` Show more	ブーリアン	`true`
`quarkus.log.handler.file."file-handlers".rotation.max-file-size` The maximum log file size, after which a rotation is executed, up to `Long.MAX_VALUE` bytes. Note that the file is rotated after the log record is written. Thus, this isn’t a hard maximum on the file size; rather, it’s a hard minimum on the size of the file before it is rotated. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE` Show more	MemorySize	`10M`
`quarkus.log.handler.file."file-handlers".rotation.max-backup-index` The maximum number of backups to keep. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX` Show more	int	`5`
`quarkus.log.handler.file."file-handlers".rotation.file-suffix` The file handler rotation file suffix. When used, the file will be rotated based on its suffix. The suffix must be in a date-time format that is understood by `DateTimeFormatter`. Example fileSuffix: .yyyy-MM-dd Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX` Show more	string
`quarkus.log.handler.file."file-handlers".rotation.rotate-on-boot` Indicates whether to rotate log files on server initialization. You need to either set a `max-file-size` or configure a `file-suffix` for it to work. Environment variable: `QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT` Show more	ブーリアン	`true`
Syslog handlers	タイプ	デフォルト
`quarkus.log.handler.syslog."syslog-handlers".enabled` If syslog logging should be enabled Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLED` Show more	ブーリアン	`false`
`quarkus.log.handler.syslog."syslog-handlers".endpoint` The IP address and port of the Syslog server Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT` Show more	host:port	`localhost:514`
`quarkus.log.handler.syslog."syslog-handlers".app-name` The app name used when formatting the message in RFC5424 format Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME` Show more	string
`quarkus.log.handler.syslog."syslog-handlers".hostname` The name of the host the messages are being sent from Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME` Show more	string
`quarkus.log.handler.syslog."syslog-handlers".facility` Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164 Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FACILITY` Show more	`kernel`, `user-level`, `mail-system`, `system-daemons`, `security`, `syslogd`, `line-printer`, `network-news`, `uucp`, `clock-daemon`, `security2`, `ftp-daemon`, `ntp`, `log-audit`, `log-alert`, `clock-daemon2`, `local-use-0`, `local-use-1`, `local-use-2`, `local-use-3`, `local-use-4`, `local-use-5`, `local-use-6`, `local-use-7`	`user-level`
`quarkus.log.handler.syslog."syslog-handlers".syslog-type` Set the `SyslogType syslog type` this handler should use to format the message sent Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE` Show more	`rfc5424`, `rfc3164`	`rfc5424`
`quarkus.log.handler.syslog."syslog-handlers".protocol` Sets the protocol used to connect to the Syslog server Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL` Show more	`tcp`, `udp`, `ssl-tcp`	`tcp`
`quarkus.log.handler.syslog."syslog-handlers".use-counting-framing` If enabled, the message being sent is prefixed with the size of the message Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING` Show more	`true`, `false`, `protocol-dependent`	`protocol-dependent`
`quarkus.log.handler.syslog."syslog-handlers".truncate` Set to `true` to truncate the message if it exceeds maximum length Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE` Show more	ブーリアン	`true`
`quarkus.log.handler.syslog."syslog-handlers".block-on-reconnect` Enables or disables blocking when attempting to reconnect a `Protocol#TCP TCP` or `Protocol#SSL_TCP SSL TCP` protocol Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT` Show more	ブーリアン	`false`
`quarkus.log.handler.syslog."syslog-handlers".format` The log message format Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n`
`quarkus.log.handler.syslog."syslog-handlers".level` The log level specifying what message levels will be logged by the Syslog logger Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL` Show more	Level	`ALL`
`quarkus.log.handler.syslog."syslog-handlers".filter` The name of the filter to link to the file handler. Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER` Show more	string
`quarkus.log.handler.syslog."syslog-handlers".max-length` The maximum length, in bytes, of the message allowed to be sent, up to `Integer.MAX_VALUE` bytes. The length includes the header and the message. If not set, the default value is `2048` when `sys-log-type` is `rfc5424` (which is the default) and `1024` when `sys-log-type` is `rfc3164` Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH` Show more	MemorySize
`quarkus.log.handler.syslog."syslog-handlers".async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.handler.syslog."syslog-handlers".async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.handler.syslog."syslog-handlers".async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
Socket handlers	タイプ	デフォルト
`quarkus.log.handler.socket."socket-handlers".enabled` If socket logging should be enabled Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ENABLED` Show more	ブーリアン	`false`
`quarkus.log.handler.socket."socket-handlers".endpoint` The IP address and port of the server receiving the logs Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ENDPOINT` Show more	host:port	`localhost:4560`
`quarkus.log.handler.socket."socket-handlers".protocol` Sets the protocol used to connect to the syslog server Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__PROTOCOL` Show more	`tcp`, `udp`, `ssl-tcp`	`tcp`
`quarkus.log.handler.socket."socket-handlers".block-on-reconnect` Enables or disables blocking when attempting to reconnect a `Protocol#TCP TCP` or `Protocol#SSL_TCP SSL TCP` protocol Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__BLOCK_ON_RECONNECT` Show more	ブーリアン	`false`
`quarkus.log.handler.socket."socket-handlers".format` The log message format Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__FORMAT` Show more	string	`%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n`
`quarkus.log.handler.socket."socket-handlers".level` The log level specifying, which message levels will be logged by socket logger Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__LEVEL` Show more	Level	`ALL`
`quarkus.log.handler.socket."socket-handlers".filter` The name of the filter to link to the file handler. Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__FILTER` Show more	string
`quarkus.log.handler.socket."socket-handlers".async.enabled` Whether to log asynchronously Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ASYNC_ENABLED` Show more	ブーリアン	`false`
`quarkus.log.handler.socket."socket-handlers".async.queue-length` The queue length to use before flushing writing Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ASYNC_QUEUE_LENGTH` Show more	int	`512`
`quarkus.log.handler.socket."socket-handlers".async.overflow` Determine whether to block the publisher (rather than drop the message) when the queue is full Environment variable: `QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ASYNC_OVERFLOW` Show more	`block`, `discard`	`block`
Log cleanup filters - internal use	タイプ	デフォルト
`quarkus.log.filter."filters".if-starts-with` The message prefix to match Environment variable: `QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH` Show more	文字列のリスト	`inherit`
`quarkus.log.filter."filters".target-level` The new log level for the filtered message. Defaults to DEBUG. Environment variable: `QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL` Show more	Level	`DEBUG`

Configuration property

タイプ

デフォルト

quarkus.log.metrics.enabled

If enabled and a metrics extension is present, logging metrics are published.

Environment variable: QUARKUS_LOG_METRICS_ENABLED

ブーリアン

false

quarkus.log.min-level

The default minimum log level.

Environment variable: QUARKUS_LOG_MIN_LEVEL

Level

DEBUG

quarkus.log.decorate-stacktraces

This will decorate the stacktrace in dev mode to show the line in the code that cause the exception

Environment variable: QUARKUS_LOG_DECORATE_STACKTRACES

ブーリアン

true

quarkus.log.level

The log level of the root category, which is used as the default log level for all categories.

JBoss Logging supports Apache-style log levels:

org.jboss.logmanager.Level#FATAL
org.jboss.logmanager.Level#ERROR
org.jboss.logmanager.Level#WARN
org.jboss.logmanager.Level#INFO
org.jboss.logmanager.Level#DEBUG
org.jboss.logmanager.Level#TRACE

In addition, it also supports the standard JDK log levels.

Environment variable: QUARKUS_LOG_LEVEL

Level

INFO

quarkus.log.handlers

The names of additional handlers to link to the root category. These handlers are defined in consoleHandlers, fileHandlers, or syslogHandlers.

Environment variable: QUARKUS_LOG_HANDLERS

文字列のリスト

Minimum logging categories

タイプ

デフォルト

quarkus.log.category."categories".min-level

The minimum log level for this category. By default, all categories are configured with DEBUG minimum level.

To get runtime logging below DEBUG, e.g., TRACE, adjust the minimum level at build time. The right log level needs to be provided at runtime.

As an example, to get TRACE logging, minimum level needs to be at TRACE, and the runtime log level needs to match that.

Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL

InheritableLevel

inherit

quarkus.log.category."categories".level

The log level for this category.

Note that to get log levels below INFO, the minimum level build-time configuration option also needs to be adjusted.

Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL

InheritableLevel

inherit

quarkus.log.category."categories".handlers

The names of the handlers to link to this category.

Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS

文字列のリスト

quarkus.log.category."categories".use-parent-handlers

Specify whether this logger should send its output to its parent Logger

Environment variable: QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS

ブーリアン

true

Console logging

タイプ

デフォルト

quarkus.log.console.enabled

If console logging should be enabled

Environment variable: QUARKUS_LOG_CONSOLE_ENABLED

ブーリアン

true

quarkus.log.console.stderr

If console logging should go to System#err instead of System#out.

Environment variable: QUARKUS_LOG_CONSOLE_STDERR

ブーリアン

false

quarkus.log.console.format

The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).

Environment variable: QUARKUS_LOG_CONSOLE_FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

quarkus.log.console.level

The console log level.

Environment variable: QUARKUS_LOG_CONSOLE_LEVEL

Level

ALL

quarkus.log.console.darken

Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).

Environment variable: QUARKUS_LOG_CONSOLE_DARKEN

int

0

quarkus.log.console.filter

The name of the filter to link to the console handler.

Environment variable: QUARKUS_LOG_CONSOLE_FILTER

string

quarkus.log.console.async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_CONSOLE_ASYNC_ENABLED

ブーリアン

false

quarkus.log.console.async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH

int

512

quarkus.log.console.async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW

block, discard

block

File logging

タイプ

デフォルト

quarkus.log.file.enabled

If file logging should be enabled

Environment variable: QUARKUS_LOG_FILE_ENABLED

ブーリアン

false

quarkus.log.file.format

The log format

Environment variable: QUARKUS_LOG_FILE_FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n

quarkus.log.file.level

The level of logs to be written into the file.

Environment variable: QUARKUS_LOG_FILE_LEVEL

Level

ALL

quarkus.log.file.path

The name of the file in which logs will be written.

Environment variable: QUARKUS_LOG_FILE_PATH

File

quarkus.log

quarkus.log.file.filter

The name of the filter to link to the file handler.

Environment variable: QUARKUS_LOG_FILE_FILTER

string

quarkus.log.file.encoding

The character encoding used

Environment variable: QUARKUS_LOG_FILE_ENCODING

Charset

quarkus.log.file.async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_FILE_ASYNC_ENABLED

ブーリアン

false

quarkus.log.file.async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH

int

512

quarkus.log.file.async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_FILE_ASYNC_OVERFLOW

block, discard

block

quarkus.log.file.rotation.enabled

Whether log rotation is enabled.

Environment variable: QUARKUS_LOG_FILE_ROTATION_ENABLED

ブーリアン

true

quarkus.log.file.rotation.max-file-size

The maximum log file size, after which a rotation is executed, up to Long.MAX_VALUE bytes. Note that the file is rotated after the log record is written. Thus, this isn’t a hard maximum on the file size; rather, it’s a hard minimum on the size of the file before it is rotated.

Environment variable: QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE

MemorySize

10M

quarkus.log.file.rotation.max-backup-index

The maximum number of backups to keep.

Environment variable: QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX

int

5

quarkus.log.file.rotation.file-suffix

The file handler rotation file suffix. When used, the file will be rotated based on its suffix.

The suffix must be in a date-time format that is understood by DateTimeFormatter.

Example fileSuffix: .yyyy-MM-dd

Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed.

Environment variable: QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX

string

quarkus.log.file.rotation.rotate-on-boot

Indicates whether to rotate log files on server initialization.

You need to either set a max-file-size or configure a file-suffix for it to work.

Environment variable: QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT

ブーリアン

true

Syslog logging

タイプ

デフォルト

quarkus.log.syslog.enabled

If syslog logging should be enabled

Environment variable: QUARKUS_LOG_SYSLOG_ENABLED

ブーリアン

false

quarkus.log.syslog.endpoint

The IP address and port of the Syslog server

Environment variable: QUARKUS_LOG_SYSLOG_ENDPOINT

host:port

localhost:514

quarkus.log.syslog.app-name

The app name used when formatting the message in RFC5424 format

Environment variable: QUARKUS_LOG_SYSLOG_APP_NAME

string

quarkus.log.syslog.hostname

The name of the host the messages are being sent from

Environment variable: QUARKUS_LOG_SYSLOG_HOSTNAME

string

quarkus.log.syslog.facility

Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164

Environment variable: QUARKUS_LOG_SYSLOG_FACILITY

kernel, user-level, mail-system, system-daemons, security, syslogd, line-printer, network-news, uucp, clock-daemon, security2, ftp-daemon, ntp, log-audit, log-alert, clock-daemon2, local-use-0, local-use-1, local-use-2, local-use-3, local-use-4, local-use-5, local-use-6, local-use-7

user-level

quarkus.log.syslog.syslog-type

Set the SyslogType syslog type this handler should use to format the message sent

Environment variable: QUARKUS_LOG_SYSLOG_SYSLOG_TYPE

rfc5424, rfc3164

rfc5424

quarkus.log.syslog.protocol

Sets the protocol used to connect to the Syslog server

Environment variable: QUARKUS_LOG_SYSLOG_PROTOCOL

tcp, udp, ssl-tcp

tcp

quarkus.log.syslog.use-counting-framing

If enabled, the message being sent is prefixed with the size of the message

Environment variable: QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING

true, false, protocol-dependent

protocol-dependent

quarkus.log.syslog.truncate

Set to true to truncate the message if it exceeds maximum length

Environment variable: QUARKUS_LOG_SYSLOG_TRUNCATE

ブーリアン

true

quarkus.log.syslog.block-on-reconnect

Enables or disables blocking when attempting to reconnect a Protocol#TCP TCP or Protocol#SSL_TCP SSL TCP protocol

Environment variable: QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT

ブーリアン

false

quarkus.log.syslog.format

The log message format

Environment variable: QUARKUS_LOG_SYSLOG_FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

quarkus.log.syslog.level

The log level specifying what message levels will be logged by the Syslog logger

Environment variable: QUARKUS_LOG_SYSLOG_LEVEL

Level

ALL

quarkus.log.syslog.filter

The name of the filter to link to the file handler.

Environment variable: QUARKUS_LOG_SYSLOG_FILTER

string

quarkus.log.syslog.max-length

The maximum length, in bytes, of the message allowed to be sent, up to Integer.MAX_VALUE bytes. The length includes the header and the message.

If not set, the default value is 2048 when sys-log-type is rfc5424 (which is the default) and 1024 when sys-log-type is rfc3164

Environment variable: QUARKUS_LOG_SYSLOG_MAX_LENGTH

MemorySize

quarkus.log.syslog.async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_SYSLOG_ASYNC_ENABLED

ブーリアン

false

quarkus.log.syslog.async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH

int

512

quarkus.log.syslog.async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW

block, discard

block

Socket logging

タイプ

デフォルト

quarkus.log.socket.enabled

If socket logging should be enabled

Environment variable: QUARKUS_LOG_SOCKET_ENABLED

ブーリアン

false

quarkus.log.socket.endpoint

The IP address and port of the server receiving the logs

Environment variable: QUARKUS_LOG_SOCKET_ENDPOINT

host:port

localhost:4560

quarkus.log.socket.protocol

Sets the protocol used to connect to the syslog server

Environment variable: QUARKUS_LOG_SOCKET_PROTOCOL

tcp, udp, ssl-tcp

tcp

quarkus.log.socket.block-on-reconnect

Enables or disables blocking when attempting to reconnect a Protocol#TCP TCP or Protocol#SSL_TCP SSL TCP protocol

Environment variable: QUARKUS_LOG_SOCKET_BLOCK_ON_RECONNECT

ブーリアン

false

quarkus.log.socket.format

The log message format

Environment variable: QUARKUS_LOG_SOCKET_FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

quarkus.log.socket.level

The log level specifying, which message levels will be logged by socket logger

Environment variable: QUARKUS_LOG_SOCKET_LEVEL

Level

ALL

quarkus.log.socket.filter

The name of the filter to link to the file handler.

Environment variable: QUARKUS_LOG_SOCKET_FILTER

string

quarkus.log.socket.async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_SOCKET_ASYNC_ENABLED

ブーリアン

false

quarkus.log.socket.async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_SOCKET_ASYNC_QUEUE_LENGTH

int

512

quarkus.log.socket.async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_SOCKET_ASYNC_OVERFLOW

block, discard

block

Console handlers

タイプ

デフォルト

quarkus.log.handler.console."console-handlers".enabled

If console logging should be enabled

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLED

ブーリアン

true

quarkus.log.handler.console."console-handlers".stderr

If console logging should go to System#err instead of System#out.

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR

ブーリアン

false

quarkus.log.handler.console."console-handlers".format

The log format. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

quarkus.log.handler.console."console-handlers".level

The console log level.

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL

Level

ALL

quarkus.log.handler.console."console-handlers".darken

Specify how much the colors should be darkened. Note that this value is ignored if an extension is present that takes control of console formatting (e.g., an XML or JSON-format extension).

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN

int

0

quarkus.log.handler.console."console-handlers".filter

The name of the filter to link to the console handler.

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER

string

quarkus.log.handler.console."console-handlers".async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_ENABLED

ブーリアン

false

quarkus.log.handler.console."console-handlers".async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH

int

512

quarkus.log.handler.console."console-handlers".async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW

block, discard

block

File handlers

タイプ

デフォルト

quarkus.log.handler.file."file-handlers".enabled

If file logging should be enabled

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLED

ブーリアン

false

quarkus.log.handler.file."file-handlers".format

The log format

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %h %N[%i] %-5p [%c{3.}] (%t) %s%e%n

quarkus.log.handler.file."file-handlers".level

The level of logs to be written into the file.

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL

Level

ALL

quarkus.log.handler.file."file-handlers".path

The name of the file in which logs will be written.

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH

File

quarkus.log

quarkus.log.handler.file."file-handlers".filter

The name of the filter to link to the file handler.

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER

string

quarkus.log.handler.file."file-handlers".encoding

The character encoding used

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING

Charset

quarkus.log.handler.file."file-handlers".async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_ENABLED

ブーリアン

false

quarkus.log.handler.file."file-handlers".async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH

int

512

quarkus.log.handler.file."file-handlers".async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW

block, discard

block

quarkus.log.handler.file."file-handlers".rotation.enabled

Whether log rotation is enabled.

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ENABLED

ブーリアン

true

quarkus.log.handler.file."file-handlers".rotation.max-file-size

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE

MemorySize

10M

quarkus.log.handler.file."file-handlers".rotation.max-backup-index

The maximum number of backups to keep.

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX

int

5

quarkus.log.handler.file."file-handlers".rotation.file-suffix

The file handler rotation file suffix. When used, the file will be rotated based on its suffix.

The suffix must be in a date-time format that is understood by DateTimeFormatter.

Example fileSuffix: .yyyy-MM-dd

Note: If the suffix ends with .zip or .gz, the rotation file will also be compressed.

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX

string

quarkus.log.handler.file."file-handlers".rotation.rotate-on-boot

Indicates whether to rotate log files on server initialization.

You need to either set a max-file-size or configure a file-suffix for it to work.

Environment variable: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT

ブーリアン

true

Syslog handlers

タイプ

デフォルト

quarkus.log.handler.syslog."syslog-handlers".enabled

If syslog logging should be enabled

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLED

ブーリアン

false

quarkus.log.handler.syslog."syslog-handlers".endpoint

The IP address and port of the Syslog server

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT

host:port

localhost:514

quarkus.log.handler.syslog."syslog-handlers".app-name

The app name used when formatting the message in RFC5424 format

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME

string

quarkus.log.handler.syslog."syslog-handlers".hostname

The name of the host the messages are being sent from

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME

string

quarkus.log.handler.syslog."syslog-handlers".facility

Sets the facility used when calculating the priority of the message as defined by RFC-5424 and RFC-3164

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FACILITY

user-level

quarkus.log.handler.syslog."syslog-handlers".syslog-type

Set the SyslogType syslog type this handler should use to format the message sent

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE

rfc5424, rfc3164

rfc5424

quarkus.log.handler.syslog."syslog-handlers".protocol

Sets the protocol used to connect to the Syslog server

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL

tcp, udp, ssl-tcp

tcp

quarkus.log.handler.syslog."syslog-handlers".use-counting-framing

If enabled, the message being sent is prefixed with the size of the message

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING

true, false, protocol-dependent

protocol-dependent

quarkus.log.handler.syslog."syslog-handlers".truncate

Set to true to truncate the message if it exceeds maximum length

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE

ブーリアン

true

quarkus.log.handler.syslog."syslog-handlers".block-on-reconnect

Enables or disables blocking when attempting to reconnect a Protocol#TCP TCP or Protocol#SSL_TCP SSL TCP protocol

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT

ブーリアン

false

quarkus.log.handler.syslog."syslog-handlers".format

The log message format

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

quarkus.log.handler.syslog."syslog-handlers".level

The log level specifying what message levels will be logged by the Syslog logger

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL

Level

ALL

quarkus.log.handler.syslog."syslog-handlers".filter

The name of the filter to link to the file handler.

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER

string

quarkus.log.handler.syslog."syslog-handlers".max-length

The maximum length, in bytes, of the message allowed to be sent, up to Integer.MAX_VALUE bytes. The length includes the header and the message.

If not set, the default value is 2048 when sys-log-type is rfc5424 (which is the default) and 1024 when sys-log-type is rfc3164

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH

MemorySize

quarkus.log.handler.syslog."syslog-handlers".async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_ENABLED

ブーリアン

false

quarkus.log.handler.syslog."syslog-handlers".async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH

int

512

quarkus.log.handler.syslog."syslog-handlers".async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW

block, discard

block

Socket handlers

タイプ

デフォルト

quarkus.log.handler.socket."socket-handlers".enabled

If socket logging should be enabled

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ENABLED

ブーリアン

false

quarkus.log.handler.socket."socket-handlers".endpoint

The IP address and port of the server receiving the logs

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ENDPOINT

host:port

localhost:4560

quarkus.log.handler.socket."socket-handlers".protocol

Sets the protocol used to connect to the syslog server

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__PROTOCOL

tcp, udp, ssl-tcp

tcp

quarkus.log.handler.socket."socket-handlers".block-on-reconnect

Enables or disables blocking when attempting to reconnect a Protocol#TCP TCP or Protocol#SSL_TCP SSL TCP protocol

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__BLOCK_ON_RECONNECT

ブーリアン

false

quarkus.log.handler.socket."socket-handlers".format

The log message format

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__FORMAT

string

%d{yyyy-MM-dd HH:mm:ss,SSS} %-5p [%c] (%t) %s%e%n

quarkus.log.handler.socket."socket-handlers".level

The log level specifying, which message levels will be logged by socket logger

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__LEVEL

Level

ALL

quarkus.log.handler.socket."socket-handlers".filter

The name of the filter to link to the file handler.

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__FILTER

string

quarkus.log.handler.socket."socket-handlers".async.enabled

Whether to log asynchronously

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ASYNC_ENABLED

ブーリアン

false

quarkus.log.handler.socket."socket-handlers".async.queue-length

The queue length to use before flushing writing

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ASYNC_QUEUE_LENGTH

int

512

quarkus.log.handler.socket."socket-handlers".async.overflow

Determine whether to block the publisher (rather than drop the message) when the queue is full

Environment variable: QUARKUS_LOG_HANDLER_SOCKET__SOCKET_HANDLERS__ASYNC_OVERFLOW

block, discard

block

Log cleanup filters - internal use

タイプ

デフォルト

quarkus.log.filter."filters".if-starts-with

The message prefix to match

Environment variable: QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH

文字列のリスト

inherit

quarkus.log.filter."filters".target-level

The new log level for the filtered message. Defaults to DEBUG.

Environment variable: QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL

Level

DEBUG

MemorySizeフォーマットについて

A size configuration option recognizes strings in this format (shown as a regular expression): [0-9]+[KkMmGgTtPpEeZzYy]?.

If no suffix is given, assume bytes.

1. 一部のエクステンションでは、デフォルトでログノイズを減らすために、特定のカテゴリーに対してカスタマイズされたデフォルトのログレベルが定義される場合があります。設定でログレベルを指定すると、エクステンションで定義されたログレベルはすべて上書きされます。

2. デフォルトでは、設定されたカテゴリーにはルートロガーと同じハンドラーがアタッチされます。

3. 呼び出し元情報を調べるフォーマットシーケンスは、パフォーマンスに影響を与える可能性があります。

アプリケーションロギングへの JBoss Logging の使用
アプリケーションロガーの取得
ログレベルの使用
ログレベル、カテゴリー、フォーマットの設定
- ロギングカテゴリー
- ルートロガーの設定
ロギングフォーマット
- 人間が読めるテキスト
- JSON ログフォーマット
  - 設定
ログハンドラー
ログハンドラーへのロギングフィルターの追加
ロギング設定の例
集中ログ管理
- OpenTelemetry ログ
@QuarkusTest のロギング設定
他のロギング API の使用
- アプリケーションへのロギングアダプターの追加
- MDC を使用したコンテキストログ情報の追加
ロギング設定リファレンス

ロギング設定

アプリケーションロギングへの JBoss Logging の使用

アプリケーションロガーの取得

ロガーフィールドの宣言

簡易ロギング

設定されたロガーの注入

ログレベルの使用

ログレベル、カテゴリー、フォーマットの設定

ロギングカテゴリー

ルートロガーの設定

ロギングフォーマット

人間が読めるテキスト

JSON ログフォーマット

設定

ログハンドラー

コンソールログハンドラー

ファイルログハンドラー

Syslog ログハンドラー

Socket ログハンドラー

ログハンドラーへのロギングフィルターの追加

ロギング設定の例

集中ログ管理

OpenTelemetry ログ

`@QuarkusTest` のロギング設定

他のロギング API の使用

アプリケーションへのロギングアダプターの追加

SLF4J

Apache Commons Logging

Log4j 2

Log4j

MDC を使用したコンテキストログ情報の追加

MDC データの追加と読み取り

MDC とサポートされるロギング API

MDC の伝搬

ロギング設定リファレンス

関連コンテンツ

同じトピックについて

ロギング設定

アプリケーションロギングへの JBoss Logging の使用

アプリケーションロガーの取得

ロガーフィールドの宣言

簡易ロギング

設定されたロガーの注入

ログレベルの使用

ログレベル、カテゴリー、フォーマットの設定

ロギングカテゴリー

ルートロガーの設定

ロギングフォーマット

人間が読めるテキスト

JSON ログフォーマット

設定

ログハンドラー

コンソールログハンドラー

ファイルログハンドラー

Syslog ログハンドラー

Socket ログハンドラー

ログハンドラーへのロギングフィルターの追加

ロギング設定の例

集中ログ管理

OpenTelemetry ログ

@QuarkusTest のロギング設定

他のロギング API の使用

アプリケーションへのロギングアダプターの追加

SLF4J

Apache Commons Logging

Log4j 2

Log4j

MDC を使用したコンテキストログ情報の追加

MDC データの追加と読み取り

MDC とサポートされるロギング API

MDC の伝搬

ロギング設定リファレンス

関連コンテンツ

同じトピックについて

`@QuarkusTest` のロギング設定