logback--基础--06--配置--filter

logback–基础–06–配置–filter

---

代码位置

https://gitee.com/DanShenGuiZu/learnDemo/tree/master/logback-learn

1、节点< appender>的子节点< filter>

1. 过滤器
2. 执行一个过滤器会有返回个枚举值
   1. DENY：日志将立即被抛弃不再经过其他过滤器
   2. NEUTRAL：给有序列表里的下个过滤器接着处理日志
   3. ACCEPT：日志会被立即处理，不再经过剩余过滤器
3. < appender> 添加一个或多个过滤器后，可以用任意条件对日志进行过滤。
4. < appender> 有多个过滤器时，按照配置顺序执行。

2、常用的过滤器

1. LevelFilter
2. ThresholdFilter
3. EvaluatorFilter

3、LevelFilter

1. 级别过滤器
2. 根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据 onMath 和 onMismatch 接收或拒绝日志。

3.1、属性

3.1.1、< level>

设置过滤级别。

3.1.2、< onMatch>

用于配置符合过滤条件的操作。

3.1.3、< onMismatch>

用于配置不符合过滤条件的操作。

3.2、测试

将过滤器的日志级别配置为info，所有info级别的日志交给appender处理，非info级别的日志，被过滤掉。

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">


    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!--设置过滤级别info-->
            <level>info</level>
            <!--所有info级别的日志交给appender处理-->
            <onMatch>ACCEPT</onMatch>
            <!--非info级别的日志，被过滤掉-->
            <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="fei.zhou.logbacklearn.business.demo.Demo3" level="debug" additivity="true">
        <appender-ref ref="limeFlogger"/>
    </logger>

    <root/>

</configuration>

4、ThresholdFilter

1. 临界值过滤器,过滤掉低于指定临界值的日志
2. 当日志级别等于或高于临界值时，过滤器返回NEUTRAL
3. 当日志级别低于临界值时，日志会被拒绝。

4.1、属性

4.1.1、< level>

设置过滤级别。

4.2、测试

过滤掉所有低于info级别的日志

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <!--临界值过滤器,过滤掉低于指定临界值的日志-->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <!--过滤掉所有低于info级别的日志-->
            <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="fei.zhou.logbacklearn.business.demo.Demo3" level="debug" additivity="true">
        <appender-ref ref="limeFlogger"/>
    </logger>

    <root/>

</configuration>

5、EvaluatorFilter

1. 求值过滤器
2. 评估、鉴别日志是否符合指定条件

5.1、属性

5.1.1、< evaluator>

1. 鉴别器
2. 默认鉴别器：JaninoEventEvaluato
   1. 它以任意的Java布尔值表达式作为求值条件，布尔值表达式返回true就表示符合过滤条件。

5.1.2、< onMatch>

用于配置符合过滤条件的操作。

5.1.3、< onMismatch>

用于配置不符合过滤条件的操作。

5.1.4、< matcher>

1. 匹配器，是< evaluator>的子标签。
2. 尽管可以使用String类的matches()方法进行模式匹配，但会导致每次调用过滤器时都会创建一个新的Pattern对象，为了消除这种开销，可以预定义一个或多个matcher对象，这样以后就可以在求值表达式中重复引用
3. 包含两个子标签
   1. < name>：用于定义matcher的名字，求值表达式中使用这个名字来引用matcher
   2. < regex>:：用于配置匹配条件。

5.1.5、< expression>

1. 用于配置求值条件
2. 是< evaluator>的子标签

5.2、求值表达式作用于当前日志，logback向求值表达式暴露日志的各种字段

5.3、测试–>过滤掉所有日志消息中不包含"billing"字符串的日志。

5.3.1、添加依赖

<dependency>
        <groupId>org.codehaus.janino</groupId>
        <artifactId>janino</artifactId>
        <version>3.0.7</version>
    </dependency>

5.3.2、logback.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 -->
                <!--过滤掉所有日志消息中不包含"aaa"字符串的日志。-->
                <expression>return message.contains("aaa");</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="fei.zhou.logbacklearn.business.demo.Demo4" level="debug" additivity="true">
        <appender-ref ref="limeFlogger" />
    </logger>

    <root />

</configuration>

5.4、测试–>过滤掉所有日志消息中不包含"statement 1"，"statement 3"的字符串的日志。

5.4.1、添加依赖

<?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>
                    <!--用于定义matcher的名字，求值表达式中使用这个名字来引用matche-->
                    <Name>odd</Name>
                    <!--用于配置匹配条件-->
                    <regex>statement [13]</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="fei.zhou.logbacklearn.business.demo.Demo4" level="debug" additivity="true">
        <appender-ref ref="limeFlogger" />
    </logger>

    <root />

</configuration>