logback节点配置详解-白红宇

logback节点配置详解

阅读量：6994 次

发布时间：2019-06-27

本文共 11703 字，大约阅读时间需要 39 分钟。

一：根节点 <configuration></configuration>

属性：

debug : 默认为false ，设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。

scan : 配置文件如果发生改变，将会重新加载，默认值为true；

scanPeriod : 检测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位时毫秒，当scan为true时，这个属性生效，默认时间间隔为1min。

可以这样描述配置文件的基本结构：以<configuration>开头，后面有零

个或多个<appender>元素，有零个或多个<logger>元素，有最多一个<root>元素

二：<configuration> 子节点

1 : <appender></appender>

2 : <logger></logger>

3 : <root></root>

1.1 <appender> 是 <configuration> 的子节点，是负责写日志的组件。

appender 有两个必要属性 name ，class 。name指定appender 的名称， class 指定appender的全限定名

class 包括：ch.qos.logback.core.ConsoleAppender / ch.qos.logback.core.FileAppender/ ch.qos.logback.core.RollingFileAppender

1.1.1 ：ConsoleAppender

把日志添加到控制台，有如下节点：

<encoder> : 对日志进行格式化。

<target> : 字符串System.out 或者 System.err, 默认 System.out;

1 
       2 
      
        3     
        4   
       
         5         
        
          6             
         
          %date [%thread] %-5level %logger - %message%newline
          7         
         8   
        9 10   
       
                     11     
           12   
            13

1.1.2 : FileAppender

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

<file> : 被写入的文件名,可以是相对目录 , 也可以是绝对目录 , 如果目录不存在则会自动创建

<append> : 如果是true , 日志被追加到文件结尾 , 如果是false,清空现存文件 , 默认是true

<encoder> : 对日志进行格式化 [具体的转换符说明请.]

<prodent> : 如果是true，日志会被安全的写入文件 , 即使其他的FileAppender也会向此文件做写入操作 , 默认是false

1 
       2 
      
        3     
        4     
       
         5         
        
          6             
         
          %date [%thread] %-5level %logger - %message%newline
          7         
         8     
        9 10     
       11     
       
        12         
        
         logs/debug.log
        13         
        
         14             
         
          %date [%thread] %-5level %logger - %message%newline
         15         
        16     
       17

1.1.3 : RollingFileAppender [常用]

滚动纪录文件，先将日志记录到指定文件，当符合某种条件时，将日志记录到其他文件，有如下节点：

<file> : 被写入的文件名，可以是相对目录，也可以解决目录，如果目录不存在则自动创建。

<append> : 如果是true，日志被追加到文件结尾，如果是false，清空现存文件，默认是true；

<encoder> : 对日志进行格式化 [具体的转换符说明请.]

<rollingPolicy> : 当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。

1.1.3.1 ：

TimeBaseRollingPolicy ：最常用的滚动策略，根据时间来制定滚动策略，即负责滚动也负责触发滚动。有如下节点；

1) : <fileNamePattern>

必要节点，包含文件及“％d” 转换符，“％d”可以包含一个java.text.SimpleDateFormat 制定的时间格式，如：％d｛yyyy-MM｝,如果直接使用％d ，默认格式是 yyyy－MM－dd。

RollingFileAppender 的file 子节点可有可无，通过设置file，可以为活动文件和归档文件制定不同位置，当前日志总是纪录到file指定的文件，活动文件的名称不会改变，如果没有设置file，活动文件的名称会根据fileNamePattern的值，每隔一段时间改变一次，“／”或者“\” 会被当作目录分隔符。

2) :<maxHistory>

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

3) :<filenamePattern>

必须包含“%i” 例如：设置最小值，和最大值分别为1和2，命名模式为 log%i.log,会产生归档文件log1.log和log2.log，还可以指定文件压缩选项，例如：log％i.log.gz 或者 log%i.log.zip

4) :<triggeringPolicy> :

告知RollingFileAppender 激活RollingFileAppender滚动

1     
       2     
      
        3         
       
        logs/error.log
        4         
        5         
       
           6             
          7             
        
         errorFile.%d{yyyy-MM-dd}.log
         8             
         9             
        
         30
        10         
       11         
       12         
       
        13             
        
         150
        14         
       15         
       
        16             
        
         %d [%p] %-5level %logger - %msg%newline
        17         
       18

1.1.3.2 ：

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

<maxFileSize> : 活动文件的大小 , 默认10MB

<prudent>：当为true时 , 不支持FixedWindowRollingPolicy , 支持TimeBasedRollingPolicy , 但是有两个限制 , 1不支持也不允许文件压缩 , 2不能设置file属性 . 必须留空

至此 , Appender 节点已经介绍完毕.

2.1 ： logger 节点

logger 是 <configuration> 的子节点

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

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

level：用来设置打印级别，大小写无关，TRACE,DEBUG,INFO,WARE,ERROR,ALL和OFF,还有一个特俗值INHERITED 或者同义词NULL，代表强制执行上级的级别。

如果未设置此属性，那么当前logger将会继承上级的级别。

level 大小：

ERROR > WARN > INFO > DEBUG > TRACE

程序会打印高于或等于所设置级别的日志

addtivity ：是否向上级loger传递打印信息，默认为true；

<loger> 可以包含零个或多个<appender-ref>元素，表示这个appender将会添加到loger

1 
        2 
       
         3     
         4     
        
          5         
         
           6             
           7             
          
           INFO
           8             
          
           ACCEPT
           9             
          
           DENY
          10         
         11     
        12 13     
        14     
        
         15         16         
         
          logs/info.log
         17         
         18         
         
            19             
           20             
          
           infoFile.%d{yyyy-MM-dd}.log
          21             
          22             
          
           30
          23         
         24         
         25         
         
          26             
          
           150
          27         
         28         
         
          29             
          
           %d [%p] %-5level %logger - %msg%newline
          30         
         31     
        32  33     
        34     
        
         35         
         36         
         37     
        38

View Code

2.2 : root 节点

元素配置根 logger。该元素有一个 level 属性。没有 name 属性，因为已经被命名为“root”

Level 属性的值大小写无关，其值为下面其中一个字符串：TRACE、DEBUG、INFO、 WARN、ERROR、ALL 和 OFF。注意不能设置为“INHERITED” 或“NULL”。元素可以包含零个或多个元素。与元素类似，声明元素后，会先关闭然后移除全部当前 appender，只引用声明了的 appender。如果 root 元素没有引用任何 appender，就会失去所有 appender。

如下完整案例配置 :

1 
        2 
       
         3     
         4     
        
          5         
         
           6             
           7             
          
           INFO
           8             
          
           ACCEPT
           9             
          
           DENY
          10         
         11     
        12 13     
        14     
        
         15         16         
         
          logs/info.log
         17         
         18         
         
            19             
           20             
          
           infoFile.%d{yyyy-MM-dd}.log
          21             
          22             
          
           30
          23         
         24         
         25         
         
          26             
          
           150
          27         
         28         
         
          29             
          
           %d [%p] %-5level %logger - %msg%newline
          30         
         31     
        32 33     
        34     
        
         35         
         
          logs/debug.log
         36         
         37         
         
            38             
           39             
          
           debugFile.%d{yyyy-MM-dd}.log
          40             
          41             
          
           30
          42         
         43         
         44         
         
          45             
          
           150
          46         
         47         
         
          48             
          
           %d [%p] %-5level %logger - %msg%newline
          49         
         50     
        51 52     
        53     
        
         54         
         
          logs/error.log
         55         
         56         
         
            57             
           58             
          
           errorFile.%d{yyyy-MM-dd}.log
          59             
          60             
          
           30
          61         
         62         
         63         
         
          64             
          
           150
          65         
         66         
         
          67             
          
           %d [%p] %-5level %logger - %msg%newline
          68         
         69     
        70  71     
        
         72         
         73         
         74         
         75     
        76

View Code

三 : <filter> 过滤节点

Logback 的过滤器基于三值逻辑（ternary logic），允许把它们组装或成链，从而组成任意的复合过滤策略。

这里的所谓三值逻辑是说，过滤器的返回值只能是 ACCEPT、DENY 和 NEUTRAL 的其中一个。

过滤器一般分为如下几类　：

3.1 : 级别过滤器（LevelFilter）

LevelFilter 根据记录级别对记录事件进行过滤。如果事件的级别等于配置的级别，过滤器会根据 onMatch 和 onMismatch 属性接受或拒绝事件。下面是个配置文件例子:

1 
        2 
       
         3     
         4     
        
          5         
         
           6             
           7             
          
           INFO
           8             
          
           ACCEPT
           9             
          
           DENY
          10         
         11         12         
         
          13             
          
           %-4relative [%thread] %-5level %logger{30} - %msg%n
          14         
         15     
        16     
        
         17         
         18     
        19

3.2 : 临界值过滤器（ThresholdFilter）

ThresholdFilter 过滤掉低于指定临界值的事件 . 当记录的级别等于或高于临界值时 , ThresholdFilter 的decide()方法会返回NEUTRAL ; 当记录级别低于临界值时 , 事件会被拒绝下面是个配置文件例子 :

1 
        2 
       
         3     
         4     
        
          5         
         
            　　　　　　　　
           6             
          
           INFO
            7         
          8          9         
         
          10             
          
           %-4relative [%thread] %-5level %logger{30} - %msg%n
          11         
         12     
        13     
        
         14         
         15     
        16

3.3 : 求值过滤器（EvaluatorFilter）

EvaluatorFilter 封装了 EventEvaluator（ch.qos.logback.core.boolex.EventEvaluator) , 评估是否符合指定的条件

1 
       2 
      
        3     
        4     
       
         5         
        
            6              
         
           7              
           8                 
          
            9                     message.contains("hello")10                 
          11                 
          
           NEUTRAL
          12                 
          
           DENY
          13              
         14         
        15         16         
        
         17             
         
          %-4relative [%thread] %-5level %logger{30} - %msg%n
         18         
        19     
       20     
       
        21         
        22     
       23

3.4 : 匹配器（Matchers）

尽管能通过调用 String 类的 matches()方法进行模式匹配，但这会导致每次调用过滤器时都会创建一个全新的 Pattern 对象。为消除这种开销，你可以预先定义一个或多个 Matcher 对象。一旦定义 matcher 后，就可以在求值表达式里重复引用它。

1 
       2 
      
        3     
        4     
       
         5         
        
            6              
         
            7                 
          
            8                     
           
            odd
            9                     
           10                     
           
            statement [13579]
           11                 
          12                 
          
           odd.matches(formattedMessage)
          13                 
          
           NEUTRAL
          14                 
          
           DENY
          15              
         16         
        17         18         
        
         19             
         
          %-4relative [%thread] %-5level %logger{30} - %msg%n
         20         
        21     
       22     
       
        23         
        24     
       25