11.5.8. 配置自定义日志处理程序
本节介绍如何使用管理 CLI 配置自定义日志处理程序。您还可以使用管理控制台配置自定义日志处理程序,方法是导航到 Configuration
用于配置自定义日志处理器的主要任务有:
如果您要为日志记录配置集配置此日志处理程序,则命令的开头为 /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)
配置自定义日志处理程序设置
根据您的需要,您可能需要设置以下一个或多个自定义日志处理程序属性:有关可用自定义日志处理程序属性及其描述的完整列表,请参阅自定义日志处理程序属性。
设置日志级别。
为处理程序设置适当的日志级别。默认值为
ALL
。有关所有可用选项,请参阅日志级别。/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=level,value=LEVEL)
设置属性.
设置日志处理程序所需的属性。属性必须能够通过 setter 方法访问。
/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=properties.PROPERTY_NAME,value=PROPERTY_VALUE)
设置编码.
设置处理程序的编码,如
utf-8
。/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=encoding,value=ENCODING)
设置日志格式器。
设置处理程序的格式字符串。例如,默认格式字符串为
%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)
注意如果要引用 保存的格式器,请使用
named-formatter
属性。设置过滤器表达式。
设置表达式,以过滤处理程序的日志消息。务必用引号转义任何逗号和引号。例如,对于过滤器表达式
not
(match("WFLY"),需要将以下
WFLY\")"。FILTER_EXPRESSION
可替换变量替换为"not(match(\"/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:write-attribute(name=filter-spec, value=FILTER_EXPRESSION)
有关可用过滤器表达式的更多信息,请参阅 Filter Expressions 部分。
将自定义日志处理程序分配给日志记录器
要激活日志处理程序,您必须将其分配到日志记录器。
以下管理 CLI 命令将自定义日志处理程序分配到根日志记录器:
/subsystem=logging/root-logger=ROOT:add-handler(name=CUSTOM_HANDLER_NAME)
以下管理 CLI 命令将自定义日志处理程序分配到其名称由 CATEGORY
指定的日志记录器:
/subsystem=logging/logger=CATEGORY:add-handler(name=CUSTOM_HANDLER_NAME)
删除自定义日志处理程序
可以使用 remove
操作移除日志处理程序。如果当前分配给日志记录器或异步日志处理程序,则无法移除日志处理程序。
/subsystem=logging/custom-handler=CUSTOM_HANDLER_NAME:remove