logback配置

一：根节点<configuration>包含的属性：

scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。

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

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

1. <configuration scan="true" scanPeriod="60 seconds" debug="false">  
2.       <!-- 其他配置省略-->  
3. </configuration>  

二：根节点<configuration>的子节点：

 

2.1设置上下文名称：<contextName>

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

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

2.2设置变量： <property>

用来定义变量值的标签，<property> 有两个属性，name和value；其中name的值是变量的名称，value的值时变量定义的值。通过<property>定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。

例如使用<property>定义上下文名称，然后在<contentName>设置logger上下文时使用。

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

2.3获取时间戳字符串：<timestamp>

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

 例如将解析配置文件的时间作为上下文名称：

 

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

 

2.4设置logger：

<logger>

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

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

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

addtivity:是否向上级loger传递打印信息。默认是true。

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

 

2.5<root>

也是<logger>元素，但是它是根logger。只有一个level属性，因为已经被命名为"root".

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

默认是DEBUG。

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

2.6<appender>

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

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

2.6.1 ConsoleAppender:把日志添加到控制台，有以下子节点：

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

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

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

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

• <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级别的日志都输出到控制台

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

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

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

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

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

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

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

<file>：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
<append>：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。 
<rollingPolicy>:当发生滚动时，决定RollingFileAppender的行为，涉及文件移动和重命名。属性class定义具体的滚动策略类
　　　　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 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。 
　　　　<maxHistory>:可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且<maxHistory>是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧 文件是，那些为了归档而创建的目录也会被删除。

　　　　class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy"： 查看当前活动文件的大小，如果超过指定大小会告知RollingFileAppender 触发当前活动文件滚动。只有一个节点:
　　　　　<maxFileSize>:这是活动文件的大小，默认值是10MB。
<prudent>：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。 
<triggeringPolicy >: 告知 RollingFileAppender 合适激活滚动。
　　　　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

• <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>  
• 每天生成一个日志文件，保存30天的日志文件。
• <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>  

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

 

2.7举个栗子

java代码如下：LogbackDemo.java类

package logback;  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  

public class LogbackDemo {  

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

logback.xml配置文件

（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将信息打印到控制台；

打印结果：info，warn，error

（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的配置表示打印到控制台(稍后详细讲解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将信息打印到控制台；

打印结果：debug、info、warn、error

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

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

<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传递任何打印信息；

打印结果：info、warn、error

 如果将<logger name="logback.LogbackDemo" level="INFO" additivity="false">修改为 <logger name="logback.LogbackDemo" level="INFO" additivity="true">那打印结果将是什么呢？

没错，日志打印了两次，想必大家都知道原因了，因为打印信息向上级传递，logger本身打印一次，root接到后又打印一次

打印结果：info、info、warn、warn、error、error

按时间压缩打印：

目前线上服务器的日志压缩大致分类为两类：、
1、按小时压缩的，也就是说日志每个小时会自动被切割，生成固定格式的文件，然后被压缩，对应的压缩脚本为/home/q/tools/bin/zip_homeq_log_hourly.sh
2、按天压缩的，也就是说日志每个小时会自动被切割，生成固定格式的文件，然后被压缩，对应的压缩脚本为/home/q/tools/bin/zip_homeq_log_daily.sh
以上两种类型的日志压缩，默认find的路径都是/home/q/www//logs,也就是说默认只有在这个路径下/home/q/www//logs的日志才能被压缩。

异步打印：

<appender name="api2V2Async" class="ch.qos.logback.classic.AsyncAppender">
       <discardingThreshold>0</discardingThreshold>
       <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
       <queueSize>512</queueSize>
       <!-- 添加附加的appender,最多只能添加一个 -->
       <appender-ref ref="api2V2"/>
   </appender>

工作原理：
当Logging Event进入AsyncAppender后，AsyncAppender会调用appender方法，append方法中在将event填入Buffer(这里选用的数据结构为BlockingQueue)中前，会先判断当前buffer的容量以及丢弃日志特性是否开启，当消费能力不如生产能力时，AsyncAppender会超出Buffer容量的Logging Event的级别，进行丢弃，作为消费速度一旦跟不上生产速度，中转buffer的溢出处理的一种方案。AsyncAppender有个线程类Worker，它是一个简单的线程类，是AsyncAppender的后台线程，所要做的工作是：从buffer中取出event交给对应的appender进行后面的日志推送。
从上面的描述中可以看出，AsyncAppender并不处理日志，只是将日志缓冲到一个BlockingQueue里面去，并在内部创建一个工作线程从队列头部获取日志，之后将获取的日志循环记录到附加的其他appender上去，从而达到不阻塞主线程的效果。因此AsynAppender仅仅充当事件转发器，必须引用另一个appender来做事。

在使用AsyncAppender的时候，有些选项还是要注意的。由于使用了BlockingQueue来缓存日志，因此就会出现队列满的情况。正如上面原理中所说的，在这种情况下，AsyncAppender会做出一些处理：默认情况下，如果队列80%已满，AsyncAppender将丢弃TRACE、DEBUG和INFO级别的event，从这点就可以看出，该策略有一个惊人的对event丢失的代价性能的影响。