spring boot日志logback配置解析

项目日志文件配置

在application.properties中有一个配置logback日志文路径和名称的配置项：

logging.config=classpath:xxx.xml     表示使用resource下面的xxx.xml的配置作为日志配置。

日志文件内容配置

配置文件的内容的基本结构： 以<configuration></configuration>开始结束，中间包含的配置：

配置项	数量限制	含义
<appender></appender>	>=0	用于指定日志输出的目的地，日志内容格式，文件大小， 文件命名方式，输出级别，编码方式等等。目的地可以是控制台、文件、远程套接字服务器、 MySQL、PostreSQL、 Oracle和其他数据库、 JMS和远程UNIX Syslog守护进程等
<logger></logger>	>=0	日志的记录器，把它关联到应用的对应的context上后，主要用于存放日志对象，可以定义日志类型、级别。在在代码中可引用日志进行日志打印。
<root></root>	<=1	根logger,是所有<logger>的上级

<configuration></configuration>

属性：

属性名称	含义
scan	配置文件修改时是否从新加载。默认值为true。所以我们可以在运行中修改日志文件的打印级别这些内容。
scanPeriod	设置监测配置文件是否有修改的时间间隔。当scan为true时属性生效。如果没有给出时间单位，默认单位是毫秒。默认的时间间隔为1分钟。可用单位：seconds、minutes
debug	是否实时打印出logback内部日志信息，实时查看logback运行状态，默认值为false。

 

<configuration scan="true" scanPeriod="60 seconds" debug="false"> 
　　。。。
</configuration>

子节点<contextName>

       <contextName>用于设置上下文名称: 默认上下文名称为default。但可以使用<contextName>设置成其他名字，一旦设置，不能修改。

<configuration scan="true" scanPeriod="30 seconds" debug="false"> 
　　　<contextName>LogBackTest</contextName> 
</configuration>

子节点<property>

       <property>用来定义变量值，它有两个属性name和value，通过<property>定义的值会被插入到logger上下文中，其他配置中可以使用“${}”来使用变量。

属性名	含义
name	变量的名称，其他时候可以使用${name}引用改变量值
value	变量定义的值

<configuration scan="true" scanPeriod="30 seconds" debug="false"> 
　　　<property name="DamoName" value="LogBackTest" /> 
　　　<contextName>${DamoName}</contextName> 
</configuration>

子节点<timestamp>

用于上下文获取时间戳字符串，有两个属性key和datePattern

属性名	含义
key	用于标识此<timestamp> 的名字
datePattern	设置将当前时间（解析配置文件的时间）转换为字符串的格式，遵循java.txt.SimpleDateFormat的格式。

<configuration scan="true" scanPeriod="30 seconds" debug="false"> 
　　　<timestamp key="tiemstampTest" datePattern="yyyyMMddHHmmss"/>
　　　<contextName>${tiemstampTest}</contextName> 
</configuration>

子节点<appender>

负责写日志的组件，它有两个必要属性name和class。

属性名	含义
name	指定appender名称
class	指定appender的全限定名

class的类型解析

1.  ch.qos.logback.core.ConsoleAppender

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

子节点	含义
<encoder></encoder>	对日志进行格式化。
<filter></filter>	过滤器
<target>	字符串System.out(默认)或者System.err

例如：将 日志级别 >=DEBUG 级别的日志都输出到控制台。 

<configuration>
  <property name="log.charset" value="utf8" /> <!-- 日志编码 -->
  <property name="FILE_LOG_PATTERN"
              value="%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} %p ${springAppName} [%thread] [%logger{80}] - %msg %n "/>

  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <!-- encoders are assigned the type
         ch.qos.logback.classic.encoder.PatternLayoutEncoder by default -->
    <encoder>
      <Pattern>${FILE_LOG_PATTERN}</Pattern>
      <charset>${log.charset}</charset>
    </encoder>
  </appender>

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

<filter>-过滤器：在Logback-classic中提供两个类型的 filters （http://logback.qos.ch/manual/filters.html）。

•  turbo filter。与logger context（logger 上下文）绑定的，turbo filter过滤所有logging request。
• regular filters ：regular filters 是与appender 绑定的，只过滤某个appender的logging request。在 logback-classic中，filters 继承 Filter 抽象类，Filter 抽象类有一个 decide()抽象方法，接收一个 ILoggingEvent 对象参数，而在 logback-access 中 则是 AccessEvent 对象。 decide()方法返回一个enum类型 FilterReply。值可以是以下几种:

FilterReply取值	方法返回的含义
DENY	返回DENY（拒绝），则跳出过滤链，而该 logging event 也会被抛弃。
NRUTRAL	返回NRUTRAL（中立），则继续过滤链中的下一个过滤器。
ACCEPT	返回ACCEPT（通过），则跳出过滤链

常用的<filter>-过滤器有以下几种：

• LevelFilter

 ch.qos.logback.classic.filter.LevelFilter：级别过滤器，根据日志级别进行过滤。如果日志级别等于配置级别，过滤器会根据onMath(接收) 和 onMismatch(拒绝)日志。有以下子节点：

子节点	含义
<level>	设置过滤级别
<onMatch>	配置符合过滤条件的操作。取值要求：FilterReply
<onMismatch>	配置不符合过滤条件的操作。取值要求：FilterReply

<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>   
       %d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} [%thread] %-5level %logger{30} - %msg %n   
      </pattern>   
    </encoder>   
  </appender>   
  <root level="DEBUG">   
    <appender-ref ref="CONSOLE" />   
  </root>   
</configuration>

• ThresholdFilter

ch.qos.logback.classic.filter.ThresholdFilter：临界值过滤器，过滤掉低于指定临界值的日志。当日志级别等于或高于临界值时，过滤器返回NEUTRAL；当日志级别低于临界值时，日志会被拒绝。
  例如：过滤掉所有低于DEBUG级别的日志。

<configuration>
  <appender name="CONSOLE"
    class="ch.qos.logback.core.ConsoleAppender">
    <!-- deny all events with a level below INFO, that is TRACE and DEBUG -->
    <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
      <level>DEBUG</level>
    </filter>
    <encoder>
      <pattern>
        %d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} [%thread] %-5level %logger{30} - %msg %n
      </pattern>
    </encoder>
  </appender>
  <root level="DEBUG">
    <appender-ref ref="CONSOLE" />
  </root>
</configuration>

• EvaluatorFilter： 

ch.qos.logback.core.filter.EvaluatorFilter 求值过滤器:评估、鉴别日志是否符合指定条件。有一下子节点<evaluator>.

<evaluator>: 鉴别器，常用的鉴别器是JaninoEventEvaluato（ch.qos.logback.classic.boolex.JaninoEventEvaluato），也是默认的鉴别器.

子节点	含义
<evaluator>:	鉴别器:它以任意的java布尔值表达式作为求值条件，求值条件在配置文件解释过成功被动态编译，布尔值表达式返回true就表示符合过滤条件
<onMatch>	配置符合过滤条件的操作。取值要求：FilterReply
<onMismatch>	配置不符合过滤条件的操作。取值要求：FilterReply

<evaluator>有个子标签<expression>，用于配置求值条件。<expression>可以参考官方文档。需要引入jar：

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

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

<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("11111");</expression>   
      </evaluator>   
      <OnMatch>ACCEPT </OnMatch>  
      <OnMismatch>DENY</OnMismatch>  
    </filter>   
    <encoder>   
      <pattern>   
        %d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} [%thread] %-5level %logger{30} - %msg %n  
      </pattern>   
    </encoder>   
  </appender>   
   
  <root level="INFO">   
    <appender-ref ref="STDOUT" />   
  </root>   
</configuration>

2. ch.qos.logback.core.FileAppender

http://logback.qos.ch/manual/appenders.html

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

子节点	含义
<filter></lter>	日志过滤方案
<file></file>	被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
<append></append>	如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
<encoder></encoder>	对记录事件进行格式化。
<prudent>	如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

 例如：将所有日志即便大于等于 DEBUG 的日志输出到项目的路径loggerDemo/info.log中

<!--服务名称 自行修改-->
<property name="SEGMENT_ID" value="loggerDemo"/>
<!--日志文件输出路径  注意linux和window( . 表示项目的路径)的写法-->
<property name="LOG_HOME" value="./logs/${SEGMENT_ID}/"/>
<appender name="FILEAPPENDER" class="ch.qos.logback.core.FileAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>DEBUG</level>
        </filter>
　　　　<file>${LOG_HOME}/info.log</file>
　　　　<append>true</append>
　　　　<encoder>
　　　　　　<pattern>%d{yyyy-MM-dd'T'HH:mm:ss.SSSXXX} [%thread] %-5level %logger{30} - %msg %n</pattern>
　　　　</encoder>
</appender>

<logger name="FileAppenderLogger" level="DEBUG" additivity="false">
        <appender-ref ref="FILEAPPENDER"/>
</logger>

3. ch.qos.logback.core.rolling.RollingFileAppender

http://logback.qos.ch/manual/appenders.html

节点	含义
<file>	被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值
<append>	如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
<rollingPolicy>	当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。
<triggeringPolicy >	非必有节点，告知 RollingFileAppender达到某个要求了， 合适激活滚动。
<prudent></prudent>	如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。FixedWindowRollingPolicy不支持

<rollingPolicy></rollingPolicy>

    <rollingPolicy>的属性class定义具体的滚动策略类.

•     class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"： 最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：

节点	意义
<fileNamePattern></fileNamePattern>	必要节点，包含文件名及“%d”转换符，“%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。文件名称中可以以.   ".zip"   结尾。表示要进行压缩
<maxHistory></maxHistory>	可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
<totalSizeCap</totalSizeCap>	可选的totalSizeCap属性控制所有存档文件的总大小。超过总大小上限时，将异步删除最旧的存档。totalSizeCap属性还需要设置maxHistory属性。此外，总是首先应用“maxHistory”限制，然后应用“totalSizeCap”限制。单位是GB,MB,KB。
<cleanHistoryOnStart</cleanHistoryOnStart>	如果设置为true，将在appender启动时执行存档删除。默认情况下，此属性设置为false。 存档文件删除通常在翻滚期间执行。但是，有些应用程序的寿命可能不够长，无法触发翻滚。因此，对于这种生命周期很短的应用程序，归档删除可能永远没有机会执行。通过将cleanHistoryOnStart设置为true，将在appender启动时执行存档删除。

 <fileNamePattern>中的日期格式和<maxHistory>配合可以限制是每天生成一个文件还是每小时(每分钟)生成一个文件。需要注意的是：日志文件命名中不能包含不支持的特殊字符例如冒号“:”

• ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy

      按日期归档文件，但同时限制每个日志文件的大小。继承于ch.qos.logback.core.rolling.TimeBasedRollingPolicy,。所以包含了其所有的节点。

节点	含义
<maxFileSize></maxFileSize>	每个文件的大小

%i和%d命令都是必需的。每当当前日志文件在当前时间段结束前达到maxFileSize时，它将以递增的索引进行归档，从0开始 

<configuration>
  <appender name="ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>mylog.txt</file>
    <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
      <!-- rollover daily -->
      <fileNamePattern>mylog-%d{yyyy-MM-dd}.%i.txt</fileNamePattern>
       <!-- each file should be at most 100MB, keep 60 days worth of history, but at most 20GB -->
       <maxFileSize>100MB</maxFileSize>    
       <maxHistory>60</maxHistory>
       <totalSizeCap>20GB</totalSizeCap>
    </rollingPolicy>
    <encoder>
      <pattern>%msg%n</pattern>
    </encoder>
  </appender>


  <root level="DEBUG">
    <appender-ref ref="ROLLING" />
  </root>

</configuration>

• class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy" : 根据固定窗口算法重命名文件的滚动策略。有以下子节点：

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

 

<triggeringPolicy></triggeringPolicy >

triggeringPolicy是回滚策略的方式，当达到回滚条件时告知 RollingFileAppender 合适激活滚动

• 　  class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:

子节点	含义
<maxFileSize></maxFileSize>	活动文件的大小，默认值是10MB。
<prudent>	当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1.不支持也不允许文件压缩，2.不能设置file属性，必须留空。

<encoder></encoder>

       对记录事件进行格式化。负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个<pattern>节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“\%”进行转义。具体有哪些可以输出的格式，后面在讨论。

子节点<logger>

       用来设置某一个包或具体的某一个类的日志打印级别、以及指定<appender>。<logger>仅有一个name属性，一个可选的level和一个可选的addtivity属性。

属性	作用
name	指定受此loger约束的某一个包或者具体的某一个类。
level	可选，设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL和OFF，还有一个特殊值INHERITED或者同义词NULL，代表强制执行上级的级别。 如果未设置此属性，那么当前loger将会继承上级的级别。
addtivity	可选，是否向上级loger传递打印信息。默认是true。同<logger>一样，可以包含零个或多个<appender-ref>元素，标识这个appender将会添加到这个loger。

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

子节点<root>

       也是<logger>元素，但是它是根logger,是所有<logger>的上级。只有一个level属性，因为name已经被命名为"root",且已经是最上级了。

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