從零開始玩轉(zhuǎn)logback

原文出處:朱小廝

概述

LogBack是一個(gè)日志框架,它與Log4j可以說是同出一源,都出自Ceki Gülcü之手。(log4j的原型是早前由Ceki Gülcü貢獻(xiàn)給Apache基金會(huì)的)下載地址:http://logback.qos.ch/download.html

LogBack、Slf4j和Log4j之間的關(guān)系

Slf4j是The Simple Logging Facade for Java的簡稱,是一個(gè)簡單日志門面抽象框架,它本身只提供了日志Facade API和一個(gè)簡單的日志類實(shí)現(xiàn),一般常配合Log4j,LogBack,java.util.logging使用。Slf4j作為應(yīng)用層的Log接入時(shí),程序可以根據(jù)實(shí)際應(yīng)用場(chǎng)景動(dòng)態(tài)調(diào)整底層的日志實(shí)現(xiàn)框架(Log4j/LogBack/JdkLog…)。

LogBack和Log4j都是開源日記工具庫,LogBack是Log4j的改良版本,比Log4j擁有更多的特性,同時(shí)也帶來很大性能提升。詳細(xì)數(shù)據(jù)可參照下面地址:Reasons to prefer logback over log4j。

LogBack官方建議配合Slf4j使用,這樣可以靈活地替換底層日志框架。

TIPS:為了優(yōu)化log4j,以及更大性能的提升,Apache基金會(huì)已經(jīng)著手開發(fā)了log4j 2.0, 其中也借鑒和吸收了logback的一些先進(jìn)特性,目前l(fā)og4j2還處于beta階段。

LogBack的結(jié)構(gòu)

LogBack被分為3個(gè)組件,logback-core, logback-classic 和 logback-access。

其中l(wèi)ogback-core提供了LogBack的核心功能,是另外兩個(gè)組件的基礎(chǔ)。

logback-classic則實(shí)現(xiàn)了Slf4j的API,所以當(dāng)想配合Slf4j使用時(shí),需要將logback-classic加入classpath。

logback-access是為了集成Servlet環(huán)境而準(zhǔn)備的,可提供HTTP-access的日志接口。


配置詳解

根節(jié)點(diǎn)<configuration>包含的屬性

  • scan:當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會(huì)被重新加載,默認(rèn)值為true.
  • scanPeriod:設(shè)置監(jiān)測(cè)配置文件是否有修改的時(shí)間間隔,如果沒有給出時(shí)間單位,默認(rèn)單位是毫秒。當(dāng)scan為true時(shí),此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘.
  • debug:當(dāng)此屬性設(shè)置為true時(shí),將打印出logback內(nèi)部日志信息,實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。

XML代碼:

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

根節(jié)點(diǎn)<configuration>的子節(jié)點(diǎn)

LogBack的配置大概包括3部分:appender, logger和root。

設(shè)置上下文名稱<contextName>

每個(gè)logger都關(guān)聯(lián)到logger上下文,默認(rèn)上下文名稱為“default”。但可以使用<contextName>設(shè)置成其他名字,用于區(qū)分不同應(yīng)用程序的記錄。一旦設(shè)置,不能修改。

XML代碼:

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

設(shè)置變量 <property>

用來定義變量值的標(biāo)簽,<property> 有兩個(gè)屬性,name和value;其中name的值是變量的名稱,value的值時(shí)變量定義的值。通過<property>定義的值會(huì)被插入到logger上下文中。定義變量后,可以使“${}”來使用變量。

例如使用<property>定義上下文名稱,然后在<contentName>設(shè)置logger上下文時(shí)使用。

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

獲取時(shí)間戳字符串 <timestamp>

兩個(gè)屬性 key:標(biāo)識(shí)此<timestamp> 的名字;datePattern:設(shè)置將當(dāng)前時(shí)間(解析配置文件的時(shí)間)轉(zhuǎn)換為字符串的模式,遵循Java.txt.SimpleDateFormat的格式。

例如將解析配置文件的時(shí)間作為上下文名稱:

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

設(shè)置logger和root

<logger>
用來設(shè)置某一個(gè)包或者具體的某一個(gè)類的日志打印級(jí)別、以及指定<appender>。<logger>僅有一個(gè)name屬性,一個(gè)可選的level和一個(gè)可選的additivity屬性。

  • name:用來指定受此logger約束的某一個(gè)包或者具體的某一個(gè)類。
  • level:用來設(shè)置打印級(jí)別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個(gè)特殊值INHERITED或者同義詞NULL,代表強(qiáng)制執(zhí)行上級(jí)的級(jí)別。
    如果未設(shè)置此屬性,那么當(dāng)前l(fā)ogger將會(huì)繼承上級(jí)的級(jí)別。
  • additivity:是否向上級(jí)logger傳遞打印信息。默認(rèn)是true。

<logger>可以包含零個(gè)或多個(gè)<appender-ref>元素,標(biāo)識(shí)這個(gè)appender將會(huì)添加到這個(gè)logger。

<root>
也是<logger>元素,但是它是根logger。只有一個(gè)level屬性,應(yīng)為已經(jīng)被命名為”root”.

  • level:用來設(shè)置打印級(jí)別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設(shè)置為INHERITED或者同義詞NULL。默認(rèn)是DEBUG。

<root>可以包含零個(gè)或多個(gè)<appender-ref>元素,標(biāo)識(shí)這個(gè)appender將會(huì)添加到這個(gè)logger。

案例介紹

首先,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配置文件

只配置root
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">   
        <!-- encoder 默認(rèn)配置為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的配置表示打印到控制臺(tái)(稍后詳細(xì)講解appender )。<root level=”INFO”>將root的打印級(jí)別設(shè)置為“INFO”,指定了名字為“STDOUT”的appender。

當(dāng)執(zhí)行l(wèi)ogback.LogbackDemo類的main方法時(shí),root將級(jí)別為“INFO”及大于“INFO”的日志信息交給已經(jīng)配置好的名為“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制臺(tái);

輸出結(jié)果:

13:30:38.484 [main] INFO  logback.LogbackDemo - ======info  
13:30:38.500 [main] WARN  logback.LogbackDemo - ======warn  
13:30:38.500 [main] ERROR logback.LogbackDemo - ======error
帶有l(wèi)ogger的配置,不指定級(jí)別,不指定appender
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
        <!-- encoder 默認(rèn)配置為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的配置表示打印到控制臺(tái)。
輸出結(jié)果:

13:19:15.406[main] DEBUG logback.LogbackDemo - ======debug
13:19:15.406[main] INFO  logback.LogbackDemo - ======info
13:19:15.406[main] WARN  logback.LogbackDemo - ======warn
13:19:15.406[main] ERROR logback.LogbackDemo - ======error

<logger name=”logback” />將控制logback包下的所有類的日志的打印,但是并沒有設(shè)置打印級(jí)別,所以繼承他的上級(jí)<root>的日志級(jí)別“DEBUG”。

沒有設(shè)置additivity,默認(rèn)為true,將此logger的打印信息向上級(jí)傳遞。

沒有設(shè)置appender,此logger本身不打印任何信息。

<root level=”DEBUG”>將root的打印級(jí)別設(shè)置為“DEBUG”,指定了名字為“STDOUT”的appender。

當(dāng)執(zhí)行l(wèi)ogback.LogbackDemo類的main方法時(shí),因?yàn)長ogbackDemo 在包logback中,所以首先執(zhí)行<logger name=”logback” />,將級(jí)別為“DEBUG”及大于“DEBUG”的日志信息傳遞給root,本身并不打印。

root接到下級(jí)傳遞的信息,交給已經(jīng)配置好的名為“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制臺(tái)。

帶有多個(gè)logger的配置,指定級(jí)別,指定appender
<configuration>
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <!-- encoder 默認(rèn)配置為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>

輸出結(jié)果:

14:05:35.937[main] INFO  logback.LogbackDemo - ======info 
14:05:35.937[main] WARN  logback.LogbackDemo - ======warn
14:05:35.937[main] ERROR logback.LogbackDemo - ======error

<logger name=”logback” />將控制logback包下的所有類的日志的打印,但是并沒用設(shè)置打印級(jí)別,所以繼承他的上級(jí)<root>的日志級(jí)別“DEBUG”。

沒有設(shè)置additivity,默認(rèn)為true,將此logger的打印信息向上級(jí)傳遞。

沒有設(shè)置appender,此logger本身不打印任何信息。

<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>控制logback.LogbackDemo類的日志打印,打印級(jí)別為“INFO”。
additivity屬性為false,表示此logger的打印信息不再向上級(jí)傳遞,指定了名字為“STDOUT”的appender。

<root level=”DEBUG”>將root的打印級(jí)別設(shè)置為“ERROR”,指定了名字為“STDOUT”的appender。

當(dāng)執(zhí)行l(wèi)ogback.LogbackDemo類的main方法時(shí),先執(zhí)行<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>,將級(jí)別為“INFO”及大于“INFO”的日志信息交給此logger指定的名為“STDOUT”的appender處理,在控制臺(tái)中打出日志,不再向次logger的上級(jí) <logger name=”logback”/> 傳遞打印信息。

<logger name=”logback”/>未接到任何打印信息,當(dāng)然也不會(huì)給它的上級(jí)root傳遞任何打印信息。

如果將<logger name=”logback.LogbackDemo” level=”INFO” additivity=”false”>修改為 <logger name=”logback.LogbackDemo” level=”INFO” additivity=”true”>那打印結(jié)果將是什么呢?
沒錯(cuò),日志打印了兩次,想必大家都知道原因了,因?yàn)榇蛴⌒畔⑾蛏霞?jí)傳遞,logger本身打印一次,root接到后又打印一次:

14:09:01.531[main] INFO  logback.LogbackDemo - ======info 
14:09:01.531[main] INFO  logback.LogbackDemo - ======info
14:09:01.531[main] WARN  logback.LogbackDemo - ======warn 
14:09:01.531[main] WARN  logback.LogbackDemo - ======warn
14:09:01.531[main] ERROR logback.LogbackDemo - ======error
14:09:01.531[main] ERROR logback.LogbackDemo - ======error

<appender>詳解

<appender>是<configuration>的子節(jié)點(diǎn),是負(fù)責(zé)寫日志的組件。<appender>有兩個(gè)必要屬性name和class。name指定appender名稱,class指定appender的全限定名。

ConsoleAppender

把日志添加到控制臺(tái),有以下子節(jié)點(diǎn):

  • <encoder>:對(duì)日志進(jìn)行格式化。(具體參數(shù)稍后講解 )
  • <target>:字符串 System.out 或者 System.err ,默認(rèn) 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>

FileAppender

把日志添加到文件,有以下子節(jié)點(diǎn):

  • <file>:被寫入的文件名,可以是相對(duì)目錄,也可以是絕對(duì)目錄,如果上級(jí)目錄不存在會(huì)自動(dòng)創(chuàng)建,沒有默認(rèn)值。
  • <append>:如果是 true,日志被追加到文件結(jié)尾,如果是 false,清空現(xiàn)存文件,默認(rèn)是true。
  • <encoder>:對(duì)記錄事件進(jìn)行格式化。(具體參數(shù)稍后講解 )
  • <prudent>:如果是 true,日志會(huì)被安全的寫入文件,即使其他的FileAppender也在向此文件做寫入操作,效率低,默認(rèn)是 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>

RollingFIleAppender

滾動(dòng)記錄文件,先將日志記錄到指定文件,當(dāng)符合某個(gè)條件時(shí),將日志記錄到其他文件。有以下子節(jié)點(diǎn):

  • <file>:被寫入的文件名,可以是相對(duì)目錄,也可以是絕對(duì)目錄,如果上級(jí)目錄不存在會(huì)自動(dòng)創(chuàng)建,沒有默認(rèn)值。
  • <append>:如果是 true,日志被追加到文件結(jié)尾,如果是 false,清空現(xiàn)存文件,默認(rèn)是true。
  • <encoder>:對(duì)記錄事件進(jìn)行格式化。(具體參數(shù)稍后講解 )
  • <rollingPolicy>:當(dāng)發(fā)生滾動(dòng)時(shí),決定 RollingFileAppender 的行為,涉及文件移動(dòng)和重命名。
  • <triggeringPolicy >: 告知 RollingFileAppender 何時(shí)激活滾動(dòng)。
  • <prudent>:當(dāng)為true時(shí),不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有兩個(gè)限制,1不支持也不允許文件壓縮,2不能設(shè)置file屬性,必須留空。
>>>>rollingPolicy
  • TimeBasedRollingPolicy: 最常用的滾動(dòng)策略,它根據(jù)時(shí)間來制定滾動(dòng)策略,既負(fù)責(zé)滾動(dòng)也負(fù)責(zé)觸發(fā)滾動(dòng)。有以下子節(jié)點(diǎn):

<fileNamePattern>: 必要節(jié)點(diǎn),包含文件名及“%d”轉(zhuǎn)換符,%d”可以包含一個(gè)Java.text.SimpleDateFormat指定的時(shí)間格式,如:%d{yyyy-MM}。如果直接使用 %d,默認(rèn)格式是 yyyy-MM-dd。RollingFileAppender 的file字節(jié)點(diǎn)可有可無,通過設(shè)置file,可以為活動(dòng)文件和歸檔文件指定不同位置,當(dāng)前日志總是記錄到file指定的文件(活動(dòng)文件),活動(dòng)文件的名字不會(huì)改變;如果沒設(shè)置file,活動(dòng)文件的名字會(huì)根據(jù)fileNamePattern 的值,每隔一段時(shí)間改變一次?!?”或者“\”會(huì)被當(dāng)做目錄分隔符。

<maxHistory>: 可選節(jié)點(diǎn),控制保留的歸檔文件的最大數(shù)量,超出數(shù)量就刪除舊文件。假設(shè)設(shè)置每個(gè)月滾動(dòng),且<maxHistory>是6,則只保存最近6個(gè)月的文件,刪除之前的舊文件。注意,刪除舊文件是,那些為了歸檔而創(chuàng)建的目錄也會(huì)被刪除。

  • FixedWindowRollingPolicy: 根據(jù)固定窗口算法重命名文件的滾動(dòng)策略。有以下子節(jié)點(diǎn):

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

<maxIndex>:窗口索引最大值,當(dāng)用戶指定的窗口過大時(shí),會(huì)自動(dòng)將窗口設(shè)置為12。

<fileNamePattern >: 必須包含“%i”例如,假設(shè)最小值和最大值分別為1和2,命名模式為 mylog%i.log,會(huì)產(chǎn)生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項(xiàng),例如,mylog%i.log.gz 或者 沒有l(wèi)og%i.log.zip

>>>>triggeringPolicy
  • SizeBasedTriggeringPolicy: 查看當(dāng)前活動(dòng)文件的大小,如果超過指定大小會(huì)告知RollingFileAppender 觸發(fā)當(dāng)前活動(dòng)文件滾動(dòng)。只有一個(gè)節(jié)點(diǎn):

<maxFileSize>:這是活動(dòng)文件的大小,默認(rèn)值是10MB。

例如:每天生產(chǎn)一個(gè)日志文件,保存30天的日志文件

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

又例如:按照固定窗口模式生成日志文件,當(dāng)文件大于20MB時(shí),生成新的日志文件。窗口大小是1到3,當(dāng)保存了3個(gè)歸檔文件后,將覆蓋最早的日志。

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

另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,并不常用,這些就不在這里講解了,大家可以參考官方文檔。當(dāng)然大家可以編寫自己的Appender。

<encoder>

負(fù)責(zé)兩件事,一是把日志信息轉(zhuǎn)換成字節(jié)數(shù)組,二是把字節(jié)數(shù)組寫入到輸出流。
目前PatternLayoutEncoder 是唯一有用的且默認(rèn)的encoder ,有一個(gè)<pattern>節(jié)點(diǎn),用來設(shè)置日志的輸入格式。使用“%”加“轉(zhuǎn)換符”方式,如果要輸出“%”,則必須用“\”對(duì)“%”進(jìn)行轉(zhuǎn)義。
例如:

<encoder>
    <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
</encoder>

格式修飾符,與轉(zhuǎn)換符共同使用:
可選的格式修飾符位于“%”和轉(zhuǎn)換符之間。第一個(gè)可選修飾符是左對(duì)齊 標(biāo)志,符號(hào)是減號(hào)“-”;接著是可選的最小寬度 修飾符,用十進(jìn)制數(shù)表示。如果字符小于最小寬度,則左填充或右填充,默認(rèn)是左填充(即右對(duì)齊),填充符為空格。如果字符大于最小寬度,字符永遠(yuǎn)不會(huì)被截?cái)唷W畲髮挾?修飾符,符號(hào)是點(diǎn)號(hào)”.”后面加十進(jìn)制數(shù)。如果字符大于最大寬度,則從前面截?cái)唷|c(diǎn)符號(hào)“.”后面加減號(hào)“-”在加數(shù)字,表示從尾部截?cái)唷?/p>

例如:%-4relative 表示,將輸出從程序啟動(dòng)到創(chuàng)建日志記錄的時(shí)間 進(jìn)行左對(duì)齊 且最小寬度為4。


完整配置案例

最后附上相對(duì)比較完整的,涵蓋大部分配置的案例,案例中有解析。

<?xml version="1.0" encoding="UTF-8"?>
<!--
-scan:當(dāng)此屬性設(shè)置為true時(shí),配置文件如果發(fā)生改變,將會(huì)被重新加載,默認(rèn)值為true
-scanPeriod:設(shè)置監(jiān)測(cè)配置文件是否有修改的時(shí)間間隔,如果沒有給出時(shí)間單位,默認(rèn)單位是毫秒。
-           當(dāng)scan為true時(shí),此屬性生效。默認(rèn)的時(shí)間間隔為1分鐘
-debug:當(dāng)此屬性設(shè)置為true時(shí),將打印出logback內(nèi)部日志信息,實(shí)時(shí)查看logback運(yùn)行狀態(tài)。默認(rèn)值為false。
-
- configuration 子節(jié)點(diǎn)為 appender、logger、root
-->
<configuration scan="true" scanPeriod="60 second" debug="false">
 
    <!-- 負(fù)責(zé)寫日志,控制臺(tái)日志 -->
    <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
 
        <!-- 一是把日志信息轉(zhuǎn)換成字節(jié)數(shù)組,二是把字節(jié)數(shù)組寫入到輸出流 -->
        <encoder>
            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
 
    <!-- 文件日志 -->
    <appender name="DEBUG" class="ch.qos.logback.core.FileAppender">
        <file>debug.log</file>
        <!-- append: true,日志被追加到文件結(jié)尾; false,清空現(xiàn)存文件;默認(rèn)是true -->
        <append>true</append>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <!-- LevelFilter: 級(jí)別過濾器,根據(jù)日志級(jí)別進(jìn)行過濾 -->
            <level>DEBUG</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
        <encoder>
            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>
 
    <!-- 滾動(dòng)記錄文件,先將日志記錄到指定文件,當(dāng)符合某個(gè)條件時(shí),將日志記錄到其他文件 -->
    <appender name="INFO" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <File>info.log</File>
 
        <!-- ThresholdFilter:臨界值過濾器,過濾掉 TRACE 和 DEBUG 級(jí)別的日志 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>INFO</level>
        </filter>
 
        <encoder>
            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>
            <charset>UTF-8</charset>
        </encoder>
 
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 每天生成一個(gè)日志文件,保存30天的日志文件
            - 如果隔一段時(shí)間沒有輸出日志,前面過期的日志不會(huì)被刪除,只有再重新打印日志的時(shí)候,會(huì)觸發(fā)刪除過期日志的操作。
            -->
            <fileNamePattern>info.%d{yyyy-MM-dd}.log</fileNamePattern>
            <maxHistory>30</maxHistory>
            <TimeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </TimeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
    </appender >
 
    <!--<!– 異常日志輸出 –>-->
    <!--<appender name="EXCEPTION" class="ch.qos.logback.core.rolling.RollingFileAppender">-->
        <!--<file>exception.log</file>-->
        <!--<!– 求值過濾器,評(píng)估、鑒別日志是否符合指定條件. 需要額外的兩個(gè)JAR包,commons-compiler.jar和janino.jar –>-->
        <!--<filter class="ch.qos.logback.core.filter.EvaluatorFilter">-->
            <!--<!– 默認(rèn)為 ch.qos.logback.classic.boolex.JaninoEventEvaluator –>-->
            <!--<evaluator>-->
                <!--<!– 過濾掉所有日志消息中不包含"Exception"字符串的日志 –>-->
                <!--<expression>return message.contains("Exception");</expression>-->
            <!--</evaluator>-->
            <!--<OnMatch>ACCEPT</OnMatch>-->
            <!--<OnMismatch>DENY</OnMismatch>-->
        <!--</filter>-->
 
        <!--<triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">-->
            <!--<!– 觸發(fā)節(jié)點(diǎn),按固定文件大小生成,超過5M,生成新的日志文件 –>-->
            <!--<maxFileSize>5MB</maxFileSize>-->
        <!--</triggeringPolicy>-->
    <!--</appender>-->
 
    <appender name="ERROR" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>error.log</file>
 
        <encoder>
            <Pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%5level] [%thread] %logger{0} %msg%n</Pattern>
            <charset>UTF-8</charset>
        </encoder>
 
        <!-- 按照固定窗口模式生成日志文件,當(dāng)文件大于20MB時(shí),生成新的日志文件。
        -    窗口大小是1到3,當(dāng)保存了3個(gè)歸檔文件后,將覆蓋最早的日志。
        -    可以指定文件壓縮選項(xiàng)
        -->
        <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">
            <fileNamePattern>error.%d{yyyy-MM}(%i).log.zip</fileNamePattern>
            <minIndex>1</minIndex>
            <maxIndex>3</maxIndex>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>
 
    <!-- 異步輸出 -->
    <appender name ="ASYNC" class= "ch.qos.logback.classic.AsyncAppender">
        <!-- 不丟失日志.默認(rèn)的,如果隊(duì)列的80%已滿,則會(huì)丟棄TRACT、DEBUG、INFO級(jí)別的日志 -->
        <discardingThreshold >0</discardingThreshold>
        <!-- 更改默認(rèn)的隊(duì)列的深度,該值會(huì)影響性能.默認(rèn)值為256 -->
        <queueSize>512</queueSize>
        <!-- 添加附加的appender,最多只能添加一個(gè) -->
        <appender-ref ref ="ERROR"/>
    </appender>
 
    <!--
    - 1.name:包名或類名,用來指定受此logger約束的某一個(gè)包或者具體的某一個(gè)類
    - 2.未設(shè)置打印級(jí)別,所以繼承他的上級(jí)<root>的日志級(jí)別“DEBUG”
    - 3.未設(shè)置additivity,默認(rèn)為true,將此logger的打印信息向上級(jí)傳遞;
    - 4.未設(shè)置appender,此logger本身不打印任何信息,級(jí)別為“DEBUG”及大于“DEBUG”的日志信息傳遞給root,
    -  root接到下級(jí)傳遞的信息,交給已經(jīng)配置好的名為“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制臺(tái);
    -->
    <logger name="ch.qos.logback" />
 
    <!--
    - 1.將級(jí)別為“INFO”及大于“INFO”的日志信息交給此logger指定的名為“STDOUT”的appender處理,在控制臺(tái)中打出日志,
    -   不再向次logger的上級(jí) <logger name="logback"/> 傳遞打印信息
    - 2.level:設(shè)置打印級(jí)別(TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF),還有一個(gè)特殊值INHERITED或者同義詞NULL,代表強(qiáng)制執(zhí)行上級(jí)的級(jí)別。
    -        如果未設(shè)置此屬性,那么當(dāng)前l(fā)ogger將會(huì)繼承上級(jí)的級(jí)別。
    - 3.additivity:為false,表示此logger的打印信息不再向上級(jí)傳遞,如果設(shè)置為true,會(huì)打印兩次
    - 4.appender-ref:指定了名字為"STDOUT"的appender。
    -->
    <logger name="com.weizhi.common.LogMain" level="INFO" additivity="false">
        <appender-ref ref="STDOUT"/>
        <!--<appender-ref ref="DEBUG"/>-->
        <!--<appender-ref ref="EXCEPTION"/>-->
        <!--<appender-ref ref="INFO"/>-->
        <!--<appender-ref ref="ERROR"/>-->
        <appender-ref ref="ASYNC"/>
    </logger>
 
    <!--
    - 根logger
    - level:設(shè)置打印級(jí)別,大小寫無關(guān):TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設(shè)置為INHERITED或者同義詞NULL。
    -       默認(rèn)是DEBUG。
    -appender-ref:可以包含零個(gè)或多個(gè)<appender-ref>元素,標(biāo)識(shí)這個(gè)appender將會(huì)添加到這個(gè)logger
    -->
    <root level="DEBUG">
        <appender-ref ref="STDOUT"/>
        <!--<appender-ref ref="DEBUG"/>-->
        <!--<appender-ref ref="EXCEPTION"/>-->
        <!--<appender-ref ref="INFO"/>-->
        <appender-ref ref="ASYNC"/>
    </root>
</configuration>

參考資料

  1. http://logback.qos.ch/
  2. logback 配置詳解(一)
  3. logback 常用配置詳解(二) <appender>
  4. Logback配置解析
  5. LogBack簡易教程
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。