Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

11.5. 配置日志处理程序

日志处理程序定义如何记录捕获的日志消息。有关配置您需要的日志处理程序类型，请参见相应的部分。

11.5.1. 配置控制台日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置控制台日志处理程序。您还可以使用管理控制台配置控制台日志处理程序，方法是导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Console Handler。

在配置控制台日志处理程序时要执行的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加控制台日志处理程序
/subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:add
Copy to Clipboard Toggle word wrap
配置控制台日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个控制台日志处理程序属性：有关可用控制台日志处理程序属性及其描述的完整列表，请参阅 Console Log Handler Attributes。

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置目标。

    设置处理程序的目标，可以是 System.out、System.err 或 console 之一。默认值为 System.out。 

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=target,value=TARGET)
    Copy to Clipboard Toggle word wrap

  • 设置编码.

    设置处理程序的编码，如 utf-8。 

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    Copy to Clipboard Toggle word wrap

  • 设置日志格式器。

    设置处理程序的格式字符串。例如，默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必在引号中包含 FORMAT 值。 

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    Copy to Clipboard Toggle word wrap
    注意

  • 设置自动刷新.

    设置是否在每次写入后自动清空。默认值为 true。 

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
    Copy to Clipboard Toggle word wrap

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将控制台日志处理程序分配给日志记录器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将控制台日志处理程序分配到根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=CONSOLE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将控制台日志处理程序分配到其名称由 CATEGORY 指定的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=CONSOLE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除控制台日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/console-handler=CONSOLE_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap

11.5.2. 配置文件日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置文件日志处理程序。您还可以使用管理控制台配置文件日志处理程序，方法是导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler File Handler。

在配置文件日志处理程序时要执行的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加文件日志处理程序

在添加文件日志处理程序时，您必须使用 file 属性指定文件路径，该属性由 path 和 relative -to 属性组成。使用 path 属性设置日志的文件路径，包括名称，如 my-log.log。（可选）使用 relative-to 属性设置 路径 相对于指定路径，如 jboss.server.log.dir。 

/subsystem=logging/file-handler=FILE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})
Copy to Clipboard Toggle word wrap
配置文件日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个文件日志处理程序属性：有关可用文件日志处理程序属性及其描述的完整列表，请参阅 File Log Handler Attributes。

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置附加行为。

    默认情况下，JBoss EAP 将在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false，使其在服务器重启时覆盖文件。 

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=append,value=APPEND)
    Copy to Clipboard Toggle word wrap

  • 设置编码.

    设置处理程序的编码，如 utf-8。 

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    Copy to Clipboard Toggle word wrap

  • 设置日志格式器。

    设置处理程序的格式字符串。例如，默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必在引号中包含 FORMAT 值。 

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    Copy to Clipboard Toggle word wrap
    注意

  • 设置自动刷新.

    设置是否在每次写入后自动清空。默认值为 true。 

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
    Copy to Clipboard Toggle word wrap

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/file-handler=FILE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将文件日志处理程序分配给日志器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将文件日志处理程序分配到根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=FILE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将文件日志处理程序分配到其名称由 CATEGORY 指定的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=FILE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除文件日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/file-handler=FILE_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap

11.5.3. 配置定期轮转日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置定期轮转日志处理程序。您还可以使用管理控制台配置定期日志处理程序，方法是导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Periodic Handler。

用于配置定期日志处理器的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加定期日志处理程序

在添加定期日志处理程序时，您必须使用 file 属性指定文件路径，该属性由 path 和 relative -to 属性组成。使用 path 属性设置日志的文件路径，包括名称，如 my-log.log。（可选）使用 relative-to 属性设置 路径 相对于指定路径，如 jboss.server.log.dir。

您还必须使用 suffix 属性为轮转日志设置后缀。这的格式必须可以被 java.text.SimpleDateFormat（ 如 .yyyyyy-MM-dd-HH） 理解。轮转期间会基于此后缀自动计算。 

/subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)
Copy to Clipboard Toggle word wrap
配置定期日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个定期日志处理程序属性：有关可用定期日志处理程序属性及其描述的完整列表，请参阅 Periodic Log Handler Attributes。

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置附加行为。

    默认情况下，JBoss EAP 将在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false，使其在服务器重启时覆盖文件。 

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=append,value=APPEND)
    Copy to Clipboard Toggle word wrap

  • 设置编码.

    设置处理程序的编码，如 utf-8。 

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    Copy to Clipboard Toggle word wrap

  • 设置日志格式器。

    设置处理程序的格式字符串。例如，默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必在引号中包含 FORMAT 值。 

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    Copy to Clipboard Toggle word wrap
    注意

  • 设置自动刷新.

    设置是否在每次写入后自动清空。默认值为 true。 

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
    Copy to Clipboard Toggle word wrap

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将定期日志处理程序分配给日志记录器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将定期日志处理程序分配到根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=PERIODIC_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将定期日志处理程序分配到其名称由 CATEGORY 指定的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=PERIODIC_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除定期日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/periodic-rotating-file-handler=PERIODIC_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap

11.5.4. 配置大小轮转日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置大小轮转日志处理程序。您还可以使用管理控制台配置大小日志处理程序，方法是导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Size Handler。

在配置大小日志处理器时要执行的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加大小日志处理程序

在添加大小日志处理程序时，您必须使用 file 属性指定文件路径，该属性由 path 和 relative -to 属性组成。使用 path 属性设置日志的文件路径，包括名称，如 my-log.log。（可选）使用 relative-to 属性设置 路径 相对于指定路径，如 jboss.server.log.dir。 

/subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH})
Copy to Clipboard Toggle word wrap
配置大小日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个大小日志处理程序属性：有关可用大小日志处理程序属性及其描述的完整列表，请参阅 Size Log Handler Attributes。

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置轮转日志的后缀。

    设置后缀字符串，格式为 java.text.SimpleDateFormat，如 .yyyyy-MM-dd-HH。轮转期间会基于此后缀自动计算。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=suffix, value=SUFFIX)
    Copy to Clipboard Toggle word wrap

  • 设置轮转大小。

    设置在轮转之前文件能够达到的最大大小。默认值为 2m (2 MB)。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)
    Copy to Clipboard Toggle word wrap

  • 设置要保留的最大备份日志数。

    设置要保留的备份数。默认值为 1。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)
    Copy to Clipboard Toggle word wrap

  • 设置是否在引导时轮转日志。

    默认情况下，服务器重启时不会创建新的日志文件。您可以将此项设置为 true，以在服务器重启时轮转日志。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)
    Copy to Clipboard Toggle word wrap

  • 设置附加行为。

    默认情况下，JBoss EAP 将在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false，使其在服务器重启时覆盖文件。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)
    Copy to Clipboard Toggle word wrap

  • 设置编码.

    设置处理程序的编码，如 utf-8。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    Copy to Clipboard Toggle word wrap

  • 设置日志格式器。

    设置处理程序的格式字符串。例如，默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必在引号中包含 FORMAT 值。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    Copy to Clipboard Toggle word wrap
    注意

  • 设置自动刷新.

    设置是否在每次写入后自动清空。默认值为 true。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
    Copy to Clipboard Toggle word wrap

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将 Size Log Handler 分配给日志器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将大小日志处理程序分配到根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=SIZE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将大小日志处理程序分配给名称由 CATEGORY 指定的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=SIZE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除大小日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/size-rotating-file-handler=SIZE_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap

11.5.5. 配置 Periodic 大小轮转日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置定期大小轮转日志处理程序。您还可以通过使用管理控制台配置定期大小日志处理程序，导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Periodic Size Handler。

用于配置定期大小日志处理器的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加定期大小日志处理程序

在添加定期大小日志处理程序时，您必须使用 file 属性指定文件路径，该属性由 path 和 relative -to 属性组成。使用 path 属性设置日志的文件路径，包括名称，如 my-log.log。（可选）使用 relative-to 属性设置 路径 相对于指定路径，如 jboss.server.log.dir。

您还必须使用 suffix 属性为轮转日志设置后缀。这的格式必须可以被 java.text.SimpleDateFormat（ 如 .yyyyyy-MM-dd-HH） 理解。轮转期间会基于此后缀自动计算。 

/subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:add(file={path=FILE_PATH,relative-to=RELATIVE_TO_PATH},suffix=SUFFIX)
Copy to Clipboard Toggle word wrap
配置定期大小日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个定期大小日志处理程序属性：有关可用定期大小日志处理程序属性及其描述的完整列表，请参阅 Periodic Sandler Attributes。

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置轮转大小。

    设置在轮转之前文件能够达到的最大大小。默认值为 2m (2 MB)。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-size, value=ROTATE_SIZE)
    Copy to Clipboard Toggle word wrap

  • 设置要保留的最大备份日志数。

    设置要保留的备份数。默认值为 1。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=max-backup-index, value=MAX_BACKUPS)
    Copy to Clipboard Toggle word wrap

  • 设置是否在引导时轮转日志。

    默认情况下，服务器重启时不会创建新的日志文件。您可以将此项设置为 true，以在服务器重启时轮转日志。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=rotate-on-boot, value=ROTATE_ON_BOOT)
    Copy to Clipboard Toggle word wrap

  • 设置附加行为。

    默认情况下，JBoss EAP 将在服务器重启时将日志消息附加到同一文件中。您可以将 append 属性设置为 false，使其在服务器重启时覆盖文件。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=append,value=APPEND)
    Copy to Clipboard Toggle word wrap

  • 设置编码.

    设置处理程序的编码，如 utf-8。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    Copy to Clipboard Toggle word wrap

  • 设置日志格式器。

    设置处理程序的格式字符串。例如，默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必在引号中包含 FORMAT 值。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    Copy to Clipboard Toggle word wrap
    注意

  • 设置自动刷新.

    设置是否在每次写入后自动清空。默认值为 true。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
    Copy to Clipboard Toggle word wrap

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将 Periodic Size Log Handler 分配给日志记录器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将定期大小日志处理程序分配给根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=PERIODIC_SIZE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将定期大小日志处理程序分配给由 CATEGORY 指定名称的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=PERIODIC_SIZE_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除定期大小日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/periodic-size-rotating-file-handler=PERIODIC_SIZE_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap

11.5.6. 配置 Syslog 处理程序
复制链接

本节介绍如何使用管理 CLI 配置 syslog 处理程序，该 CLI 可用于将消息发送到支持 Syslog 协议的远程记录服务器，可以是 RFC-3164 或 RFC-5424。您还可以使用管理控制台配置 syslog 处理程序，方法是导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Syslog Handler。

在配置 syslog 处理程序时要执行的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加 Syslog 处理程序
/subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:add
Copy to Clipboard Toggle word wrap
配置 Syslog 处理程序设置

根据您的需要，您可能需要设置以下一个或多个 syslog 处理程序属性：有关可用 syslog 处理程序属性及其描述的完整列表，请参阅 Syslog Handler Attributes。

  • 设置处理程序的日志级别。默认级别为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置正在记录的应用的名称。默认名称为 java。 

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=app-name,value=APP_NAME)
    Copy to Clipboard Toggle word wrap

  • 设置 syslog 服务器的地址。默认地址为 localhost。 

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=server-address,value=SERVER_ADDRESS)
    Copy to Clipboard Toggle word wrap

  • 设置 syslog 服务器的端口。默认端口为 514。 

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=port,value=PORT)
    Copy to Clipboard Toggle word wrap

  • 设置 syslog 格式，如 RFC 规范所定义。默认格式为 RFC5424。 

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=syslog-format,value=SYSLOG_FORMAT)
    Copy to Clipboard Toggle word wrap

  • 指定 named-formatter 属性，以格式化 syslog 有效负载的消息。 

    /subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:write-attribute(name=named-formatter, value=FORMATTER_NAME)
    Copy to Clipboard Toggle word wrap
将 Syslog Handler 分配给日志记录器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将 syslog 处理程序分配给根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=SYSLOG_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将 syslog 处理程序分配给名称由 CATEGORY 指定的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=SYSLOG_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除 Syslog 处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/syslog-handler=SYSLOG_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap

11.5.7. 配置套接字日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置套接字日志处理程序，它可用于通过套接字发送消息。这可以是 TCP 或 UDP 套接字。您还可以使用管理控制台配置套接字日志处理程序，方法是导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Socket Handler。

注意

如果服务器以 admin-only 模式启动，则会丢弃日志消息。

配置套接字日志处理器时要执行的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加 Socket Binding

定义 remote-destination-outbound-socket-binding 或 local-destination-outbound-socket-binding，作为 要使用的套接字绑定。 

/socket-binding-group=SOCKET_BINDING_GROUP/remote-destination-outbound-socket-binding=SOCKET_BINDING_NAME:add(host=HOST, port=PORT)
Copy to Clipboard Toggle word wrap
添加日志格式

定义 要使用的日志格式 器，如 JSON 格式器。 

/subsystem=logging/json-formatter=FORMATTER:add
Copy to Clipboard Toggle word wrap
添加套接字日志处理程序

在添加套接字日志处理程序时，您必须指定要使用的套接字绑定和格式化器。 

/subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:add(outbound-socket-binding-ref=SOCKET_BINDING_NAME,named-formatter=FORMATTER)
Copy to Clipboard Toggle word wrap
配置套接字日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个套接字日志处理程序属性：有关可用套接字日志处理程序属性及其描述的完整列表，请参阅 Socket Log Handler Attributes。

  • 设置协议.

    设置要使用的协议。默认值为 TCP。 

    /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=protocol,value=PROTOCOL)
    Copy to Clipboard Toggle word wrap

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap
    注意

    在服务器启动期间，套接字日志处理程序处理的日志消息排入队列，直到配置了套接字绑定并且初始化 logging 子系统。如果日志级别设置为低级别，如 TRACE 或 DEBUG，这可能会导致启动时消耗大量内存。

  • 设置编码.

    设置处理程序的编码，如 utf-8。 

    /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    Copy to Clipboard Toggle word wrap

  • 设置自动刷新.

    设置是否在每次写入后自动清空。默认值为 true。 

    /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=autoflush,value=AUTO_FLUSH)
    Copy to Clipboard Toggle word wrap

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将 Socket Log Handler 分配给 Logger

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将套接字日志处理程序分配到根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=SOCKET_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将套接字日志处理程序分配给名称由 CATEGORY 指定的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=SOCKET_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除套接字日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/socket-handler=SOCKET_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap
使用 SSL/TLS 通过套接字发送日志消息

下列步骤演示了如何设置套接字日志处理程序以使用 SSL_TCP 协议通过套接字发送日志消息的示例。本例在 elytron 子系统中配置密钥存储、信任管理器和客户端 SSL 上下文，供套接字日志处理程序使用。来自根日志记录器的日志消息通过指定的套接字发送，格式为 JSON 格式。

有关配置 Elytron 组件的更多信息，请参阅 如何为 JBoss EAP 配置服务器安全性 的 Elytron Subsystem。

  1. 配置 Elytron 设置。

    1. 添加 密钥存储。 

      /subsystem=elytron/key-store=log-server-ks:add(path=/path/to/keystore.jks, type=JKS, credential-reference={clear-text=mypassword})
      Copy to Clipboard Toggle word wrap

    2. 添加信任管理器。 

      /subsystem=elytron/trust-manager=log-server-tm:add(key-store=log-server-ks)
      Copy to Clipboard Toggle word wrap

    3. 添加客户端 SSL 上下文。 

      /subsystem=elytron/client-ssl-context=log-server-context:add(trust-manager=log-server-tm, protocols=["TLSv1.2"])
      Copy to Clipboard Toggle word wrap

  2. 添加套接字绑定。 

    /socket-binding-group=standard-sockets/remote-destination-outbound-socket-binding=log-server:add(host=localhost, port=4560)
    Copy to Clipboard Toggle word wrap

  3. 添加 JSON 格式器。 

    /subsystem=logging/json-formatter=json:add
    Copy to Clipboard Toggle word wrap

  4. 添加 socket 日志处理程序。 

    /subsystem=logging/socket-handler=log-server-handler:add(named-formatter=json, level=INFO, outbound-socket-binding-ref=log-server, protocol=SSL_TCP, ssl-context=log-server-context)
    Copy to Clipboard Toggle word wrap

  5. 将日志处理程序分配到根日志记录器。 

    /subsystem=logging/root-logger=ROOT:add-handler(name=log-server-handler)
    Copy to Clipboard Toggle word wrap

11.5.8. 配置自定义日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置自定义日志处理程序。您还可以使用管理控制台配置自定义日志处理程序，方法是导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Custom Handler。

用于配置自定义日志处理器的主要任务有：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加自定义日志处理程序

在添加自定义日志处理程序时，您必须指定处理程序的 Java 类以及包含它的 JBoss EAP 模块。该类必须扩展 java.util.logging.Handler。

注意

您必须已 创建了包含自定义日志记录器的模块，否则此命令将失败。 

/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:add(class=CLASS_NAME,module=MODULE_NAME)
Copy to Clipboard Toggle word wrap
配置自定义日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个自定义日志处理程序属性：有关可用自定义日志处理程序属性及其描述的完整列表，请参阅 自定义日志处理程序属性。

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置属性.

    设置日志处理程序所需的属性。属性必须能够通过 setter 方法访问。 

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=properties.PROPERTY_NAME,value=PROPERTY_VALUE)
    Copy to Clipboard Toggle word wrap

  • 设置编码.

    设置处理程序的编码，如 utf-8。 

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
    Copy to Clipboard Toggle word wrap

  • 设置日志格式器。

    设置处理程序的格式字符串。例如，默认格式字符串为 %d{HH:mm:ss,SSS} %-5p [%c](%t)%s%e%n。务必在引号中包含 FORMAT 值。 

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=formatter,value=FORMAT)
    Copy to Clipboard Toggle word wrap
    注意

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将自定义日志处理程序分配给日志记录器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将自定义日志处理程序分配到根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=CUSTOM_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将自定义日志处理程序分配到其名称由 CATEGORY 指定的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=CUSTOM_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除自定义日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序，则无法移除日志处理程序。 

/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap

11.5.9. 配置 Async 日志处理程序
复制链接

本节介绍如何使用管理 CLI 配置 async 日志处理程序。您还可以通过使用管理控制台配置 async 日志处理程序，导航到 Configuration Subsystems Logging Configuration，点 View，然后选择 Handler Async Handler。

在配置 async 日志处理程序时要执行的主要任务是：

重要

如果您要为日志记录配置集配置此日志处理程序，则命令的开头为 /subsystem=logging/logging-profile=LOGGING_PROFILE_NAME/ 而不是 /subsystem=logging/。

此外，如果您在受管域中运行，请在命令前加上 /profile=PROFILE_NAME。

添加 Async 日志处理程序

在添加 async 日志处理程序时，您必须指定队列长度。这是队列中可以保留的最大日志请求数。 

/subsystem=logging/async-handler=ASYNC_HANDLER_NAME:add(queue-length=QUEUE_LENGTH)
Copy to Clipboard Toggle word wrap
添加 Sub-handler

您可以添加一个或多个处理程序作为此 async 日志处理程序的子句柄。请注意，处理程序必须已存在于配置中，否则此命令将失败。 

/subsystem=logging/async-handler=ASYNC_HANDLER_NAME:add-handler(name=HANDLER_NAME)
Copy to Clipboard Toggle word wrap
配置 Async 日志处理程序设置

根据您的需要，您可能需要设置以下一个或多个 async 日志处理程序属性：有关可用 async 日志处理程序属性及其描述的完整列表，请参阅 Async Log Handler Attributes。

  • 设置日志级别。

    为处理程序设置适当的日志级别。默认值为 ALL。有关所有可用选项，请参阅 日志级别。 

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
    Copy to Clipboard Toggle word wrap

  • 设置溢出操作。

    设置溢出时要执行的操作。默认值为 BLOCK，即当有完整队列时线程会阻止。您可以将此值更改为 DISCARD，这意味着如果已满队列，日志消息将被丢弃。 

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=overflow-action,value=OVERFLOW_ACTION)
    Copy to Clipboard Toggle word wrap

  • 设置过滤器表达式。

    设置表达式，以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如，对于过滤器表达式 not （match("WFLY")，需要将以下 FILTER_EXPRESSION 可替换变量替换为"not（match(\" WFLY\")"。 

    /subsystem=logging/async-handler=ASYNC_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
    Copy to Clipboard Toggle word wrap

    有关可用过滤器表达式的更多信息，请参阅 Filter Expressions 部分。

将 Async 日志处理程序分配给日志记录器

要激活日志处理程序，您必须将其分配到日志记录器。

以下管理 CLI 命令将 async 日志处理程序分配给根日志记录器： 

/subsystem=logging/root-logger=ROOT:add-handler(name=ASYNC_HANDLER_NAME)
Copy to Clipboard Toggle word wrap

以下管理 CLI 命令将 async 日志处理程序分配给由 CATEGORY 指定名称的日志记录器： 

/subsystem=logging/logger=CATEGORY:add-handler(name=ASYNC_HANDLER_NAME)
Copy to Clipboard Toggle word wrap
删除 Async 日志处理程序

可以使用 remove 操作移除日志处理程序。如果当前分配给日志记录器，则无法移除日志处理程序。 

/subsystem=logging/async-handler=ASYNC_HANDLER_NAME:remove
Copy to Clipboard Toggle word wrap
返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat