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

設定プロパティー

型

デフォルト

quarkus.log.metrics.enabled

これが有効で、かつメトリクスエクステンションが存在する場合、ロギングメトリクスが公開されます。

環境変数: QUARKUS_LOG_METRICS_ENABLED

boolean

false

quarkus.log.min-level

デフォルトの最小ログレベル。

環境変数: QUAARKUS_LOG_MIN_LEVEL

レベル

DEBUG

quarkus.log.decorate-stacktraces

これにより、開発モードでスタックトレースがデコレートされ、例外の原因となったコード行が表示されます。

環境変数: QUARKUS_LOG_DECORATE_STACKTRACES

boolean

true

quarkus.log.level

ルートカテゴリーのログレベル。すべてのカテゴリーのデフォルトログレベルとして使用されます。

JBoss Logging は、Apache スタイルのログレベルをサポートします。

標準の JDK ログレベルもサポートします。

環境変数: QUARKUS_LOG_LEVEL

レベル

INFO

quarkus.log.handlers

ルートカテゴリーにリンクする追加のハンドラーの名前。これらのハンドラーは、consoleHandlers、fileHandlers、または syslogHandlers で定義されます。

環境変数: QUARKUS_LOG_HANDLERS

文字列のリスト

最小ロギングカテゴリー

型

デフォルト

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

このカテゴリーの最小ログレベル。デフォルトでは、すべてのカテゴリーで最小レベルが DEBUG に設定されています。

実行時のロギングを DEBUG より下のレベル (TRACE など) にするには、ビルド時に最小レベルを調整します。実行時に適切なログレベルを指定する必要があります。

たとえば、TRACE ログを取得するには、最小レベルを TRACE にし、実行時のログレベルをそれに一致させる必要があります。

環境変数: QUARKUS_LOG_CATEGORY__CATEGORIES__MIN_LEVEL

InheritableLevel

inherit

quarkus.log.category."categories".level

このカテゴリーのログレベル。

INFO 未満のログレベルを取得するには、ビルド時の最小レベル設定オプションも調整する必要があることに注意してください。

環境変数: QUARKUS_LOG_CATEGORY__CATEGORIES__LEVEL

InheritableLevel

inherit

quarkus.log.category."categories".handlers

このカテゴリーにリンクするハンドラーの名前。

環境変数: QUARKUS_LOG_CATEGORY__CATEGORIES__HANDLERS

文字列のリスト

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

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

環境変数: QUARKUS_LOG_CATEGORY__CATEGORIES__USE_PARENT_HANDLERS

boolean

true

コンソールロギング

型

デフォルト

quarkus.log.console.enable

ファイルロギングを有効にする必要があるかどうか。

環境変数: QUARKUS_LOG_CONSOLE_ENABLE

boolean

true

quarkus.log.console.stderr

コンソールロギングを、System#out ではなく System#err にする場合。

環境変数: QUARKUS_LOG_CONSOLE_STDERR

boolean

false

quarkus.log.console.format

ログフォーマット。コンソールフォーマットを制御するエクステンション (XML または JSON フォーマットのエクステンションなど) が存在する場合、この値は無視されることに注意してください。

環境変数: QUARKUS_LOG_CONSOLE_FORMAT

string

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

quarkus.log.console.level

コンソールのログレベル。

環境変数: QUARKUS_LOG_CONSOLE_LEVEL

レベル

すべて

quarkus.log.console.darken

色をどの程度暗くするかを指定します。コンソールフォーマットを制御するエクステンション (XML または JSON フォーマットのエクステンションなど) が存在する場合、この値は無視されることに注意してください。

環境変数: QUARKUS_LOG_CONSOLE_DARKEN

int

0

quarkus.log.console.filter

コンソールハンドラーにリンクするフィルターの名前。

環境変数: QUARKUS_LOG_CONSOLE_FILTER

string

quarkus.log.console.async

非同期でログを記録するかどうかを示します。

環境変数: QUARKUS_LOG_CONSOLE_ASYNC

boolean

false

quarkus.log.console.async.queue-length

書き込みをフラッシュする前に使用するキューの長さ。

環境変数: QUARKUS_LOG_CONSOLE_ASYNC_QUEUE_LENGTH

int

512

quarkus.log.console.async.overflow

キューが制限に達した場合に、(メッセージをドロップするのではなく) パブリッシャーをブロックするかどうかを決定します。

環境変数: QUARKUS_LOG_CONSOLE_ASYNC_OVERFLOW

block, discard

block

ファイルロギング

型

デフォルト

quarkus.log.file.enable

ファイルロギングを有効にする必要があるかどうか。

環境変数: QUARKUS_LOG_FILE_ENABLE

boolean

false

quarkus.log.file.format

ログフォーマット

環境変数: 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

ファイルに書き込まれるログのレベル。

環境変数: QUARKUS_LOG_FILE_LEVEL

レベル

すべて

quarkus.log.file.path

ログが書き込まれるファイルの名前。

環境変数: QUARKUS_LOG_FILE_PATH

ファイル

quarkus.log

quarkus.log.file.filter

ファイルハンドラーにリンクするフィルターの名前。

環境変数: QUARKUS_LOG_FILE_FILTER

string

quarkus.log.file.encoding

使用される文字エンコーディング

環境変数: QUARKUS_LOG_FILE_ENCODING

Charset

quarkus.log.file.async

非同期でログを記録するかどうかを示します。

環境変数: QUARKUS_LOG_FILE_ASYNC

boolean

false

quarkus.log.file.async.queue-length

書き込みをフラッシュする前に使用するキューの長さ。

環境変数: QUARKUS_LOG_FILE_ASYNC_QUEUE_LENGTH

int

512

quarkus.log.file.async.overflow

キューが制限に達した場合に、(メッセージをドロップするのではなく) パブリッシャーをブロックするかどうかを決定します。

環境変数: QUARKUS_LOG_FILE_ASYNC_OVERFLOW

block, discard

block

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

到達した場合にローテーションが実行されるログファイル最大サイズ。

環境変数: QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE

MemorySize

10 M

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

保持するバックアップの最大数。

環境変数: QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX

int

5

quarkus.log.file.rotation.file-suffix

ファイルハンドラーローテーションファイルの接尾辞。使用すると、ファイルはその接尾辞に基づきローテーションされます。

接尾辞は、DateTimeFormatter が認識できる日付と時刻のフォーマットである必要があります。

fileSuffix の例: .yyyy-MM-dd

注記: 接尾辞が .zip または .gz で終わる場合、ローテーションファイルも圧縮されます。

環境変数: QUARKUS_LOG_FILE_ROTATION_FILE_SUFFIX

string

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

サーバーの初期化時にログファイルをローテーションするかどうかを示します。

これが機能するには、max-file-size か file-suffix を設定する必要があります。

環境変数: QUARKUS_LOG_FILE_ROTATION_ROTATE_ON_BOOT

boolean

true

Syslog ロギング

型

デフォルト

quarkus.log.syslog.enable

syslog ロギングを有効にする必要があるかどうか。

環境変数: QUARKUS_LOG_SYSLOG_ENABLE

boolean

false

quarkus.log.syslog.endpoint

Syslog サーバーの IP アドレスとポート。

環境変数: QUARKUS_LOG_SYSLOG_ENDPOINT

host:port

localhost:514

quarkus.log.syslog.app-name

メッセージを RFC5424 フォーマットでフォーマットするときに使用されるアプリケーション名。

環境変数: QUARKUS_LOG_SYSLOG_APP_NAME

string

quarkus.log.syslog.hostname

メッセージ送信元のホスト名。

環境変数: QUARKUS_LOG_SYSLOG_HOSTNAME

string

quarkus.log.syslog.facility

RFC-5424 および RFC-3164 で定義されるとおり、メッセージの優先度を計算する際に使用するファシリティーを設定します。

環境変数: 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

このハンドラーが送信メッセージのフォーマットに使用する SyslogType syslog type を設定します。

環境変数: QUARKUS_LOG_SYSLOG_SYSLOG_TYPE

rfc5424, rfc3164

rfc5424

quarkus.log.syslog.protocol

Syslog サーバーへの接続に使用するプロトコルを設定します。

環境変数: QUARKUS_LOG_SYSLOG_PROTOCOL

tcp, udp, ssl-tcp

tcp

quarkus.log.syslog.use-counting-framing

有効にすると、送信されるメッセージの先頭にメッセージのサイズが付加されます。

環境変数: QUARKUS_LOG_SYSLOG_USE_COUNTING_FRAMING

boolean

false

quarkus.log.syslog.truncate

true に設定すると、メッセージが最大長を超えた場合に切り捨てます。

環境変数: QUARKUS_LOG_SYSLOG_TRUNCATE

boolean

true

quarkus.log.syslog.block-on-reconnect

org.jboss.logmanager.handlers.SyslogHandler.Protocol#TCP TCP または org.jboss.logmanager.handlers.SyslogHandler.Protocol#SSL_TCP SSL TCP プロトコルへの再接続を試みた場合のブロックを有効または無効にします。

環境変数: QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT

boolean

false

quarkus.log.syslog.format

ログメッセージのフォーマット。

環境変数: QUARKUS_LOG_SYSLOG_FORMAT

string

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

quarkus.log.syslog.level

Syslog ロガーによって記録されるメッセージレベルを指定するログレベル。

環境変数: QUARKUS_LOG_SYSLOG_LEVEL

レベル

すべて

quarkus.log.syslog.filter

ファイルハンドラーにリンクするフィルターの名前。

環境変数: QUARKUS_LOG_SYSLOG_FILTER

string

quarkus.log.syslog.max-length

送信可能なメッセージの最大長 (バイト単位)。長さには、ヘッダーとメッセージが含まれます。

設定されていない場合、sys-log-type が rfc5424 (デフォルト) の場合はデフォルト値は 2048、sys-log-type が rfc3164 の場合は 1024 になります。

環境変数: QUARKUS_LOG_SYSLOG_MAX_LENGTH

MemorySize

quarkus.log.syslog.async

非同期でログを記録するかどうかを示します。

環境変数: QUARKUS_LOG_SYSLOG_ASYNC

boolean

false

quarkus.log.syslog.async.queue-length

書き込みをフラッシュする前に使用するキューの長さ。

環境変数: QUARKUS_LOG_SYSLOG_ASYNC_QUEUE_LENGTH

int

512

quarkus.log.syslog.async.overflow

キューが制限に達した場合に、(メッセージをドロップするのではなく) パブリッシャーをブロックするかどうかを決定します。

環境変数: QUARKUS_LOG_SYSLOG_ASYNC_OVERFLOW

block, discard

block

コンソールハンドラー

型

デフォルト

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

ファイルロギングを有効にする必要があるかどうか。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ENABLE

boolean

true

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

コンソールロギングを、System#out ではなく System#err にする場合。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR

boolean

false

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

ログフォーマット。コンソールフォーマットを制御するエクステンション (XML または JSON フォーマットのエクステンションなど) が存在する場合、この値は無視されることに注意してください。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FORMAT

string

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

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

コンソールのログレベル。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__LEVEL

レベル

すべて

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

色をどの程度暗くするかを指定します。コンソールフォーマットを制御するエクステンション (XML または JSON フォーマットのエクステンションなど) が存在する場合、この値は無視されることに注意してください。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__DARKEN

int

0

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

コンソールハンドラーにリンクするフィルターの名前。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__FILTER

string

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

非同期でログを記録するかどうかを示します。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC

boolean

false

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

書き込みをフラッシュする前に使用するキューの長さ。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_QUEUE_LENGTH

int

512

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

キューが制限に達した場合に、(メッセージをドロップするのではなく) パブリッシャーをブロックするかどうかを決定します。

環境変数: QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__ASYNC_OVERFLOW

block, discard

block

ファイルハンドラー

型

デフォルト

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

ファイルロギングを有効にする必要があるかどうか。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLE

boolean

false

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

ログフォーマット

環境変数: 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

ファイルに書き込まれるログのレベル。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__LEVEL

レベル

すべて

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

ログが書き込まれるファイルの名前。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__PATH

ファイル

quarkus.log

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

ファイルハンドラーにリンクするフィルターの名前。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__FILTER

string

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

使用される文字エンコーディング

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENCODING

Charset

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

非同期でログを記録するかどうかを示します。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC

boolean

false

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

書き込みをフラッシュする前に使用するキューの長さ。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_QUEUE_LENGTH

int

512

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

キューが制限に達した場合に、(メッセージをドロップするのではなく) パブリッシャーをブロックするかどうかを決定します。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ASYNC_OVERFLOW

block, discard

block

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

到達した場合にローテーションが実行されるログファイル最大サイズ。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE

MemorySize

10 M

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

保持するバックアップの最大数。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_BACKUP_INDEX

int

5

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

ファイルハンドラーローテーションファイルの接尾辞。使用すると、ファイルはその接尾辞に基づきローテーションされます。

接尾辞は、DateTimeFormatter が認識できる日付と時刻のフォーマットである必要があります。

fileSuffix の例: .yyyy-MM-dd

注記: 接尾辞が .zip または .gz で終わる場合、ローテーションファイルも圧縮されます。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_FILE_SUFFIX

string

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

サーバーの初期化時にログファイルをローテーションするかどうかを示します。

これが機能するには、max-file-size か file-suffix を設定する必要があります。

環境変数: QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_ROTATE_ON_BOOT

boolean

true

Syslog ハンドラー

型

デフォルト

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

syslog ロギングを有効にする必要があるかどうか。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLE

boolean

false

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

Syslog サーバーの IP アドレスとポート。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENDPOINT

host:port

localhost:514

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

メッセージを RFC5424 フォーマットでフォーマットするときに使用されるアプリケーション名。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__APP_NAME

string

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

メッセージ送信元のホスト名。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__HOSTNAME

string

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

RFC-5424 および RFC-3164 で定義されるとおり、メッセージの優先度を計算する際に使用するファシリティーを設定します。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__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.handler.syslog."syslog-handlers".syslog-type

このハンドラーが送信メッセージのフォーマットに使用する SyslogType syslog type を設定します。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__SYSLOG_TYPE

rfc5424, rfc3164

rfc5424

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

Syslog サーバーへの接続に使用するプロトコルを設定します。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__PROTOCOL

tcp, udp, ssl-tcp

tcp

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

有効にすると、送信されるメッセージの先頭にメッセージのサイズが付加されます。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__USE_COUNTING_FRAMING

boolean

false

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

true に設定すると、メッセージが最大長を超えた場合に切り捨てます。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE

boolean

true

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

org.jboss.logmanager.handlers.SyslogHandler.Protocol#TCP TCP または org.jboss.logmanager.handlers.SyslogHandler.Protocol#SSL_TCP SSL TCP プロトコルへの再接続を試みた場合のブロックを有効または無効にします。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT

boolean

false

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

ログメッセージのフォーマット。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FORMAT

string

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

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

Syslog ロガーによって記録されるメッセージレベルを指定するログレベル。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__LEVEL

レベル

すべて

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

ファイルハンドラーにリンクするフィルターの名前。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__FILTER

string

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

送信可能なメッセージの最大長 (バイト単位)。長さには、ヘッダーとメッセージが含まれます。

設定されていない場合、sys-log-type が rfc5424 (デフォルト) の場合はデフォルト値は 2048、sys-log-type が rfc3164 の場合は 1024 になります。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__MAX_LENGTH

MemorySize

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

非同期でログを記録するかどうかを示します。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC

boolean

false

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

書き込みをフラッシュする前に使用するキューの長さ。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_QUEUE_LENGTH

int

512

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

キューが制限に達した場合に、(メッセージをドロップするのではなく) パブリッシャーをブロックするかどうかを決定します。

環境変数: QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ASYNC_OVERFLOW

block, discard

block

ログクリーンアップフィルター - 内部使用

型

デフォルト

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

照合するメッセージの接頭辞。

環境変数: QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH

文字列のリスト

inherit

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

フィルタリングされたメッセージの新しいログレベル。デフォルトは DEBUG です。

環境変数: QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL

レベル

DEBUG