logback 日志 介绍和配置详解

日志的级别知识：常用日志框架

logback介绍和配置详解

logback是Java的开源框架，性能比log4j要好。是springboot自带的日志框架。该框架主要有3个模块：

logback-core：核心代码块（不介绍）

log back-classic：实现了slf4j的api，加入该依赖可以实现log4j的api。

log back-access：访问模块与servlet容器集成提供通过http来访问日志的功能（也就是说不需要访问服务器，直接在网页上就可以访问日志文件,实现HTTP访问日志的功能）。

一、logback的使用

引入maven依赖

       
       
            ch.qos.logback
            logback-core
            1.2.3
       

       
       
            ch.qos.logback
            logback-classic
            1.2.3
            test
       

二、logback.xml格式详解

1、configuration

根节点，包含下面三个属性：

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

 　

子节点contextName

用来设置上下文名称

每个logger都关联到logger上下文，默认上下文名称为“default”。但可以使用设置成其他名字，用于区分不同应用程序的记录。一旦设置，不能修改。

  
      myAppName  
        

2、Property

子节点 ：用来定义变量值，它有两个属性name和value，通过定义的值会被插入到logger上下文中，可以使“${}”来使用变量。

name: 变量的名称
value: 的值时变量定义的值

  
　   
　${APP_Name}  
　  
   

3、timestamp

子节点：获取时间戳字符串，他有两个属性key和datePattern

  
　　   
　　${bySecond}  
　　  
   

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

4、Appender

子节点：负责写日志的组件，它有两个必要属性name和class。name指定appender名称，class指定appender的全限定名

appender class 类型主要有三种：ConsoleAppender、FileAppender、RollingFileAppender

4.1 ConsoleAppender 

把日志输出到控制台，有以下子节点：

：对日志进行格式化。

： 字符串 System.out 或者 System.err ，默认 System.out ；

详情参考 logback -- 配置详解 -- 三 -- - limeOracle - 博客园

：字符串System.out(默认)或者System.err（区别不多说了）

4.2 FileAppender

把日志添加到文件，有以下子节点：

 ：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

：对记录事件进行格式化。（具体参数稍后讲解 ）

：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是false。

4.3 RollingFileAppender

4.3.1 节点类型

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。有以下子节点：

：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。

： 对记录事件进行格式化。 

：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。

: 当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类

class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"，是最受欢迎的滚动政策，例如按天或按月。 TimeBasedRollingPolicy承担翻滚责任以及触发所述翻转的责任。TimeBasedRollingPolicy支持自动文件压缩。

          : 归档的日志文件的路径

         : 告知 RollingFileAppender 何时激活滚动。

         : 可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件时，那些为了归档而创建的目录也会被删除。

有时您可能希望按日期归档文件，但同时限制每个日志文件的大小，特别是如果后处理工具对日志文件施加大小限制。为了满足这一要求，logback随附 SizeAndTimeBasedRollingPolicy。

例子

  
  
      ${log.filePath}/logback/logback_info-%d{yyyy-MM-dd}.%i.log
  
  
  ${log.append}
  
  ${log.maxHistory}
  
  10GB

  
  
      
      ${log.maxSize}
  

请注意除“％d”之外的“％i”转换标记。％i和％d令牌都是强制性的。每当当前日志文件在当前时间段结束之前达到maxFileSize时，它将以增加的索引存档，从0开始。

4.3.2 策略

1、rollingPolicy滚动策略

（1）TimeBasedRollingPolicy ： 常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责触发滚动。有以下子节点：

: 必要节点，包含文件名及“%d”转换符， “%d”可以包含一个Java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。

RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），  活动文件的名字不会改变

（意思是最新日志在file节点指定文件下，滚动时重命名旧日志文件）； 如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。

（2） FixedWindowRollingPolicy ： 根据固定窗口算法重命名文件的滚动策略。有以下子节点：

: 窗口索引最小值。

: 窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。

: 必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者 没有log%i.log.zip。

2、triggeringPolicy触发策略

SizeBasedTriggeringPolicy ： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender触发当前活动文件滚动。只有一个节点:

: 这是活动文件的大小，默认值是10MB。

4.4、filter

过滤器，执行一个过滤器会有返回个枚举值，即DENY，NEUTRAL，ACCEPT其中之一。

DENY：日志将立即被抛弃不再经过其他过滤器；

NEUTRAL：有序列表里的下个过滤器过接着处理日志；

ACCEPT：日志会被立即处理，不再经过剩余过滤器。

过滤器被添加到 中，为 添加一个或多个过滤器后，可以用任意条件对日志进行过滤。 有多个过滤器时，按照配置顺序执行。

常用的过滤器 ： 

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

有以下子节点 ： 

: 设置过滤级别。

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

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

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

    
    
    ${contextName} - ${bySecond}
    
    
    
        
            info
            ACCEPT
            DENY
        
         
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
        System.err
    
    
    
        
    
    
    

19:40:59.567 [main] INFO  limeLogback.LogbackDemo - ------info

 4.4.2、ThresholdFilter ： 临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL；当日志级别低于临界值时，日志会被拒绝。

有以下子节点 : 

　 : 设置过滤级别。

例如：过滤掉所有低于info级别的日志。

    
    
    ${contextName} - ${bySecond}
    
    
    
        
            info
        
         
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
        System.err
    
    
    
        
    
    
    

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

4.4.3、EvaluatorFilter ： 求值过滤器，评估、鉴别日志是否符合指定条件。

有以下子节点：

　 : 鉴别器，常用的鉴别器是JaninoEventEvaluato，也是默认的鉴别器，它以任意的Java布尔值表达式作为求值条件，求值条件在配置文件解释过成功被动态编译，布尔值表达式返回true就表示符合过滤条件。

　evaluator有个子标签，用于配置求值条件。

求值表达式作用于当前日志，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的方法就要强转，例如， ((String) mdc.get("k")).contains("val") .MDC可能为null，调用时注意。
throwable	java.lang.Throwable	如果没有异常与日志关联"throwable" 变量为 null. 不幸的是， "throwable" 不能被序列化。在远程系统上永远为null，对于与位置无关的表达式请使用下面的变量throwableProxy
throwableProxy	IThrowableProxy	与日志事件关联的异常代理。如果没有异常与日志事件关联，则变量"throwableProxy" 为 null. 当异常被关联到日志事件时，"throwableProxy" 在远程系统上不会为null

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

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

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

    
    
    ${contextName} - ${bySecond}

    
    
        
            
                
                return message.contains("billing");
            
            ACCEPT 
            DENY
        
        
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
        System.err
    

    
        
    

    

： 匹配器，尽管可以使用String类的matches()方法进行模式匹配，但会导致每次调用过滤器时都会创建一个新的Pattern对象，为了消除这种开销，可以预定义一个或多个matcher对象，定以后就可以在求值表达式中重复引用。是的子标签。

中包含两个子标签，一个是，用于定义matcher的名字，求值表达式中使用这个名字来引用matcher；另一个是，用于配置匹配条件。

    
    
    ${contextName} - ${bySecond}

    
    
        
            
                
                    odd
                    
                    statement [13579]
                

                odd.matches(formattedMessage)
            
            ACCEPT 
            DENY
        
        
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
        System.err
    

    
        
    

    

4.5、encoder

节点<appender>的子节点<encoder>：

： 负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。

目前PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。

        limeFileLogger.log
        true
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
        false
    

里面的转换符说明：

转换符	作用
c {length }  lo {length }  logger {length }	输出日志的logger名，可有一个整形参数，功能是缩短logger名，设置为0表示只输入logger最右边点符号之后的字符串。 Conversion specifier Logger name Result %logger mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar %logger{0} mainPackage.sub.sample.Bar Bar %logger{5} mainPackage.sub.sample.Bar m.s.s.Bar %logger{10} mainPackage.sub.sample.Bar m.s.s.Bar %logger{15} mainPackage.sub.sample.Bar m.s.sample.Bar %logger{16} mainPackage.sub.sample.Bar m.sub.sample.Bar %logger{26} mainPackage.sub.sample.Bar mainPackage.sub.sample.Bar
C {length }  class {length }	输出执行记录请求的调用者的全限定名。参数与上面的一样。尽量避免使用，除非执行速度不造成任何问题。
contextName  cn	输出上下文名称。
d {pattern }  date {pattern }	输出日志的打印日志，模式语法与java.text.SimpleDateFormat 兼容。 Conversion Pattern Result %d 2006-10-20 14:06:49,812 %date 2006-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。

5、 logger

用来设置某一个包或者具体的某一个类的日志打印级别、以及指定。

仅有一个name属性，一个可选的level和一个可选的addtivity属性。

name：用来指定受此loger约束的某一个包或者具体的某一个类。

level：用来设置打印级别（日志级别），大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。如果未设置此属性，那么当前loger将会继承上级的级别。

addtivity：是否向上级loger传递打印信息，满足logger级别的信息，会传递给上级打印。默认是true。这个上级指包的上级，类似js 的事件冒泡，所以下面的root 可以说是所有的logger上级

按照范围从小到大排序：OFF level > FATAL > ERROR > WARN > INFO > DEBUG > ALL level；范围大的会包含范围小的，例如日志设置为INFO级别的话则FATAL、ERROR、WARN、INFO的日志开关都是打开的，而DEBUG的日志开关将是关闭的。

1.若是additivity设为false，则子Logger只会在自己的appender里输出，不会在root的logger的appender里输出（个人可以理解为additivity设为false后，子Logger会覆盖掉root的logger）。

2.若是additivity设为true，则子Logger不止会在自己的appender里输出，还会在root的logger的appender里输出

可以包含零个或多个元素，标识这个appender将会添加到这个loger。

6、root

也是元素，但是它是根loger。只有一个level属性，因为已经被命名为"root".
level:用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。默认是DEBUG。

可以包含零个或多个元素，标识这个appender将会添加到这个loger。

例子：

package limeLogback;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class LogbackDemo {

    private static final Logger limeFloger = LoggerFactory.getLogger(LogbackDemo.class);
    
    public static void main(String[] args) {
        limeFloger.trace("------trace");
        limeFloger.debug("------debug");
        limeFloger.info("------info");
        limeFloger.warn("------warn");
        limeFloger.error("------error");
    }
}

第1种：只配置root

    
    
    ${contextName} - ${bySecond}
    
    
    
         
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
    
        
    

结果：

22:19:17.841 [main] DEBUG limeLogback.LogbackDemo - ------debug
22:19:17.843 [main] INFO  limeLogback.LogbackDemo - ------info
22:19:17.844 [main] WARN  limeLogback.LogbackDemo - ------warn
22:19:17.844 [main] ERROR limeLogback.LogbackDemo - ------error

其中appender的配置表示打印到控制台；

将root的打印级别设置为默认值“DEBUG”，指定了名字为“limeFlogger”的appender。

当执行limeLogback.LogbackDemo类的main方法时，root将级别为“DEBUG”及大于“DEBUG”的日志信息交给已经配置好的名为“limeFlogger”的appender处理，“limeFlogger”appender将信息打印到控制台；

第2种：带有loger的配置，不指定级别，不指定appender

    
    
    ${contextName} - ${bySecond}
    
    
    
         
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
    
    
    
    
        
    

结果：

22:30:57.225 [main] INFO  limeLogback.LogbackDemo - ------info
22:30:57.227 [main] WARN  limeLogback.LogbackDemo - ------warn
22:30:57.228 [main] ERROR limeLogback.LogbackDemo - ------error

其中appender的配置表示打印到控制台；

（1）、将控制limeLogback包下的所有类的日志的打印，但是并没有设置打印级别，所以继承他的上级的日志级别“info”；

没有设置addtivity，默认为true，将此loger的打印信息向上级传递；

没有设置appender，此loger本身不打印任何信息。

（2）、将root的打印级别设置为“info”，指定了名字为“limeLogback”的appender。

当执行limeLogback.LogbackDemo类的main方法时，因为LogbackDemo 在包limeLogback中，所以首先执行，将级别为“info”及大于“info”的日志信息传递给root，本身并不打印；

root接到下级传递的信息，交给已经配置好的名为“limeLogback”的appender处理，“limeLogback”appender将信息打印到控制台；

 第3种：带有多个logger的配置，指定级别，指定appender

    
    
    ${contextName} - ${bySecond}
    
    
    
         
        
            %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n
        
    
    
    
    
    
    
        
    
    
    
        
    

结果：

23:00:43.448 [main] INFO  limeLogback.LogbackDemo - ------info
23:00:43.451 [main] WARN  limeLogback.LogbackDemo - ------warn
23:00:43.451 [main] ERROR limeLogback.LogbackDemo - ------error

其中appender的配置表示打印到控制台；

（1）、将控制limeLogback包下的所有类的日志的打印，但是并没有设置打印级别，所以继承他的上级的日志级别“error”；

没有设置addtivity，默认为true，将此loger的打印信息向上级传递；

没有设置appender，此loger本身不打印任何信息。

（2）、控制limeLogback.LogbackDemo类的日志打印，打印级别为“info”；

additivity属性为false，表示此loger的打印信息不再向上级传递。

指定了名字为“limeFlogger”的appender。

（3）、将root的打印级别设置为“error”，指定了名字为“limeFlogger”的appender。

打印过程逻辑：

执行limeFlogger.LogbackDemo的main方法时，先执行，将级别为“info”及大于“info”的日志信息交给此loger指定的名为“limeFlogger”的appender处理，在控制台中打出日志，不再向次loger的上级 传递打印信息；

未接到任何打印信息，当然也不会给它的上级root传递任何打印信息；

如果将false">

修改为 true">日志将会打印两次，因为打印信息向上级传递，logger（limeFlogger.LogbackDemo）本身打印一次，向上级logger（limeLogback）传递虽然没有打印，但是logger（limeLogback）又向上级传递，root接到后又打印一次。如下结果：

23:09:18.591 [main] INFO  limeLogback.LogbackDemo - ------info
23:09:18.591 [main] INFO  limeLogback.LogbackDemo - ------info
23:09:18.593 [main] WARN  limeLogback.LogbackDemo - ------warn
23:09:18.593 [main] WARN  limeLogback.LogbackDemo - ------warn
23:09:18.594 [main] ERROR limeLogback.LogbackDemo - ------error
23:09:18.594 [main] ERROR limeLogback.LogbackDemo - ------error

这里有个问题。error 级别比 info 高，为什么。info还会打印出来呢？

addtivity 为 true 会 把满足logger级别的信息，会传递给上级打印，也就是说，在

true"> 

 这个日志的信息上级root 的 level = error 是被忽略了，root 直接打印 logger传递上来的信息

实例

${LOG_HOME}/${LOG_PREFIX}-info.log



%date [%level] [%thread] %logger{60} [%file : %line] %msg%n









${LOG_HOME}/daily/${LOG_FILE}_%d{yyyy-MM-dd}.log.%i.gz



1MB



1

参考：日志框架之Logback 代码结构解析

    
    
    
    
    
    
    
    
	
    
    
    
    
    
    
    

    
    ${APP_NAM}
    
    


    
    
        
        
            
            ${log.pattern}
            
            ${log.encode}
        
    


    
    
        
        ${log.filePath}/logback_debug.log
        
        
            
            ${log.pattern}
            
            ${log.encode}
        
        
        
            
            
                ${log.filePath}/logback/logback_debug-%d{yyyy-MM-dd}.%i.log.zip
            
            
            ${log.append}
            
            ${log.maxHistory}
            
            10GB

            
            
                
                ${log.maxSize}
            
        
        
        
            
            DEBUG
            
            ACCEPT
            
            DENY
        
    

    
    
        
        ${log.filePath}/logback_info.log
        
        
            
            ${log.pattern}
            
            ${log.encode}
        
        
        
            
            
                ${log.filePath}/logback/logback_info-%d{yyyy-MM-dd}.%i.log.zip
            
            
            ${log.append}
            
            ${log.maxHistory}
            
            10GB

            
            
                
                ${log.maxSize}
            
        
        
        
            
            DEBUG
            
            ACCEPT
            
            DENY
        
    

    
    
        
        ${log.filePath}/logback_fixed.log
        
        
            
            ${log.pattern}
            
            ${log.encode}
        
        
        
            ${log.filePath}/logback_fixed-%i.log
            1
            3
        
        
        
            ${log.maxSize}
        
        
        
            
            INFO
            
            ACCEPT
            
            DENY