logback -- 配置详解 -- 四 -- <filter>
附:
logback -- 配置详解 -- 一 -- <configuration>及子节点
logback -- 配置详解 -- 二 -- <appender>
logback -- 配置详解 -- 三 -- <encoder>
logback -- 配置详解 -- 四 -- <filter>
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
一:节点<appender>的子节点<filter>:
<filter> :
过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL,有序列表里的下个过滤器过接着处理日志;返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。
过滤器被添加到<appender> 中,为<appender> 添加一个或多个过滤器后,可以用任意条件对日志进行过滤。<appender> 有多个过滤器时,按照配置顺序执行。
下面是几个常用的过滤器 :
LevelFilter : 级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据 onMath 和 onMismatch 接收或拒绝日志。
有以下子节点 :
<level> : 设置过滤级别。
<onMatch> : 用于配置符合过滤条件的操作。
<onMismatch> : 用于配置不符合过滤条件的操作。
例如:将过滤器的日志级别配置为info,所有info级别的日志交给appender处理,非info级别的日志,被过滤掉。
XML :
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <property name="contextName" value="limeLog"/> <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/> <contextName>${contextName} - ${bySecond}</contextName> <!-- 表示打印到控制台 --> <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender"> <filter class="ch.qos.logback.classic.filter.LevelFilter"> <level>info</level> <onMatch>ACCEPT</onMatch> <onMismatch>DENY</onMismatch> </filter> <!-- encoder 默认配置为PatternLayoutEncoder --> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> <target>System.err</target> </appender> <logger name="limeLogback.LogbackDemo" level="debug" additivity="true"> <appender-ref ref="limeFlogger"/> </logger> <root/> </configuration>
Console :
19:40:59.567 [main] INFO limeLogback.LogbackDemo - ------info
ThresholdFilter : 临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。
有以下子节点 :
<level> : 设置过滤级别。
例如:过滤掉所有低于info级别的日志。
XML :
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <property name="contextName" value="limeLog"/> <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/> <contextName>${contextName} - ${bySecond}</contextName> <!-- 表示打印到控制台 --> <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender"> <filter class="ch.qos.logback.classic.filter.ThresholdFilter"> <level>info</level> </filter> <!-- encoder 默认配置为PatternLayoutEncoder --> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> <target>System.err</target> </appender> <logger name="limeLogback.LogbackDemo" level="debug" additivity="true"> <appender-ref ref="limeFlogger"/> </logger> <root/> </configuration>
Console :
19:43:32.139 [main] INFO limeLogback.LogbackDemo - ------info
19:43:32.142 [main] WARN limeLogback.LogbackDemo - ------warn
19:43:32.142 [main] ERROR limeLogback.LogbackDemo - ------error
EvaluatorFilter : 求值过滤器,评估、鉴别日志是否符合指定条件。
有以下子节点:
<evaluator> : 鉴别器,常用的鉴别器是JaninoEventEvaluato,也是默认的鉴别器,它以任意的Java布尔值表达式作为求值条件,求值条件在配置文件解释过成功被动态编译,布尔值表达式返回true就表示符合过滤条件。
evaluator有个子标签<expression>,用于配置求值条件。
求值表达式作用于当前日志,logback向求值表达式暴露日志的各种字段:
Name | Type | Description |
---|---|---|
event | LoggingEvent |
与记录请求相关联的原始记录事件,下面所有变量都来自event,例如,event.getMessage()返回下面"message"相同的字符串 |
message | String |
日志的原始消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello {}"就是原始消息。 |
formatedMessage | String |
日志被各式化的消息,例如,设有logger mylogger,"name"的值是"AUB",对于 mylogger.info("Hello {}",name); "Hello Aub"就是格式化后的消息。 |
logger | String |
logger 名。 |
loggerContext | LoggerContextVO |
日志所属的logger上下文。 |
level | int |
级别对应的整数值,所以 level > INFO 是正确的表达式。 |
timeStamp | long |
创建日志的时间戳。 |
marker | Marker |
与日志请求相关联的Marker对象,注意“Marker”有可能为null,所以你要确保它不能是null。 |
mdc | Map |
包含创建日志期间的MDC所有值得map。访问方法是:mdc.get("myKey") 。mdc.get()返回的是Object不是String,要想调用String的方法就要强转,例如,
|
throwable | java.lang.Throwable | 如果没有异常与日志关联"throwable" 变量为 null. 不幸的是, "throwable" 不能被序列化。在远程系统上永远为null,对于与位置无关的表达式请使用下面的变量throwableProxy |
throwableProxy | IThrowableProxy |
与日志事件关联的异常代理。如果没有异常与日志事件关联,则变量"throwableProxy" 为 null. 当异常被关联到日志事件时,"throwableProxy" 在远程系统上不会为null |
<onMatch>:用于配置符合过滤条件的操作
<onMismatch>:用于配置不符合过滤条件的操作
例如:过滤掉所有日志消息中不包含“billing”字符串的日志。
XML :
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <property name="contextName" value="limeLog" /> <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss" /> <contextName>${contextName} - ${bySecond}</contextName> <!-- 表示打印到控制台 --> <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender"> <filter class="ch.qos.logback.core.filter.EvaluatorFilter"> <evaluator> <!-- 默认为 ch.qos.logback.classic.boolex.JaninoEventEvaluator --> <expression>return message.contains("billing");</expression> </evaluator> <OnMatch>ACCEPT </OnMatch> <OnMismatch>DENY</OnMismatch> </filter> <!-- encoder 默认配置为PatternLayoutEncoder --> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> <target>System.err</target> </appender> <logger name="limeLogback.LogbackDemo" level="debug" additivity="true"> <appender-ref ref="limeFlogger" /> </logger> <root /> </configuration>
Console :
Failed to instantiate [ch.qos.logback.classic.LoggerContext] Reported exception: java.lang.NoClassDefFoundError: org/codehaus/janino/ScriptEvaluator at ch.qos.logback.core.boolex.JaninoEventEvaluatorBase.start(JaninoEventEvaluatorBase.java:57) at ch.qos.logback.core.joran.action.NestedComplexPropertyIA.end(NestedComplexPropertyIA.java:167) at ch.qos.logback.core.joran.spi.Interpreter.callEndAction(Interpreter.java:317) at ch.qos.logback.core.joran.spi.Interpreter.endElement(Interpreter.java:196) at ch.qos.logback.core.joran.spi.Interpreter.endElement(Interpreter.java:182) at ch.qos.logback.core.joran.spi.EventPlayer.play(EventPlayer.java:62) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:149) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:135) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:99) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:49) at ch.qos.logback.classic.util.ContextInitializer.configureByResource(ContextInitializer.java:75) at ch.qos.logback.classic.util.ContextInitializer.autoConfig(ContextInitializer.java:150) at org.slf4j.impl.StaticLoggerBinder.init(StaticLoggerBinder.java:85) at org.slf4j.impl.StaticLoggerBinder.<clinit>(StaticLoggerBinder.java:55) at org.slf4j.LoggerFactory.bind(LoggerFactory.java:128) at org.slf4j.LoggerFactory.performInitialization(LoggerFactory.java:107) at org.slf4j.LoggerFactory.getILoggerFactory(LoggerFactory.java:295) at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:269) at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:281) at limeLogback.LogbackDemo.<clinit>(LogbackDemo.java:8) Caused by: java.lang.ClassNotFoundException: org.codehaus.janino.ScriptEvaluator at java.net.URLClassLoader.findClass(Unknown Source) at java.lang.ClassLoader.loadClass(Unknown Source) at sun.misc.Launcher$AppClassLoader.loadClass(Unknown Source) at java.lang.ClassLoader.loadClass(Unknown Source) ... 20 more
<matcher> :
匹配器,尽管可以使用String类的matches()方法进行模式匹配,但会导致每次调用过滤器时都会创建一个新的Pattern对象,为了消除这种开销,可以预定义一个或多个matcher对象,定以后就可以在求值表达式中重复引用。<matcher>是<evaluator>的子标签。
<matcher>中包含两个子标签,一个是<name>,用于定义matcher的名字,求值表达式中使用这个名字来引用matcher;另一个是<regex>,用于配置匹配条件。
XML :
<?xml version="1.0" encoding="UTF-8"?> <configuration scan="true" scanPeriod="60 seconds" debug="false"> <property name="contextName" value="limeLog" /> <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss" /> <contextName>${contextName} - ${bySecond}</contextName> <!-- 表示打印到控制台 --> <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender"> <filter class="ch.qos.logback.core.filter.EvaluatorFilter"> <evaluator> <matcher> <Name>odd</Name> <!-- filter out odd numbered statements --> <regex>statement [13579]</regex> </matcher> <expression>odd.matches(formattedMessage)</expression> </evaluator> <OnMatch>ACCEPT </OnMatch> <OnMismatch>DENY</OnMismatch> </filter> <!-- encoder 默认配置为PatternLayoutEncoder --> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> <target>System.err</target> </appender> <logger name="limeLogback.LogbackDemo" level="debug" additivity="true"> <appender-ref ref="limeFlogger" /> </logger> <root /> </configuration>
Console :
Failed to instantiate [ch.qos.logback.classic.LoggerContext] Reported exception: java.lang.NoClassDefFoundError: org/codehaus/janino/ScriptEvaluator at ch.qos.logback.core.boolex.JaninoEventEvaluatorBase.start(JaninoEventEvaluatorBase.java:57) at ch.qos.logback.core.joran.action.NestedComplexPropertyIA.end(NestedComplexPropertyIA.java:167) at ch.qos.logback.core.joran.spi.Interpreter.callEndAction(Interpreter.java:317) at ch.qos.logback.core.joran.spi.Interpreter.endElement(Interpreter.java:196) at ch.qos.logback.core.joran.spi.Interpreter.endElement(Interpreter.java:182) at ch.qos.logback.core.joran.spi.EventPlayer.play(EventPlayer.java:62) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:149) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:135) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:99) at ch.qos.logback.core.joran.GenericConfigurator.doConfigure(GenericConfigurator.java:49) at ch.qos.logback.classic.util.ContextInitializer.configureByResource(ContextInitializer.java:75) at ch.qos.logback.classic.util.ContextInitializer.autoConfig(ContextInitializer.java:150) at org.slf4j.impl.StaticLoggerBinder.init(StaticLoggerBinder.java:85) at org.slf4j.impl.StaticLoggerBinder.<clinit>(StaticLoggerBinder.java:55) at org.slf4j.LoggerFactory.bind(LoggerFactory.java:128) at org.slf4j.LoggerFactory.performInitialization(LoggerFactory.java:107) at org.slf4j.LoggerFactory.getILoggerFactory(LoggerFactory.java:295) at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:269) at org.slf4j.LoggerFactory.getLogger(LoggerFactory.java:281) at limeLogback.LogbackDemo.<clinit>(LogbackDemo.java:8) Caused by: java.lang.ClassNotFoundException: org.codehaus.janino.ScriptEvaluator at java.net.URLClassLoader.findClass(Unknown Source) at java.lang.ClassLoader.loadClass(Unknown Source) at sun.misc.Launcher$AppClassLoader.loadClass(Unknown Source) at java.lang.ClassLoader.loadClass(Unknown Source) ... 20 more
其他Filter参见官网。
附:
啦啦啦