21.14. 日志记录

log

在以逗号分隔的列表中启用一个或多个日志处理程序。

CLI: -- log
Env: KC_LOG

控制台,文件,syslog

log-async

指明是否将异步日志记录到所有处理程序。

CLI: --log-async
Env: KC_LOG_ASYNC

true,false （默认）

log-console-async

指明是否异步记录到 console。

如果没有设置，则使用父属性 log-async 的值。

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

仅在激活 Console 日志处理程序时可用

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

仅在激活 Console 日志处理程序时可用

true,false （默认）

log-console-format

无结构控制台日志条目的格式。

如果格式有空格，请使用 "<format>" 转义值。

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

仅在激活 Console 日志处理程序时可用

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

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

仅在激活 Console 日志处理程序和 Tracing 时可用

true （默认），false

log-console-json-format

设置生成的 JSON 格式。

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

仅在激活 Console 日志处理程序并且输出设置为 'json' 时才可用

默认 （默认），ecs

log-console-level

设置控制台处理程序的日志级别。

它指定输出中显示的日志的最详细日志级别。它遵循 log-level 选项指定的级别，它代表整个日志记录系统的最大详细程度。如需更多信息，请参阅 Logging 指南。

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

仅在激活 Console 日志处理程序时可用

off,fatal,error,warn,info,debug,trace,all （默认）

log-console-output

将日志输出设置为 JSON 或默认(plain)非结构化日志记录。

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

仅在激活 Console 日志处理程序时可用

默认 （默认），json

log-file

设置日志文件路径和文件名。

CLI: --log-file
Env: KC_LOG_FILE

仅在文件日志处理程序激活时才可用

data/log/keycloak.log （默认）

log-file-async

指明是否异步记录到文件日志。

如果没有设置，则使用父属性 log-async 的值。

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

仅在文件日志处理程序激活时才可用

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

仅在文件日志处理程序激活时才可用

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

log-file-include-mdc

在文件日志中包含 MDC 信息。

如果指定了 log-file-format 选项，这个选项无效。

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

仅在激活文件日志处理程序和 MDC 日志记录时可用

true （默认），false

log-file-include-trace

在文件日志中包含追踪信息。

如果指定了 log-file-format 选项，这个选项无效。

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

仅在激活文件日志处理程序和跟踪时才可用

true （默认），false

log-file-json-format

设置生成的 JSON 格式。

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

仅在文件日志处理程序激活并且输出设置为 'json' 时才可用

默认 （默认），ecs

log-file-level

设置文件处理程序的日志级别。

它指定输出中显示的日志的最详细日志级别。它遵循 log-level 选项指定的级别，它代表整个日志记录系统的最大详细程度。如需更多信息，请参阅 Logging 指南。

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

仅在文件日志处理程序激活时才可用

off,fatal,error,warn,info,debug,trace,all （默认）

log-file-output

将日志输出设置为 JSON 或默认(plain)非结构化日志记录。

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

仅在文件日志处理程序激活时才可用

默认 （默认），json

log-level

根类别的日志级别或以逗号分隔的类别列表及其级别。

对于 root 类别，您不需要指定一个类别。

CLI: --log-level
Env: KC_LOG_LEVEL

[info] （默认）

log-mdc-enabled 🛠

指明是否将有关域的信息和其他信息添加到映射的诊断上下文中。

所有元素都将带有 kc 前缀。

CLI: --log-mdc-enabled
Env: KC_LOG_MDC_ENABLED

仅在启用 log-mdc 预览功能时可用

true,false （默认）

log-mdc-keys

定义哪些信息应作为逗号分隔的列表添加到映射的诊断上下文中。

CLI: --log-mdc-keys
Env: KC_LOG_MDC_KEYS

仅在启用 MDC 日志记录时可用

realmName,clientId,userId,ipAddress,org,sessionId,authenticationSessionId,authenticationTabId

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 （默认）

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 (default)

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 处理程序和 Tracing 时可用

true （默认），false

log-syslog-json-format

设置生成的 JSON 格式。

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

仅在 Syslog 激活且输出设置为 'json' 时才可用

默认 （默认），ecs

log-syslog-level

设置 Syslog 处理程序的日志级别。

它指定输出中显示的日志的最详细日志级别。它遵循 log-level 选项指定的级别，它代表整个日志记录系统的最大详细程度。如需更多信息，请参阅 Logging 指南。

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 （默认）和 1024 时，当 log-syslog-type 为 rfc3164 时，默认值为 2048。

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

仅在 Syslog 激活时才可用

log-syslog-output

将 Syslog 输出设置为 JSON 或默认(plain)非结构化日志记录。

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

仅在 Syslog 激活时才可用

默认 （默认），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 （默认），rfc3164