logback

一、 何为logback ?

Logback是由log4j创始人设计的又一个开源日志组件。
logback当前分成三个模块:logback-core,logback- classic和logback-access。
logback-core是其它两个模块的基础模块。
logback-classic是log4j的一个 改良版本。此外logback-classic完整实现SLF4J API使你可以很方便地更换成其它日志系统如log4j或JDK14 Logging。
logback-access访问模块与Servlet容器集成提供通过Http来访问日志的功能。

二、Logback取代log4j的理由

  1. 自动重新载入配置文件
    Logback-classic可以在配置文件被修改后,自动重新载入。这个扫描过程很快,无资源争用,并且可以动态扩展支持在上百个线程之间每秒上百万个调用。它和应用服务器结合良好,并且在JEE环境通用,因为它不会调用创建一个单独的线程来做扫描。

  2. 自动压缩归档日志文件
    RollingFileAppender可以在回滚操作中,自动压缩归档日志文件。压缩通常是异步执行的,所以即使是很大的日志文件,你的应用都不会因此而被阻塞。

  3. 自动清除旧的日志归档文件
    通过设置TimeBasedRollingPolicy 或者 SizeAndTimeBasedFNATP的 maxHistory 属性,你就可以控制日志归档文件的最大数量。如果你的回滚策略是每月回滚的,并且你希望保存一年的日志,那么只需简单的设置maxHistory属性为12。对于12个月之前的归档日志文件将被自动清除。

  4. 优雅地从I/O错误中恢复
    FileAppender和它的子类,包括RollingFileAppender,可以优雅的从I/O错误中恢复。所以,如果一个文件服务器临时宕机,你再也不需要重启你的应用,而日志功能就能正常工作。当文件服务器恢复工作,logback相关的appender就会透明地和快速的从上一个错误中恢复。

  5. 谨慎模式
    在谨慎模式中,在多个JVM中运行的多个FileAppender实例,可以安全的写入统一个日志文件。谨慎模式可以在一定的限制条件下应用于RollingFileAppender。

  6. Lilith
    Lilith是logback的一个记录和访问事件查看器。它相当于log4j的 chainsaw,但是Lilith设计的目的是处理大量的日志记录。

  7. 配置文件中的条件处理
    开发者通常需要在不同的目标环境中变换logback的配置文件,例如开发环境,测试环境和生产环境。这些配置文件大体是一样的,除了某部分会有不同。为了避免重复,logback支持配置文件中的条件处理,只需使用<if>,<then><else>,那么同一个配置文件就可以在不同的环境中使用了。

  8. 过滤
    Logback拥有远比log4j更丰富的过滤能力。例如,让我们假设,有一个相当重要的商业应用部署在生产环境。考虑到大量的交易数据需要处理,记录级别被设置为WARN,那么只有警告和错误信息才会被记录。现在,想象一下,你在开发环境遇到了一个臭虫,但是在测试平台中却很难发现,因为一些环境之间(生产环境/测试环境)的未知差异。

  9. Logback-access模块,提供了通过HTTP访问日志的能力,是logback不可或缺的组成部分
    最后但绝非最不重要的是,作为logback发布包的一部分,logback-access模块可与Jetty或者Tomcat进行集成,提供了非常丰富而强大的通过HTTP访问日志的功能。因为logback-access模块是logback初期设计方案中的一部分,因此,所有你所喜欢的logback-classic模块所提供的全部特性logback-access同样也具备。

配置

三、logback的配置介绍

 1、Logger、appender及layout
  Logger作为日志的记录器,把它关联到应用的对应的context上后,主要用于存放日志对象,也可以定义日志类型、级别。
  Appender主要用于指定日志输出的目的地,目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等。
  Layout 负责把事件转换成字符串,格式化的日志信息的输出。
 2、logger context
  各个 logger 都被关联到一个 LoggerContext,LoggerContext负责制造logger,也负责以树结构排列各logger。其他所有 logger 也通过 org.slf4j.LoggerFactory 类的静态方法 getLogger 取得。 getLogger 方法以 logger 名称为参数。用同一名字调用 LoggerFactory.getLogger 方法所得到的永远都是同一个 logger对象的引用。
 3、有效级别及级别的继承
  Logger 可以被分配级别。级别包括:TRACE、DEBUG、INFO、WARN 和 ERROR,定义于 ch.qos.logback.classic.Level类。如果 logger没有被分配级别,那么它将从有被分配级别的最近的祖先那里继承级别。root logger 默认级别是 DEBUG。
 4、打印方法与基本的选择规则
   打印方法决定记录请求的级别。例如,如果 L 是一个 logger 实例,那么,语句 L.info(“..”)是一条级别为 INFO的记录语句。记录请求的级别在高于或等于其 logger 的有效级别时被称为被启用,否则,称为被禁用。记录请求级别为 p,其 logger的有效级别为 q,只有则当 p>=q时,该请求才会被执行。
该规则是 logback 的核心。级别排序为: TRACE < DEBUG < INFO < WARN < ERROR

四、logback的默认配置

如果配置文件 logback-test.xml 和 logback.xml 都不存在,那么 logback 默认地会调用BasicConfigurator ,创建一个最小化配置。最小化配置由一个关联到根 logger 的ConsoleAppender 组成。输出用模式为%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n 的 PatternLayoutEncoder 进行格式化。root ,logger 默认级别是 DEBUG。
  1、Logback的配置文件
Logback 配置文件的语法非常灵活。正因为灵活,所以无法用 DTD 或 XML schema 进行定义。尽管如此,可以这样描述配置文件的基本结构:以<configuration>开头,后面有零个或多个<appender>元素,有零个或多个<logger>元素,有最多一个<root>元素。
  2、Logback默认配置的步骤
    (1). 尝试在 classpath下查找文件logback-test.xml;
    (2). 如果文件不存在,则查找文件logback.xml;
    (3). 如果两个文件都不存在,logback用BasicConfigurator自动对自己进行配置,这会导致记录输出到控制台。
    
常用配置

根节点 <configuration> 包含的属性

  • scan : 当此属性设置为 true 时,配置文件如果发生改变,将会被重新加载,默认值为 true。
  • scanPeriod : 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当 scan 为 true 时,此属性生效。默认的时间间隔为 1 分钟。
  • debug : 当属性设置为true,将打印logback内部日志信息,实时查看logback 运行状态。默认值为 false。

Demo :

<configuration scan="true" scanPeriod="60 second" debug="false">  
      <!-- 其他配置省略-->  
</configuration> 

或者

<!-- 也可以默认不填写,那就是为默认值 -->
<configuration>  
      <!-- 其他配置省略-->  
</configuration> 

子节点 appender , logger 和 root

这里写图片描述

  1. 子节点 <contextName>
    设置上下文的名称 <contextName> 每个logger都关联到logger上下文,默认上下文名称为default。但可以使用 <contextName> 设置成其他名字,用于区分不同应用程序的记录。一旦设置,不能修改。
    Demo :

    <configuration scan="true" scanPeriod="60 seconds" debug="false"> 
      <contextName>myAppName</contextName> 
      <!--其他配置省略-->
    </configuration>    
  2. 子节点 <property>
    用来定义变量值,有2个属性 name (变量名称) 和 value (变量定义的值),在logger上下文中,可以使用 ${} 来做替换。
    Demo :

    <configuration scan="true" scanPeriod="60 seconds" debug="false"> 
        <property name="APP_Name" value="myAppName" /> 
        <contextName>${APP_Name}</contextName> 
        <!--其他配置省略--> 
    </configuration>
  3. 子节点 <timestamp>
    获取时间戳字符串,他有两个属性key和datePattern。

    • key : 标识此 的名字。
    • datePattern : 设置将当前时间(解析配置文件的时间)转换为字符串的模式,遵循 java.txt.SimpleDateFormat 的格式。

    Demo :

    <configuration scan="true" scanPeriod="60 seconds" debug="false"> 
        <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/> 
        <contextName>${bySecond}</contextName> 
        <!-- 其他配置省略--> 
    </configuration>
  4. 子节点<loger>
    用于设置某一个包或者具体的某一个类的日志打印级别。以及指定<appender> 。 仅有一个 name 属性,一个可选的 level 和一个可选的 addtivity 属性。

    • name: 用来指定受此 loger 约束的某一个包或者具体的某一个类。
    • level : 用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,还有一个特俗值INHERITED或者同义词NULL,代表强制执行上级的级别。
      如果未设置此属性,那么当前loger将会继承上级的级别。
    • addtivity: 是否向上级loger传递打印信息。默认是true。

      <loger>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。
      <root> : 也是loger 元素,但是它是根 loger 。只有一个 level 属性。

    • level :用来设置打印级别,大小写无关:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能设置为INHERITED或者同义词NULL。默认是DEBUG。

    <root>可以包含零个或多个<appender-ref>元素,标识这个appender将会添加到这个loger。

    Demo :

    1、只配置 root
    
    <configuration>
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
            <!-- encoder 默认配置为PatternLayoutEncoder -->
            <encoder>
                <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
            </encoder>
        </appender>
        <root level="INFO">
            <appender-ref ref="STDOUT" />
        </root>
    </configuration>

    其中appender的配置表示打印到控制台;
    <root level="INFO"> 将root的打印级别设置为“INFO”,指定了名字为“STDOUT”的appender。
    当执行logback.LogbackDemo类的main方法时,root将级别为“INFO”及大于“INFO”的日志信息交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

    2、带有loger的配置,不指定级别,不指定appender
    
    <configuration>
      <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
      <!-- encoder 默认配置为PatternLayoutEncoder -->
      <encoder>
        <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
      </encoder>
      </appender>
      <!-- logback为java中的包 -->
      <logger name="logback"/>
      <root level="DEBUG">
        <appender-ref ref="STDOUT" />
      </root>  
    </configuration>

      其中appender的配置表示打印到控制台;
       <logger name="logback" />将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级<root>的日志级别“DEBUG”;
      没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
      没有设置appender,此loger本身不打印任何信息。
      <root level="DEBUG">将root的打印级别设置为“DEBUG”,指定了名字为“STDOUT”的appender。
      当执行logback.LogbackDemo类的main方法时,因为LogbackDemo 在包logback中,所以首先执行<logger name="logback" />,将级别为“DEBUG”及大于“DEBUG”的日志信息传递给root,本身并不打印;
       root接到下级传递的信息,交给已经配置好的名为“STDOUT”的appender处理,“STDOUT”appender将信息打印到控制台;

    3、带有多个loger的配置,指定级别,指定appender  
    
    <configuration>
       <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <encoder>
          <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
      </appender>
    
      <!-- logback为java中的包 -->
      <logger name="logback"/>
      <!--logback.LogbackDemo:类的全路径 -->
      <logger name="logback.LogbackDemo" level="INFO" additivity="false">
        <appender-ref ref="STDOUT"/>
      </logger>
    
      <root level="ERROR">
        <appender-ref ref="STDOUT" />
      </root>
    </configuration>

    <logger name="logback" />将控制logback包下的所有类的日志的打印,但是并没用设置打印级别,所以继承他的上级<root>的日志级别“DEBUG”;
    没有设置addtivity,默认为true,将此loger的打印信息向上级传递;
    没有设置appender,此loger本身不打印任何信息。

    <logger name="logback.LogbackDemo" level="INFO" additivity="false">控制logback.LogbackDemo类的日志打印,打印级别为“INFO”;
    additivity属性为false,表示此loger的打印信息不再向上级传递,
    指定了名字为“STDOUT”的appender。

    <root level="DEBUG">将root的打印级别设置为“ERROR”,指定了名字为“STDOUT”的appender。

    当执行logback.LogbackDemo类的main方法时,先执行<logger name="logback.LogbackDemo" level="INFO" additivity="false">,将级别为“INFO”及大于“INFO”的日志信息交给此loger指定的名为“STDOUT”的appender处理,在控制台中打出日志,不再向次loger的上级 <logger name="logback"/> 传递打印信息;
    <logger name="logback"/>未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;

    如果将 <logger name="logback.LogbackDemo" level="INFO" additivity="false"> 修改为  <logger name="logback.LogbackDemo" level="INFO" additivity="true"> 如何?
    将会被打印2次。

  5. 子节点 <appender>
    这里写图片描述
    负责写日志的组件,它有两个必要属性name和class。name指定appender名称,class指定appender的全限定名。
    ConsoleAppender 把日志输出到控制台
    <encoder> : 对日志进行格式化。
    <target> : 字符串 system.out (默认) 或者 System.err
    Demo :

    <configuration> 
        <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 
            <encoder> 
                <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern> 
            </encoder> 
    </appender> 
        <root level="DEBUG"> 
            <appender-ref ref="STDOUT" /> 
        </root> 
    </configuration>

    上述配置表示把>=DEBUG级别的日志都输出到控制台

    FileAppender 把日志添加到文件
    <file> : 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值
    <append>:如果是 true,日志被追加到文件结尾,如果是 false,清空现存文件,默认是true。
    <encoder>:对记录事件进行格式化。(具体参数稍后讲解 )
    <prudent>:如果是 true,日志会被安全的写入文件,即使其他的FileAppender也在向此文件做写入操作,效率低,默认是 false。
    Demo:

    <configuration> 
        <appender name="FILE" class="ch.qos.logback.core.FileAppender"> 
            <file>testFile.log</file> 
            <append>true</append> 
            <encoder> 
                <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern> 
            </encoder> 
        </appender> 
        <root level="DEBUG"> 
        <appender-ref ref="FILE" /> 
        </root> 
    </configuration>

    上述配置表示把>=DEBUG级别的日志都输出到testFile.log

    RollingFileAppender
    滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。

    • <file> :被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建,没有默认值。
    • <append>:true 日志被追加到文件结尾,false 清空现存文件。(默认是true)。
    • <encoder>:对记录事件进行格式化。
    • <rollingPolicy>:当发生滚动时,决定 RollingFileAppender 的行为,涉及文件移动和重命名。
    • <triggeringPolicy >:告知 RollingFileAppender 合适激活滚动。
    • <prudent>:当为true时,不支持FixedWindowRollingPolicy。支持 TimeBasedRollingPolicy,但是有两个限制,1不支持也不允许文件压缩,2不能设置file属性,必须留空。

    rollingPolicy:

    • TimeBasedRollingPolicy:最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动。有以下子节点:

      • <fileNamePattern>:必要节点,包含文件名及“%d”转换符, “%d”可以包含一个 Java.text.SimpleDateFormat 指定的时间格式,如: %d{yyyy-MM}。如果直接使用 %d,默认格式是 yyyy-MM-dd 。 RollingFileAppender 的 file 字节点可有可无,通过设置 file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到 file 指定的文件(活动文件),活动文件的名字不会改变;如果没设置file,活动文件的名字会根据 fileNamePattern 的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
      • <maxHistory>:可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,且<maxHistory>是6,则只保存最近6个月的文件,删除之前的旧文件。注意,删除旧文件是,那些为了归档而创建的目录也会被删除。
    • FixedWindowRollingPolicy:根据固定窗口算法重命名文件的滚动策略。有以下子节点:

      • <minIndex>:窗口索引最小值
      • <maxIndex>:窗口索引最大值,当用户指定的窗口过大时,会自动将窗口设置为12。
      • <fileNamePattern>:必须包含“%i”例如,假设最小值和最大值分别为1和2,命名模式为 mylog%i.log ,会产生归档文件 mylog1.log 和 mylog2.log 。还可以指定文件压缩选项,例如, mylog%i.log.gz 或者没有 log%i.log.zip。

    triggeringPolicy:

    • sizeBasedTriggeringPolicy: 查看当前活动文件的大小,如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只有一个节点:
      • <maxFileSize>:这是活动文件的大小,默认值是10MB。

    Demo :
    每天生成一个日志文件,保存30天的日志文件。

    <configuration>
      <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
          <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>
          <maxHistory>30</maxHistory>
        </rollingPolicy>
        <encoder>
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
        </encoder>
      </appender>
      <root level="DEBUG">   
        <appender-ref ref="FILE" />   
      </root>   
    </configuration> 

    按照固定窗口模式生成日志文件,当文件大于20MB时,生成新的日志文件。窗口大小是1到3,当保存了3个归档文件后,将覆盖最早的日志。

    <configuration>   
      <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
        <file>test.log</file>   
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">   
          <fileNamePattern>tests.%i.log.zip</fileNamePattern>
          <minIndex>1</minIndex>
          <maxIndex>3</maxIndex>
        </rollingPolicy>
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">   
          <maxFileSize>5MB</maxFileSize>   
        </triggeringPolicy>   
        <encoder>   
          <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
        </encoder>   
      </appender>   
    
      <root level="DEBUG">   
        <appender-ref ref="FILE" />   
      </root>   
    </configuration> 

    <encoder>:负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。
    目前PatternLayoutEncoder 是唯一有用的且默认的encoder ,有一个节点,用来设置日志的输入格式。使用“%”加“转换符”方式,如果要输出“%”,则必须用“\”对“\%”进行转义。

    <encoder>
        <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
    </encoder>

<pattern> 里面的转换符说明:














转换符作用
c {length } 
lo {length } 
logger {length } 
输出日志的logger名,可有一个整形参数,功能是缩短logger名,设置为0表示只输入logger最右边点符号之后的字符串。
Conversion specifierLogger nameResult
%loggermainPackage.sub.sample.BarmainPackage.sub.sample.Bar
%logger{0}mainPackage.sub.sample.BarBar
%logger{5}mainPackage.sub.sample.Barm.s.s.Bar
%logger{10}mainPackage.sub.sample.Barm.s.s.Bar
%logger{15}mainPackage.sub.sample.Barm.s.sample.Bar
%logger{16}mainPackage.sub.sample.Barm.sub.sample.Bar
%logger{26}mainPackage.sub.sample.BarmainPackage.sub.sample.Bar
C {length } 
class {length } 
输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用,除非执行速度不造成任何问题。
contextName 
cn 
输出上下文名称。
d {pattern } 
date {pattern } 
输出日志的打印日志,模式语法与java.text.SimpleDateFormat 兼容。
Conversion PatternResult
%d2006-10-20 14:06:49,812
%date2006-10-20 14:06:49,812
%date{ISO8601}2006-10-20 14:06:49,812
%date{HH:mm:ss.SSS}14:06:49.812
%date{dd MMM yyyy ;HH:mm:ss.SSS}20 oct. 2006;14:06:49.812
F / file输出执行记录请求的java源文件名。尽量避免使用,除非执行速度不造成任何问题。
caller{depth}caller{depth, evaluator-1, … evaluator-n}输出生成日志的调用者的位置信息,整数选项表示输出信息深度。
例如, %caller{2}   输出为:
0    [main] DEBUG - logging statement  
Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)

例如, %caller{3}   输出为:
16   [main] DEBUG - logging statement  
Caller+0 at mainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)
Caller+1 at mainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)
Caller+2 at mainPackage.ConfigTester.main(ConfigTester.java:38)

L / line输出执行日志请求的行号。尽量避免使用,除非执行速度不造成任何问题。
m / msg / message
输出应用程序提供的信息。
M / method输出执行日志请求的方法名。尽量避免使用,除非执行速度不造成任何问题。
n输出平台先关的分行符“\n”或者“\r\n”。
p / le / level输出日志级别。
r / relative输出从程序启动到创建日志记录的时间,单位是毫秒
t / thread输出产生日志的线程名。
replace(p ){r, t} p 为日志内容,r 是正则表达式,将p 中符合r 的内容替换为t 。例如, “%replace(%msg){‘\s’, ”}”

格式修饰符,与转换符共同使用:
可选的格式修饰符位于“%”和转换符之间。
第一个可选修饰符是左对齐 标志,符号是减号“-”;接着是可选的最小宽度 修饰符,用十进制数表示。如果字符小于最小宽度,则左填充或右填充,默认是左填充(即右对齐),填充符为空格。如果字符大于最小宽度,字符永远不会被截断。最大宽度 修饰符,符号是点号"."后面加十进制数。如果字符大于最大宽度,则从前面截断。点符号“.”后面加减号“-”在加数字,表示从尾部截断。(%-4relative 表示,将输出从程序启动到创建日志记录的时间 进行左对齐 且最小宽度为4。)

<filter> :
过滤器,执行一个过滤器会有返回个枚举值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志将立即被抛弃不再经过其他过滤器;返回NEUTRAL,有序列表里的下个过滤器过接着处理日志;返回ACCEPT,日志会被立即处理,不再经过剩余过滤器。
过滤器被添加到 <Appender> 中,为 <Appender> 添加一个或多个过滤器后,可以用任意条件对日志进行过滤。<Appender> 有多个过滤器时,按照配置顺序执行。

LevelFilter: 级别过滤器,根据日志级别进行过滤。如果日志级别等于配置级别,过滤器会根据onMath 和 onMismatch接收或拒绝日志。有以下子节点:
- <level>:设置过滤级别
- <onMatch>:用于配置符合过滤条件的操作
- <onMismatch>:用于配置不符合过滤条件的操作

例如:将过滤器的日志级别配置为INFO,所有INFO级别的日志交给appender处理,非INFO级别的日志,被过滤掉。

<configuration>   
  <appender name="CONSOLE" 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>   
      <pattern>   
        %-4relative [%thread] %-5level %logger{30} - %msg%n   
      </pattern>   
    </encoder>   
  </appender>   
  <root level="DEBUG">   
    <appender-ref ref="CONSOLE" />   
  </root>   
</configuration>

ThresholdFilter: 临界值过滤器,过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时,过滤器返回NEUTRAL;当日志级别低于临界值时,日志会被拒绝。
例如:过滤掉所有低于INFO级别的日志。

<configuration>   
  <appender name="CONSOLE"   
    class="ch.qos.logback.core.ConsoleAppender">   
    <!-- 过滤掉 TRACE 和 DEBUG 级别的日志-->   
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">   
      <level>INFO</level>   
    </filter>   
    <encoder>   
      <pattern>   
        %-4relative [%thread] %-5level %logger{30} - %msg%n   
      </pattern>   
    </encoder>   
  </appender>   
  <root level="DEBUG">   
    <appender-ref ref="CONSOLE" />   
  </root>   
</configuration> 

EvaluatorFilter: 求值过滤器,评估、鉴别日志是否符合指定条件。需要额外的两个JAR包,commons-compiler.jar和janino.jar有以下子节点:
<evaluator> : 鉴别器,常用的鉴别器是 JaninoEventEvaluato,也是默认的鉴别器,它以任意的java布尔值表达式作为求值条件,求值条件在配置文件解释过成功被动态编译,布尔值表达式返回true就表示符合过滤条件。 evaluator有个子标签 <expression>,用于配置求值条件。

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

NameTypeDescription
eventLoggingEvent与记录请求相关联的原始记录事件,下面所有变量都来自event,例如,event.getMessage()返回下面”message”相同的字符串
messageString日志的原始消息,例如,设有logger mylogger,”name”的值是”AUB”,对于 mylogger.info(“Hello {}”,name); “Hello {}”就是原始消息。
formatedMessageString日志被各式话的消息,例如,设有logger mylogger,”name”的值是”AUB”,对于 mylogger.info(“Hello {}”,name); “Hello Aub”就是格式化后的消息。
loggerStringlogger 名。
loggerContextLoggerContextVO日志所属的logger上下文。
levelint级别对应的整数值,所以 level > INFO 是正确的表达式。
timeStamplong创建日志的时间戳。
markerMarker与日志请求相关联的Marker对象,注意“Marker”有可能为null,所以你要确保它不能是null。
mdcMap包含创建日志期间的MDC所有值得map。访问方法是: mdc.get(“myKey”) 。mdc.get()返回的是Object不是String,要想调用String的方法就要强转,例如((String) mdc.get(“k”)).contains(“val”) .MDC可能为null,调用时注意。
throwablejava.lang.Throwable如果没有异常与日志关联”throwable” 变量为 null. 不幸的是, “throwable” 不能被序列化。在远程系统上永远为null,对于与位置无关的表达式请使用下面的变量throwableProxy
throwableProxyIThrowableProxy与日志事件关联的异常代理。如果没有异常与日志事件关联,则变量”throwableProxy” 为 null. 当异常被关联到日志事件时,”throwableProxy” 在远程系统上不会为null

<onMatch>: 用于配置符合过滤条件的操作
<onMismatch>: 用于配置不符合过滤条件的操作

例如:过滤掉所有日志消息中不包含“billing”字符串的日志。

<configuration>
  <appender name="STDOUT" 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>   
      <pattern>   
        %-4relative [%thread] %-5level %logger - %msg%n   
      </pattern>   
    </encoder>   
  </appender>   

  <root level="INFO">   
    <appender-ref ref="STDOUT" />   
  </root>   
</configuration>

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

Demo:

<configuration debug="true">
  <appender name="STDOUT" 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>
      <OnMismatch>NEUTRAL</OnMismatch>
      <OnMatch>DENY</OnMatch>
    </filter>
    <encoder>
      <pattern>%-4relative [%thread] %-5level %logger - %msg%n</pattern>   
    </encoder>   
  </appender>   
  <root level="DEBUG">   
    <appender-ref ref="STDOUT" />   
  </root>   
</configuration> 
  • 1
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值