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

logback介绍和配置详解

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

logback-core:核心代码块(不介绍)

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

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

一、logback的使用

引入maven依赖

       <!-- logback-core -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
            <version>1.2.3</version>
        </dependency>

        <!-- 引入logback对SLF4J的实现 logback-classic -->
        <dependency>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-classic</artifactId>
            <version>1.2.3</version>
            <scope>test</scope>
        </dependency>

二、logback.xml格式详解

1、configuration

根节点<configuration>,包含下面三个属性:

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

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

子节点contextName

用来设置上下文名称

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

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

2、Property

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

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

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
 <property name="APP_Name" value="myAppName" />   
 <contextName>${APP_Name}</contextName>  
 <!-- 其他配置省略-->  
</configuration>   

3、timestamp

子节点<timestamp>:获取时间戳字符串,他有两个属性key和datePattern

<configuration scan="true" scanPeriod="60 seconds" debug="false">  
  <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
  <contextName>${bySecond}</contextName>  
  <!-- 其他配置省略-->  
</configuration>   

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

4、Appender

子节点<appender>:负责写日志的组件,它有两个必要属性nameclass。name指定appender名称,class指定appender的全限定名

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

4.1 ConsoleAppender 

把日志输出到控制台,有以下子节点:

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

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

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

<target>:字符串System.out(默认)或者System.err(区别不多说了)

4.2 FileAppender

把日志添加到文件,有以下子节点:

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

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

<encoder>:对记录事件进行格式化。(具体参数稍后讲解 )

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

4.3 RollingFileAppender

4.3.1 节点类型

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

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

<encoder> : 对记录事件进行格式化。 

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

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

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

         <fileNamePattern> : 归档的日志文件的路径

        <triggeringPolicy> : 告知 RollingFileAppender 何时激活滚动。

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

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

例子

<!--TimeBasedRollingPolicy:配置日志所生成的目录以及生成文件名的规则 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  <!-- 设置文件名称 -->
  <fileNamePattern>
      ${log.filePath}/logback/logback_info-%d{yyyy-MM-dd}.%i.log
  </fileNamePattern>
  <!-- 写入文件方式 -->
  <append>${log.append}</append>
  <!-- 设置最大保存周期 -->
  <MaxHistory>${log.maxHistory}</MaxHistory>
  <!-- 日志总保存量为10GB -->
  <totalSizeCap>10GB</totalSizeCap>

  <!-- 策略触发器:告知 RollingFileAppender 合适激活滚动 -->
  <timeBasedFileNamingAndTriggeringPolicy
          class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
      <!--文件达到 最大值时会被压缩和切割 -->
      <maxFileSize>${log.maxSize}</maxFileSize>
  </timeBasedFileNamingAndTriggeringPolicy>
</rollingPolicy>

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

4.3.2 策略

1、rollingPolicy滚动策略

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

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

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

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

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

<minIndex> : 窗口索引最小值。

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

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

2、triggeringPolicy触发策略

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

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

4.4、filter

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

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

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

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

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

常用的过滤器 : 

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

有以下子节点 : 

<level> : 设置过滤级别。

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" 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 默认配置为PatternLayoutEncoder --> 
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <target>System.err</target>
    </appender>
    
    <logger name="limeLogback.LogbackDemo" level="debug" additivity="true">
        <appender-ref ref="limeFlogger"/>
    </logger>
    
    <root/>

</configuration>
19:40:59.567 [main] INFO  limeLogback.LogbackDemo - ------info

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

有以下子节点 : 

 <level> : 设置过滤级别。

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

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>info</level>
        </filter>
        <!-- encoder 默认配置为PatternLayoutEncoder --> 
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <target>System.err</target>
    </appender>
    
    <logger name="limeLogback.LogbackDemo" level="debug" additivity="true">
        <appender-ref ref="limeFlogger"/>
    </logger>
    
    <root/>

</configuration>
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 : 求值过滤器,评估、鉴别日志是否符合指定条件。

有以下子节点:

 <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”字符串的日志。

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog" />
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss" />
    <contextName>${contextName} - ${bySecond}</contextName>

    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" 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 默认配置为PatternLayoutEncoder -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <target>System.err</target>
    </appender>

    <logger name="limeLogback.LogbackDemo" level="debug" additivity="true">
        <appender-ref ref="limeFlogger" />
    </logger>

    <root />

</configuration>

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

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

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog" />
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss" />
    <contextName>${contextName} - ${bySecond}</contextName>

    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" 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>
            <OnMatch>ACCEPT </OnMatch>
            <OnMismatch>DENY</OnMismatch>
        </filter>
        <!-- encoder 默认配置为PatternLayoutEncoder -->
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <target>System.err</target>
    </appender>

    <logger name="limeLogback.LogbackDemo" level="debug" additivity="true">
        <appender-ref ref="limeFlogger" />
    </logger>

    <root />

</configuration>

4.5、encoder

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

<encoder> : 负责两件事,一是把日志信息转换成字节数组,二是把字节数组写入到输出流。

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

<appender name="limeFileLogger" class="ch.qos.logback.core.FileAppender">
        <file>limeFileLogger.log</file>
        <append>true</append>
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
        <prudent>false</prudent>
    </appender>

<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。

5、 logger

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

<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里输出

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

6、root

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

<root>可以包含零个或多个<appender-ref>元素,标识这个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

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" 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>
        <appender-ref ref="limeFlogger"/>
    </root>

</configuration>

结果:

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>将root的打印级别设置为默认值“DEBUG”,指定了名字为“limeFlogger”的appender。

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

第2种:带有loger的配置,不指定级别,不指定appender

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder --> 
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- limeLogback为java中的包 -->
    <logger name="limeLogback"/>
    
    <root level="info">
        <appender-ref ref="limeFlogger"/>
    </root>

</configuration>

结果:

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)、<logger name="limeLogback" />将控制limeLogback包下的所有类的日志的打印,但是并没有设置打印级别,所以继承他的上级<root>的日志级别“info”;

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

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

(2)、<root level="info">将root的打印级别设置为“info”,指定了名字为“limeLogback”的appender。

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

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

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

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">
    <property name="contextName" value="limeLog"/>
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HH:mm:ss"/>
    <contextName>${contextName} - ${bySecond}</contextName>
    
    <!-- 表示打印到控制台 -->
    <appender name="limeFlogger" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默认配置为PatternLayoutEncoder --> 
        <encoder>
            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    
    <!-- limeLogback为java中的包 -->
    <logger name="limeLogback"/>
    
    <logger name="limeLogback.LogbackDemo" level="info" additivity="false">
        <appender-ref ref="limeFlogger"/>
    </logger>
    
    <root level="error">
        <appender-ref ref="limeFlogger"/>
    </root>

</configuration>

结果:

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)、<logger name="limeLogback" />将控制limeLogback包下的所有类的日志的打印,但是并没有设置打印级别,所以继承他的上级<root>的日志级别“error”;

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

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

(2)、<logger name="limeLogback.LogbackDemo" level="info" additivity="false">控制limeLogback.LogbackDemo类的日志打印,打印级别为“info”;

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

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

(3)、<root level="error">将root的打印级别设置为“error”,指定了名字为“limeFlogger”的appender。

打印过程逻辑:

执行limeFlogger.LogbackDemo的main方法时,先执行<logger name="limeFlogger.LogbackDemo" level="info" additivity="false">,将级别为“info”及大于“info”的日志信息交给此loger指定的名为“limeFlogger”的appender处理,在控制台中打出日志,不再向次loger的上级 <logger name="limeLogback"/> 传递打印信息;

<logger name="limeLogback"/>未接到任何打印信息,当然也不会给它的上级root传递任何打印信息;

如果将<logger name="limeLogback.LogbackDemo" level="info" additivity="false">

修改为 <logger name="limeLogback.LogbackDemo" level="info" additivity="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级别的信息,会传递给上级打印,也就是说,在

<logger name="limeLogback.LogbackDemo" level="info" additivity="true"> 

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

实例

<?xml version="1.0" encoding="UTF-8"?>
<configuration>

<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
<include resource="org/springframework/boot/logging/logback/console-appender.xml"/>

<property name="LOG_HOME" value="C:\log"/>
<property name="LOG_PREFIX" value="web-xxx"/>
<!--
%p:输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r:输出自应用启动到输出该日志讯息所耗费的毫秒数
%t:输出产生该日志事件的线程名
%f:输出日志讯息所属的类别的类别名
%c:输出日志讯息所属的类的全名
%d:输出日志时间点的日期或时间,指定格式的方式: %d{yyyy-MM-dd HH:mm:ss}
%l:输出日志事件的发生位置,即输出日志讯息的语句在他所在类别的第几行。
%m:输出代码中指定的讯息,如log(message)中的message
%n:输出一个换行符号
-->
<!--
Appender: 设置日志信息的去向,常用的有以下几个
ch.qos.logback.core.ConsoleAppender (控制台)
ch.qos.logback.core.rolling.RollingFileAppender (文件大小到达指定尺寸的时候产生一个新文件)
ch.qos.logback.core.FileAppender (文件,不推荐使用)
-->
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!--&lt;!&ndash; 被写入的文件名,可以是相对目录,也可以是绝对目录,如果上级目录不存在会自动创建 &ndash;&gt;-->
<File>${LOG_HOME}/${LOG_PREFIX}-info.log</File>
<!--<encoder>:对记录事件进行格式化。-->
<encoder>
<!--格式化输出:%d表示日期,后面跟时间格式,默认%data{yyyy-MM-dd},%thread表示线程名, %msg:日志消息,%n是换行符-->
<pattern>%date [%level] [%thread] %logger{60} [%file : %line] %msg%n</pattern>
</encoder>
<!--RollingFileAppender:-->
<!--滚动记录文件,先将日志记录到指定文件,当符合某个条件时,将日志记录到其他文件。-->
<!--<rollingPolicy>:当发生滚动时,决定RollingFileAppender 的行为,涉及文件移动和重命名。-->
<!--TimeBasedRollingPolicy: 最常用的滚动策略,它根据时间来制定滚动策略,既负责滚动也负责出发滚动-->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--<fileNamePattern>:
必要节点,包含文件名及“%d”转换符, “%d”可以包含一个 java.text.SimpleDateFormat指定的时间格式,如:%d{yyyy-MM}。
如果直接使用 %d,默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无,通过设置file,可以为活动文件和归档文件指定不同位置,当前日志总是记录到file指定的文件(活动文件),活动文件的名字不会改变;
如果没设置file,活动文件的名字会根据fileNamePattern的值,每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。-->
<!--<fileNamePattern>${LOG_HOME}/daily/${LOG_FILE}.%d{yyyy-MM-dd}.gz</fileNamePattern>-->
<!--压缩文件的保存路径以及保存格式,这里必须将文件压缩,.%i 必须有。如果按上面的配置会报错-->
<fileNamePattern>${LOG_HOME}/daily/${LOG_FILE}_%d{yyyy-MM-dd}.log.%i.gz</fileNamePattern>

<timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
<!--保存文件的大小,超过该大小自动创建新文件。旧文件压缩保存到daily目录下-->
<maxFileSize>1MB</maxFileSize>
</timeBasedFileNamingAndTriggeringPolicy>
<!--&lt;!&ndash; 可选节点,控制保留的归档文件的最大数量,超出数量就删除旧文件。假设设置每个月滚动,如果是6,则只保存最近6天的文件,删除之前的旧文件 包括压缩文件 &ndash;&gt;-->
<!--&lt;!&ndash; 每产生一个日志文件,该日志文件的保存期限天数 &ndash;&gt;-->
<maxHistory>1</maxHistory>
</rollingPolicy>
</appender>
<!--root是默认的logger 这里设定输出级别是info-->
<root level="INFO">
<!--定义了两个appender,日志会通过往这两个appender里面写-->
<appender-ref ref="CONSOLE"/>
<appender-ref ref="FILE"/>
</root>
</configuration>

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

<?xml version="1.0" encoding="UTF-8"?>
<!--
 scan属性:默认为true,Logback将会扫描配置文件,如果配置文件发生改变时,会自动加载
 scanPeriod:Logback扫描配置文件时间间隔,默认单位为毫秒,可配置单位为毫秒、秒、分、时 milliseconds, seconds, minutes or hours
 debug:默认为false,是否打印Logback内部信息,当为true时可以查看Logback的运行信息
 packagingData:默认false,在打印异常堆栈时是否打印相关包信息
-->
<configuration 
  		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:noNamespaceSchemaLocation="http://www.padual.com/java/logback.xsd"
	    scan="true" scanPeriod="60 seconds" debug="false" packagingData="true">
    <!-- 定义参数变量 -->
    <property name="APP_NAM" value="logback_demo" />
    <!-- 日志级别参数 -->
    <property name="log.level" value="debug" />
    <!-- 文件保留时间 -->
    <property name="log.maxHistory" value="30" />
    <!-- 文件大小 -->
    <property name="log.maxSize" value="4MB"/>
	<!-- 日志文件是否覆盖 -->
    <property name="log.append" value="true"/>
    <!-- 日志输出编码 -->
    <property name="log.encode" value="UTF-8" />
    <!-- 日志存储路径 -->
    <property name="log.filePath" value="F:/logs" />
    <!-- 日志的显式格式 -->
    <property name="log.pattern"
              value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50}-%msg%n"></property>

    <!--配置logger上下文名称,默认名称为default,用于区分不同应用程序的日志记录-->
    <contextName>${APP_NAM}</contextName>
    <!--获取时间戳字符串 key为名称  datePattern为将解析配置文件的时间作为当前时间格式化的标准-->
    <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>


    <!-- consoleAppender:控制台输出 -->
    <appender name="STDOUT"
              class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder:对日志日期格式化,类似于layout,除了将时间转化为数组,还会将转换后的数组输出到相应的文件中 -->
        <encoder>
            <!-- 定义日志的输出格式 -->
            <pattern>${log.pattern}</pattern>
            <!-- 设置信息编码 -->
            <charset>${log.encode}</charset>
        </encoder>
    </appender>


    <!-- 文件输出策略设置 -->
    <appender  name="DEBUG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 文件路径 -->
        <file>${log.filePath}/logback_debug.log</file>
        <!-- 日志输出格式设置-->
        <encoder>
            <!-- 输出格式设置 -->
            <pattern>${log.pattern}</pattern>
            <!-- 编码设置 -->
            <charset>${log.encode}</charset>
        </encoder>
        <!--TimeBasedRollingPolicy:配置日志所生成的目录以及生成文件名的规则 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 设置文件名称 -->
            <fileNamePattern>
                ${log.filePath}/logback/logback_debug-%d{yyyy-MM-dd}.%i.log.zip
            </fileNamePattern>
            <!-- 写入文件方式 -->
            <append>${log.append}</append>
            <!-- 设置最大保存周期 -->
            <MaxHistory>${log.maxHistory}</MaxHistory>
            <!-- 日志总保存量为10GB -->
            <totalSizeCap>10GB</totalSizeCap>

            <!-- 策略触发器:告知 RollingFileAppender 合适激活滚动 -->
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!--文件达到 最大值时会被压缩和切割 -->
                <maxFileSize>${log.maxSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 过滤器,过滤掉不是指定日志水平的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置日志级别 -->
            <level>DEBUG</level>
            <!-- 如果跟该日志水平相匹配,则接受 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 如果跟该日志水平不匹配,则过滤掉 -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 文件输出策略设置 -->
    <appender  name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 文件路径 -->
        <file>${log.filePath}/logback_info.log</file>
        <!-- 日志输出格式设置-->
        <encoder>
            <!-- 输出格式设置 -->
            <pattern>${log.pattern}</pattern>
            <!-- 编码设置 -->
            <charset>${log.encode}</charset>
        </encoder>
        <!--TimeBasedRollingPolicy:配置日志所生成的目录以及生成文件名的规则 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 设置文件名称 -->
            <fileNamePattern>
                ${log.filePath}/logback/logback_info-%d{yyyy-MM-dd}.%i.log.zip
            </fileNamePattern>
            <!-- 写入文件方式 -->
            <append>${log.append}</append>
            <!-- 设置最大保存周期 -->
            <MaxHistory>${log.maxHistory}</MaxHistory>
            <!-- 日志总保存量为10GB -->
            <totalSizeCap>10GB</totalSizeCap>

            <!-- 策略触发器:告知 RollingFileAppender 合适激活滚动 -->
            <timeBasedFileNamingAndTriggeringPolicy
                    class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <!--文件达到 最大值时会被压缩和切割 -->
                <maxFileSize>${log.maxSize}</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <!-- 过滤器,过滤掉不是指定日志水平的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置日志级别 -->
            <level>DEBUG</level>
            <!-- 如果跟该日志水平相匹配,则接受 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 如果跟该日志水平不匹配,则过滤掉 -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 文件输出策略设置 -->
    <appender  name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 文件路径 -->
        <file>${log.filePath}/logback_fixed.log</file>
        <!-- 日志输出格式设置-->
        <encoder>
            <!-- 输出格式设置 -->
            <pattern>${log.pattern}</pattern>
            <!-- 编码设置 -->
            <charset>${log.encode}</charset>
        </encoder>
        <!--FixedWindowRollingPolicy:设置为按照索引的方式滚动,定义文件名称的时候使用%i作为占位符,滚动后会会用角标替换 -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>${log.filePath}/logback_fixed-%i.log</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
        </rollingPolicy>
        <!-- 指定文件最大尺寸,达到该尺寸,就触发rollingPolicy对应的策略,maxFileSize属性指定文件大小 -->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <maxFileSize>${log.maxSize}</maxFileSize>
        </triggeringPolicy>
        <!-- 过滤器,过滤掉不是指定日志水平的日志 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- 设置日志级别 -->
            <level>INFO</level>
            <!-- 如果跟该日志水平相匹配,则接受 -->
            <onMatch>ACCEPT</onMatch>
            <!-- 如果跟该日志水平不匹配,则过滤掉 -->
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- 子节点logger:用来设置某一个包或具体的某一个类的日志打印级别、以及指定Appender -->
    <!--
        name:指定此logger管理的包或者类
        level:指定此logger的消息输出级别
        additivity:默认为true,是否向上级logger传递消息
    -->
    <logger name="demo1" level="${log.level}" additivity="false">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="DEBUG" />
    </logger>

    <logger name="demo2" level="${log.level}" additivity="false">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="INFO" />
    </logger>

    <logger name="demo3" level="${log.level}" additivity="false">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="FILE" />
    </logger>


    <!-- 根Logger节点,最顶级-->
    <root level = "DEBUG">
        <appender-ref ref="STDOUT" />
        <appender-ref ref="DEBUG" />
        <appender-ref ref="INFO" />
        <appender-ref ref="FILE" />
    </root>

</configuration>

Logo

权威|前沿|技术|干货|国内首个API全生命周期开发者社区

更多推荐