Logback中如何自定义灵活的日志过滤规则

Logback 提供两种类型的过滤器，常规过滤器和turbo过滤器。本例讲述基于常规过滤器的自定义实现。

常规过滤器

常规的logback-classic过滤器扩展了 ​​Filter​​​ 抽象类，它基本上由一个​​decide()​​​以​​ILoggingEvent​​ 实例作为参数的方法组成 。

过滤器基于三元逻辑。​​decide(ILoggingEvent event)​​​按顺序调用每个过滤器的方法。此方法返回的一个 ​​FilterReply​​​ 枚举值，即​​DENY​​​、 ​​NEUTRAL​​​或​​ACCEPT​​。

在 logback 中，可以将过滤器添加到 ​​Appender​​ 实例中。通过向 appender 添加一个或多个过滤器，可以按任意条件过滤事件。

在Logback中自带了两个过滤器实现：

• ch.qos.logback.classic.filter.LevelFilter
• ch.qos.logback.classic.filter.ThresholdFilter

用户可以根据需要来配置一些简单的过滤规则，下面先简单介绍一下这两个原生的基础过滤器。

内置过滤器

LevelFilter过滤器

ch.qos.logback.classic.filter.LevelFilter 过滤器的作用： 通过比较日志级别来控制日志输出。

下面是一个只记录日志级别为ERROR的例子：

<appender name="ERROR_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/error.log</file>ds
    <filter class="ch.qos.logback.classic.filter.LevelFilter">
        <level>ERROR</level>
        <onMatch>ACCEPT</onMatch>
        <onMismatch>DENY</onMismatch>
    </filter>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{30} - %msg%n</pattern>
    </encoder>
</appender>

ThresholdFilter过滤器

LevelFilter 通过定义日志级别，并设置匹配与不匹配的处理策略来控制针对某个级别日志的输出策略。当我们要 ​​设置多个不同级别的日志策略​​ 的时候，如果仅依靠这个过滤器，我们就要级联的定义多个filter来控制才能实现，显然不是很方便，所以此时我们就可以使用 ch.qos.logback.classic.filter.ThresholdFilter 过滤器来控制了。比如下面的配置，实现了只记录WARN及以上级别的控制，比WARN级别低（如：INFO、DEBUG、TRACE）都不会记录。

<appender name="WARN_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/warn_error.log</file>
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
        <level>WARN</level>
    </filter>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{30} - %msg%n</pattern>
    </encoder>
</appender>

自定义过滤器

通过上述介绍的两个过滤器来控制日志的记录级别已经满足绝大部分的需求，但是可能还是会出现一些特殊情况，需要自定义复杂的过滤规则，比如想过滤掉一些框架中的日志，通过自带的几个过滤器已经无法完全控制，并且也不希望修改框架源码来实现。这个时候，我们就可以自己来实现过滤器，并配置使用。实现的方式也很简单，只需要实现Logback提供的​​ch.qos.logback.core.filter.Filter​​接口即可。

自定义普通过滤器

下面举一个简单的例子：

public class MyFilter extends Filter<ILoggingEvent> {

    @Override
    public FilterReply decide(ILoggingEvent event) {
        if (event.getLevel() == Level.ERROR) {
            switch (event.getLoggerName()) {
                case "org.springframework.cloud.sleuth.instrument.web.ExceptionLoggingFilter":
                    return FilterReply.DENY;
            }
            return FilterReply.ACCEPT;
        }
        return FilterReply.DENY;
    }

}

上面过滤器的功能主要是通过重写​​decide​​​，限制了​​org.springframework.cloud.sleuth.instrument.web.ExceptionLoggingFilter​​类输出ERROR级别的日志记录。在编写好自己的过滤器实现之后，只需要在Appender中配置使用就能实现自己需要的灵活过滤规则了：

<appender name="WARN_APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>logs/warn_error.log</file>
    <filter class="com.didispace.log.filter.ExceptionClassFilter"></filter>
    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{30} - %msg%n</pattern>
    </encoder>
</appender>

自定义带属性过滤器

如果想设置过滤器的属性或子组件也很容易。在过滤器类中添加相应的setter方法后，在属性命名的xml元素中指定属性的值，并将其嵌套在​​<filter>​​ 元素中。

如将 SampleFilter 中的用于判断的字符串 “sample” 字符提取到配置文件中：

• SampleFilter 增加属性 ​​flag​​，并提供 set 方法。

public class SampleFilter extends Filter<ILoggingEvent> {
  private String flag;

  @Override
    public FilterReply decide(ILoggingEvent event) {    
      if (event.getMessage().contains(flag)) {
          return FilterReply.ACCEPT;
      } else {
        return FilterReply.NEUTRAL;
      }
    }

    public void setFlag(String flag) {
      this.flag = flag;
    }
}

• 在配置文件中指定 ​​flag​​ 的值。

<configuration>
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <filter class="chapters.filters.SampleFilter">
           <flag>sample</flag>
       </filter>
       <encoder>
           <pattern>
               %-4relative [%thread] %-5level %logger - %msg%n
           </pattern>
       </encoder>
   </appender>
   <root>
       <appender-ref ref="STDOUT"/>
   </root>
</configuration>

References

• ​​logback官方文档-过滤器​​
• ​​Logback中如何自定义灵活的日志过滤规则​​
• ​​自定义 logback 日志过滤器​​
• ​​java日志框架系列（9）：logback框架过滤器（filter）详解​​