16.6. 関連するオプション

log-console-async

コンソールに非同期でログを記録するかどうかを示します。

設定されていない場合は、親プロパティー log-async の値が使用されます。

CLI: --log-console-async
Env: KC_LOG_CONSOLE_ASYNC

コンソールログハンドラーがアクティブになっている場合にのみ使用可能

true、false (デフォルト)

log-console-async-queue-length

コンソールへのロギング時に書き込みをフラッシュする前に使用するキューの長さ。

CLI: --log-console-async-queue-length
Env: KC_LOG_CONSOLE_ASYNC_QUEUE_LENGTH

Console ログハンドラーがアクティベートされ、非同期ロギングが有効になっている場合のみ使用可能

512 （デフォルト）

log-console-color

コンソールへのログイン時に、色を有効または無効にします。

CLI: --log-console-color
Env: KC_LOG_CONSOLE_COLOR

コンソールログハンドラーがアクティブになっている場合にのみ使用可能

true、false (デフォルト)

log-console-format

非構造化コンソールログエントリーの形式。

形式にスペースが含まれている場合は、"<format>" を使用して値をエスケープします。

CLI: --log-console-format
Env: KC_LOG_CONSOLE_FORMAT

コンソールログハンドラーがアクティブになっている場合にのみ使用可能

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

log-console-include-mdc

コンソールログに mdc 情報を含めます。

log-console-format オプションが指定されている場合、このオプションは効果がありません。

CLI: --log-console-include-mdc
Env: KC_LOG_CONSOLE_INCLUDE_MDC

Console ログハンドラーと MDC ロギングがアクティブな場合にのみ使用可能

true (デフォルト)、false

log-console-include-trace

コンソールログにトレーシング情報を含めます。

log-console-format オプションが指定されている場合、このオプションは効果がありません。

CLI: --log-console-include-trace
Env: KC_LOG_CONSOLE_INCLUDE_TRACE

コンソールログハンドラーとトレーシングが有効な場合にのみ使用可能

true (デフォルト)、false

log-console-json-format

生成される JSON の形式を設定します。

CLI: --log-console-json-format
Env: KC_LOG_CONSOLE_JSON_FORMAT

コンソールログハンドラーがアクティブ化され、出力が 'json' に設定されている場合にのみ使用可能です。

default (デフォルト)、ecs

log-console-level

コンソールハンドラーのログレベルを設定します。

出力に表示されるログの最も詳細なログレベルを指定します。これは、ロギングシステム全体の最大の詳細度を表す、log-level オプションで指定されたレベルを考慮します。詳細は、ロギングガイドを参照してください。

CLI: --log-console-level
Env: KC_LOG_CONSOLE_LEVEL

コンソールログハンドラーがアクティブになっている場合にのみ使用可能

off, fatal, error, warn, info, debug, trace, all (デフォルト)

log-console-output

ログ出力を、JSON またはデフォルトの (プレーン) 非構造化ロギングに設定します。

CLI: --log-console-output
Env: KC_LOG_CONSOLE_OUTPUT

コンソールログハンドラーがアクティブになっている場合にのみ使用可能

default (デフォルト)、json

log-file

ログファイルのパスとファイル名を設定します。

CLI: --log-file
Env: KC_LOG_FILE

File ログハンドラーがアクティブになっている場合にのみ使用可能

data/log/keycloak.log (デフォルト)

log-file-async

ファイルログに非同期でログを記録するかどうかを示します。

設定されていない場合は、親プロパティー log-async の値が使用されます。

CLI: --log-file-async
Env: KC_LOG_FILE_ASYNC

File ログハンドラーがアクティブになっている場合にのみ使用可能

true、false (デフォルト)

log-file-async-queue-length

ファイルログへのロギング時に書き込みをフラッシュする前に使用するキューの長さ。

CLI: --log-file-async-queue-length
Env: KC_LOG_FILE_ASYNC_QUEUE_LENGTH

File ログハンドラーがアクティベートされ、非同期ロギングが有効になっている場合のみ使用可能

512 （デフォルト）

log-file-format

ファイルログエントリーに固有の形式を設定します。

CLI: --log-file-format
Env: KC_LOG_FILE_FORMAT

File ログハンドラーがアクティブになっている場合にのみ使用可能

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

log-file-include-mdc

ファイルログに MDC 情報を含めます。

log-file-format オプションが指定されている場合、このオプションは効果がありません。

CLI: --log-file-include-mdc
Env: KC_LOG_FILE_INCLUDE_MDC

File ログハンドラーと MDC ロギングがアクティブな場合にのみ使用可能

true (デフォルト)、false

log-file-include-trace

ファイルログにトレーシング情報を含めます。

log-file-format オプションが指定されている場合、このオプションは効果がありません。

CLI: --log-file-include-trace
Env: KC_LOG_FILE_INCLUDE_TRACE

File ログハンドラーとトレーシングが有効な場合にのみ使用可能

true (デフォルト)、false

log-file-json-format

生成される JSON の形式を設定します。

CLI: --log-file-json-format
Env: KC_LOG_FILE_JSON_FORMAT

ファイルログハンドラーがアクティブ化され、出力が 'json' に設定されている場合にのみ使用できます。

default (デフォルト)、ecs

log-file-level

ファイルハンドラーのログレベルを設定します。

出力に表示されるログの最も詳細なログレベルを指定します。これは、ロギングシステム全体の最大の詳細度を表す、log-level オプションで指定されたレベルを考慮します。詳細は、ロギングガイドを参照してください。

CLI: --log-file-level
Env: KC_LOG_FILE_LEVEL

File ログハンドラーがアクティブになっている場合にのみ使用可能

off, fatal, error, warn, info, debug, trace, all (デフォルト)

log-file-output

ログ出力を、JSON またはデフォルトの (プレーン) 非構造化ロギングに設定します。

CLI: --log-file-output
Env: KC_LOG_FILE_OUTPUT

File ログハンドラーがアクティブになっている場合にのみ使用可能

default (デフォルト)、json

log-syslog-app-name

メッセージを RFC5424 形式でフォーマットするときに使用するアプリケーション名を設定します。

CLI: --log-syslog-app-name
Env: KC_LOG_SYSLOG_APP_NAME

Syslog が有効な場合にのみ使用可能

keycloak (デフォルト)

log-syslog-async

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

設定されていない場合は、親プロパティー log-async の値が使用されます。

CLI: --log-syslog-async
Env: KC_LOG_SYSLOG_ASYNC

Syslog が有効な場合にのみ使用可能

true、false (デフォルト)

log-syslog-async-queue-length

Syslog へのロギング時に書き込みをフラッシュする前に使用するキューの長さ。

CLI: --log-syslog-async-queue-length
Env: KC_LOG_SYSLOG_ASYNC_QUEUE_LENGTH

Syslog がアクティブ化され、非同期ロギングが有効になっている場合のみ使用可能

512 （デフォルト）

log-syslog-counting-framing

true の場合、送信されるメッセージにはメッセージのサイズの接頭辞が付けられます。

プロトコル依存の場合、log- syslog-protocol が tcp または ssl-tcp の場合はデフォルト値が true になり、それ以外の場合は false になります。

CLI: --log-syslog-counting-framing
Env: KC_LOG_SYSLOG_COUNTING_FRAMING

Syslog が有効な場合にのみ使用可能

true、false、プロトコルに依存する （デフォルト）

log-syslog-endpoint

Syslog サーバーの IP アドレスとポートを設定します。

CLI: --log-syslog-endpoint
Env: KC_LOG_SYSLOG_ENDPOINT

Syslog が有効な場合にのみ使用可能

localhost:514 (default)

log-syslog-format

Syslog エントリーに固有の形式を設定します。

CLI: --log-syslog-format
Env: KC_LOG_SYSLOG_FORMAT

Syslog が有効な場合にのみ使用可能

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

log-syslog-include-mdc

Syslog に MDC 情報を含めます。

log-syslog-format オプションが指定されている場合、このオプションは効果がありません。

CLI: --log-syslog-include-mdc
Env: KC_LOG_SYSLOG_INCLUDE_MDC

Syslog ハンドラーと MDC ロギングがアクティブな場合にのみ使用可能

true (デフォルト)、false

log-syslog-include-trace

Syslog にトレーシング情報を含めます。

log-syslog-format オプションが指定されている場合、このオプションは効果がありません。

CLI: --log-syslog-include-trace
Env: KC_LOG_SYSLOG_INCLUDE_TRACE

Syslog ハンドラーとトレーシングが有効な場合にのみ使用可能

true (デフォルト)、false

log-syslog-json-format

生成される JSON の形式を設定します。

CLI: --log-syslog-json-format
Env: KC_LOG_SYSLOG_JSON_FORMAT

Syslog が有効で、出力が 'json' に設定されている場合にのみ使用可能です。

default (デフォルト)、ecs

log-syslog-level

Syslog ハンドラーのログレベルを設定します。

出力に表示されるログの最も詳細なログレベルを指定します。これは、ロギングシステム全体の最大の詳細度を表す、log-level オプションで指定されたレベルを考慮します。詳細は、ロギングガイドを参照してください。

CLI: --log-syslog-level
Env: KC_LOG_SYSLOG_LEVEL

Syslog が有効な場合にのみ使用可能

off, fatal, error, warn, info, debug, trace, all (デフォルト)

log-syslog-max-length

送信が許可されるメッセージの最大長 (バイト単位) を設定します。

長さにはヘッダーとメッセージが含まれます。設定されていない場合、log-syslog-type が rfc5424 (デフォルト) の場合はデフォルト値は 2048、log-syslog-type が rfc3164 の場合はデフォルト値は 1024 になります。

CLI: --log-syslog-max-length
Env: KC_LOG_SYSLOG_MAX_LENGTH

Syslog が有効な場合にのみ使用可能

log-syslog-output

Syslog 出力を JSON またはデフォルトの (プレーン) 非構造化ロギングに設定します。

CLI: --log-syslog-output
Env: KC_LOG_SYSLOG_OUTPUT

Syslog が有効な場合にのみ使用可能

default (デフォルト)、json

log-syslog-protocol

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

CLI: --log-syslog-protocol
Env: KC_LOG_SYSLOG_PROTOCOL

Syslog が有効な場合にのみ使用可能

tcp (デフォルト)、udp、ssl-tcp

log-syslog-type

送信メッセージのフォーマットに使用する Syslog タイプを設定します。

CLI: --log-syslog-type
Env: KC_LOG_SYSLOG_TYPE

Syslog が有効な場合にのみ使用可能

rfc5424 (default), rfc3164

http-access-log-enabled

HTTP アクセスログが有効な場合。

デフォルトでは、これによりレコードがコンソールに記録されます。

CLI: --http-access-log-enabled
Env: KC_HTTP_ACCESS_LOG_ENABLED

true、false (デフォルト)

http-access-log-exclude

一部のパスをロギングから除外するために使用できる正規表現。

たとえば、/realms/ my-realm /.* は、 レルム my-realm の後続のエンドポイントをすべてログから除外します。

CLI: --http-access-log-exclude
Env: KC_HTTP_ACCESS_LOG_EXCLUDE

HTTP アクセスログが有効な場合のみ使用可能

http-access-log-pattern

HTTP アクセスログパターン。

利用可能な名前付き形式を使用するか、Quarkus ドキュメント で説明されているカスタム形式を使用できます。

CLI: --http-access-log-pattern
Env: KC_HTTP_ACCESS_LOG_PATTERN

HTTP アクセスログが有効な場合のみ使用可能

一般的な （デフォルト）、long、または any を 組み合わせる