1.12. 日志记录配置参考

配置属性

类型

default

quarkus.log.metrics.enabled

如果启用并存在指标扩展，则会发布日志记录指标。

环境变量： QUARKUS_LOG_METRICS_ENABLED

布尔值

false

quarkus.log.min-level

默认最小日志级别。

环境变量： QUARKUS_LOG_MIN_LEVEL

级别

DEBUG

quarkus.log.decorate-stacktraces

这将分解 dev 模式的 stacktrace，以显示导致异常的代码中的行

环境变量： QUARKUS_LOG_DECORATE_STACKTRACES

布尔值

true

quarkus.log.level

根类别的日志级别，用作所有类别的默认日志级别。

JBoss Logging 支持 Apache 风格的日志级别：

另外，它还支持标准的 JDK 日志级别。

环境变量： QUARKUS_LOG_LEVEL

级别

INFO

quarkus.log.handlers

要链接到根类别的其他处理程序的名称。这些处理程序在 consoleHandlers、fileHandlers 或 syslogHandlers 中定义。

环境变量： QUARKUS_LOG_HANDLERS

字符串列表

Minimum logging categories

类型

default

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

此类别的最小日志级别。默认情况下，所有类别都配置为 DEBUG 最低级别。

若要获取 DEBUG 以下的运行时日志记录，如 TRACE，可调整构建时的最小级别。在运行时需要提供正确的日志级别。

例如，若要获取 TRACE 日志记录，最低级别需要位于 TRACE 中，并且运行时日志级别需要匹配。

环境变量： QUARKUS_LOG_CATEGORY_CATEGORIES__MIN_LEVEL

InheritableLevel

继承

quarkus.log.category."categories".level

此类别的日志级别。

请注意，若要获取 INFO 以下的日志级别，还需要调整最小级别的构建时配置选项。

环境变量： QUARKUS_LOG_CATEGORY_CATEGORIES_LEVEL

InheritableLevel

继承

quarkus.log.category."categories".handlers

要链接到此类别的处理程序的名称。

环境变量： QUARKUS_LOG_CATEGORY_CATEGORIES_HANDLERS

字符串列表

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

指定此日志记录器是否应该将其输出发送到其父 Logger

环境变量： QUARKUS_LOG_CATEGORY_CATEGORIES__USE_PARENT_HANDLERS

布尔值

true

Console logging

类型

default

quarkus.log.console.enable

如果应该启用控制台日志记录

环境变量： QUARKUS_LOG_CONSOLE_ENABLE

布尔值

true

quarkus.log.console.stderr

如果控制台日志记录应该进入 System#err，而不是 System#out。

环境变量： QUARKUS_LOG_CONSOLE_STDERR

布尔值

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

级别

ALL

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

布尔值

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

File logging

类型

default

quarkus.log.file.enable

如果应该启用文件日志记录

环境变量： QUARKUS_LOG_FILE_ENABLE

布尔值

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

级别

ALL

quarkus.log.file.path

将在其中写入日志的文件名。

环境变量： QUARKUS_LOG_FILE_PATH

File

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

布尔值

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

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

执行轮转后的最大日志文件大小。

环境变量： QUARKUS_LOG_FILE_ROTATION_MAX_FILE_SIZE

MemorySize

10M

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

要保留的最大备份数。

环境变量： QUARKUS_LOG_FILE_ROTATION_MAX_BACKUP_INDEX

int

5

quarkus.log.file.rotation.file-suffix

文件处理程序轮转文件后缀。使用时，该文件将根据后缀进行轮转。

后缀必须采用 date-time 格式，它可以被 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

布尔值

true

Syslog logging

类型

default

quarkus.log.syslog.enable

如果应启用 syslog 日志记录

环境变量： QUARKUS_LOG_SYSLOG_ENABLE

布尔值

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,用户级,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-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 类型 此处理程序应该用来格式化发送的消息

环境变量： 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

布尔值

false

quarkus.log.syslog.truncate

设置为 true 会在超过最大长度时截断消息

环境变量： QUARKUS_LOG_SYSLOG_TRUNCATE

布尔值

true

quarkus.log.syslog.block-on-reconnect

在尝试重新连接 org.jboss.logmanager.handlers.SyslogHandler.Protocol SerialTCP TCP 或 org.jboss.logmanager.handlers.SyslogHandler.Protocol SerialSSL_TCP SSL TCP 协议时启用或禁用阻止

环境变量： QUARKUS_LOG_SYSLOG_BLOCK_ON_RECONNECT

布尔值

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

级别

ALL

quarkus.log.syslog.filter

要链接到文件处理程序的过滤器的名称。

环境变量： QUARKUS_LOG_SYSLOG_FILTER

string

quarkus.log.syslog.max-length

允许发送的消息的最大长度（以字节为单位）。长度包括标头和消息。

如果没有设置，当 sys-log-type 为 rfc5424 时，如果 sys-log-type 为 rfc3164，则默认值为 1024，当 sys-log-type 为 rfc3164时，默认值为 1024

环境变量： QUARKUS_LOG_SYSLOG_MAX_LENGTH

MemorySize

quarkus.log.syslog.async

指明是否异步记录

环境变量： QUARKUS_LOG_SYSLOG_ASYNC

布尔值

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

Console handlers

类型

default

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

如果应该启用控制台日志记录

环境变量： QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS_ENABLE

布尔值

true

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

如果控制台日志记录应该进入 System#err，而不是 System#out。

环境变量： QUARKUS_LOG_HANDLER_CONSOLE__CONSOLE_HANDLERS__STDERR

布尔值

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

级别

ALL

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

布尔值

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

File handlers

类型

default

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

如果应该启用文件日志记录

环境变量： QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ENABLE

布尔值

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

级别

ALL

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

将在其中写入日志的文件名。

环境变量： QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS_PATH

File

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

布尔值

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

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

执行轮转后的最大日志文件大小。

环境变量： QUARKUS_LOG_HANDLER_FILE__FILE_HANDLERS__ROTATION_MAX_FILE_SIZE

MemorySize

10M

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

文件处理程序轮转文件后缀。使用时，该文件将根据后缀进行轮转。

后缀必须采用 date-time 格式，它可以被 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

布尔值

true

Syslog handlers

类型

default

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

如果应启用 syslog 日志记录

环境变量： QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__ENABLE

布尔值

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,用户级,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-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 类型 此处理程序应该用来格式化发送的消息

环境变量： 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

布尔值

false

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

设置为 true 会在超过最大长度时截断消息

环境变量： QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__TRUNCATE

布尔值

true

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

在尝试重新连接 org.jboss.logmanager.handlers.SyslogHandler.Protocol SerialTCP TCP 或 org.jboss.logmanager.handlers.SyslogHandler.Protocol SerialSSL_TCP SSL TCP 协议时启用或禁用阻止

环境变量： QUARKUS_LOG_HANDLER_SYSLOG__SYSLOG_HANDLERS__BLOCK_ON_RECONNECT

布尔值

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

级别

ALL

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 时，如果 sys-log-type 为 rfc3164，则默认值为 1024，当 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

布尔值

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

Log cleanup filters - 内部使用

类型

default

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

要匹配的消息前缀

环境变量： QUARKUS_LOG_FILTER__FILTERS__IF_STARTS_WITH

字符串列表

继承

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

过滤的消息的新日志级别。默认值为 DEBUG。

环境变量： QUARKUS_LOG_FILTER__FILTERS__TARGET_LEVEL

级别

DEBUG