logback詳解
說明:下面內(nèi)容從網(wǎng)上搜集整理而來
與log4j對(duì)比
- 更快的執(zhí)行速度: 基于我們先前在log4j上的工作,logback 重寫了內(nèi)部的實(shí)現(xiàn),在某些特定的場(chǎng)景上面川慌,甚至可以比之前的速度快上10倍麻昼。在保證logback的組件更加快速的同時(shí),同時(shí)所需的內(nèi)存更加少絮供。
- logback-classic 非常自然的實(shí)現(xiàn)了SLF4J:ogback-classic中的longging類自然的實(shí)現(xiàn)了SLF4J子巾。當(dāng)你使用 logback-classic作為底層實(shí)現(xiàn)時(shí)帆赢,涉及到LF4J日記系統(tǒng)的問題你完全不需要考慮。更進(jìn)一步來說线梗,由于 logback-classic強(qiáng)烈建議使用SLF4J作為客戶端日記系統(tǒng)實(shí)現(xiàn)椰于,如果需要切換到log4j或者其他,你只需要替換一個(gè)jar包即可仪搔,不需要去改變那些通過SLF4J API 實(shí)現(xiàn)的代碼瘾婿。這可以大大減少更換日記系統(tǒng)的工作量。
- 自動(dòng)重新載入配置文件:Logback-classic可以在配置文件被修改后烤咧,自動(dòng)重新載入偏陪。這個(gè)掃描過程很快,無資源爭(zhēng)用煮嫌,并且可以動(dòng)態(tài)擴(kuò)展支持在上百個(gè)線程之間每秒上百萬個(gè)調(diào)用笛谦。它和應(yīng)用服務(wù)器結(jié)合良好,并且在JEE環(huán)境通用昌阿,因?yàn)樗粫?huì)調(diào)用創(chuàng)建一個(gè)單獨(dú)的線程來做掃描饥脑。
- 優(yōu)雅地從I/O錯(cuò)誤中恢復(fù):FileAppender和它的子類,包括RollingFileAppender懦冰,可以優(yōu)雅的從I/O錯(cuò)誤中恢復(fù)灶轰。所以,如果一個(gè)文件服務(wù)器臨時(shí)宕機(jī)刷钢,你再也不需要重啟你的應(yīng)用框往,而日志功能就能正常工作。當(dāng)文件服務(wù)器恢復(fù)工作闯捎,logback相關(guān)的appender就會(huì)透明地和快速的從上一個(gè)錯(cuò)誤中恢復(fù)椰弊。
- 自動(dòng)清除舊的日志歸檔文件:通過設(shè)置TimeBasedRollingPolicy 或者 SizeAndTimeBasedFNATP的 maxHistory 屬性,你就可以控制日志歸檔文件的最大數(shù)量瓤鼻。如果你的回滾策略是每月回滾的秉版,并且你希望保存一年的日志,那么只需簡單的設(shè)置maxHistory屬性為12茬祷。對(duì)于12個(gè)月之前的歸檔日志文件將被自動(dòng)清除清焕。
- 自動(dòng)壓縮歸檔日志文件:RollingFileAppender可以在回滾操作中,自動(dòng)壓縮歸檔日志文件祭犯。壓縮通常是異步執(zhí)行的秸妥,所以即使是很大的日志文件,你的應(yīng)用都不會(huì)因此而被阻塞沃粗。
- 配置文件中的條件處理:開發(fā)者通常需要在不同的目標(biāo)環(huán)境中變換logback的配置文件粥惧,例如開發(fā)環(huán)境,測(cè)試環(huán)境和生產(chǎn)環(huán)境最盅。這些配置文件大體是一樣的突雪,除了某部分會(huì)有不同。為了避免重復(fù)涡贱,logback支持配置文件中的條件處理咏删,只需使用
<if>
,<then>
和<else>
,那么同一個(gè)配置文件就可以在不同的環(huán)境中使用了问词。 - 過濾: Logback擁有遠(yuǎn)比log4j更豐富的過濾能力督函。例如,讓我們假設(shè)激挪,有一個(gè)相當(dāng)重要的商業(yè)應(yīng)用部署在生產(chǎn)環(huán)境辰狡。考慮到大量的交易數(shù)據(jù)需要處理灌灾,記錄級(jí)別被設(shè)置為WARN搓译,那么只有警告和錯(cuò)誤信息才會(huì)被記錄。現(xiàn)在锋喜,想象一下些己,你在開發(fā)環(huán)境遇到了一個(gè)臭蟲,但是在測(cè)試平臺(tái)中卻很難發(fā)現(xiàn)嘿般,因?yàn)橐恍┉h(huán)境之間(生產(chǎn)環(huán)境/測(cè)試環(huán)境)的未知差異段标。使用log4j,你只能選擇在生產(chǎn)系統(tǒng)中降低記錄的級(jí)別到DEBUG炉奴,來嘗試發(fā)現(xiàn)問題逼庞。但是很不幸,這會(huì)生成大量的日志記錄瞻赶,讓分析變得困難赛糟。更重要的是派任,多余的日志記錄會(huì)影響到生產(chǎn)環(huán)境的性能。使用logback璧南,你可以選擇保留只所有用戶的WARN級(jí)別的日志掌逛,而除了某個(gè)用戶,例如Alice司倚,而她就是問題的相關(guān)用戶豆混。當(dāng)Alice登錄系統(tǒng),她就會(huì)以DEBUG級(jí)別被記錄动知,而其他用戶仍然是以WARN級(jí)別來記錄日志皿伺。這個(gè)功能,可以通過在配置文件的XML中添加4行盒粮。請(qǐng)?jiān)谙嚓P(guān)章節(jié)中查找MDCFilter
logback 基礎(chǔ)配置
根節(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。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<!-- 其他配置省略-->
</configuration>
根節(jié)點(diǎn)<configuration>
的子節(jié)點(diǎn)
設(shè)置上下文名稱:<contextName>
每個(gè)logger都關(guān)聯(lián)到logger上下文啸箫,默認(rèn)上下文名稱為“default”耸彪。但可以使用<contextName>
設(shè)置成其他名字,用于區(qū)分不同應(yīng)用程序的記錄忘苛。一旦設(shè)置蝉娜,不能修改。
<configuration scan="true" scanPeriod="60 seconds" debug="false">
<contextName>myAppName</contextName>
<!-- 其他配置省略-->
</configuration>
設(shè)置變量: <property>
有兩個(gè)屬性扎唾,name和value召川;其中name的值是變量的名稱,value的值時(shí)變量定義的值胸遇。通過<property>
定義的值會(huì)被插入到logger上下文中荧呐。定義變量后,可以使“${}”來使用變量。
例如使用<property>
定義上下文名稱倍阐,然后在<contentName>
設(shè)置logger上下文時(shí)使用概疆。
<configuration scan="true" scanPeriod="60 seconds" 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 seconds" debug="false">
<timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
<contextName>${bySecond}</contextName>
<!-- 其他配置省略-->
</configuration>
設(shè)置loger:
<loger>
用來設(shè)置某一個(gè)包或者具體的某一個(gè)類的日志打印級(jí)別、以及指定<appender>
罢艾。<loger>
僅有一個(gè)name屬性,一個(gè)可選的level和一個(gè)可選的addtivity屬性尽纽。
- name: 用來指定受此loger約束的某一個(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ā)oger將會(huì)繼承上級(jí)的級(jí)別期奔。
- addtivity: 是否向上級(jí)loger傳遞打印信息。默認(rèn)是true危尿。
<loger>
可以包含零個(gè)或多個(gè)<appender-ref>
元素呐萌,標(biāo)識(shí)這個(gè)appender將會(huì)添加到這個(gè)loger。
<root>
也是<loger>
元素谊娇,但是它是根loger肺孤。只有一個(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è)loger。
示例
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 默認(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
第2種:帶有l(wèi)oger的配置凹髓,不指定級(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)(稍后詳細(xì)講解appender );
<logger name="logback" />
將控制logback包下的所有類的日志的打印,但是并沒用設(shè)置打印級(jí)別饵沧,所以繼承他的上級(jí)<root>
的日志級(jí)別“DEBUG”锨络;
沒有設(shè)置addtivity,默認(rèn)為true狼牺,將此loger的打印信息向上級(jí)傳遞羡儿;
沒有設(shè)置appender,此loger本身不打印任何信息是钥。
<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);
打印結(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
第3種:帶有多個(gè)loger的配置毁渗,指定級(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>
其中appender的配置表示打印到控制臺(tái)(稍后詳細(xì)講解appender );
<logger name="logback" />
將控制logback包下的所有類的日志的打印祝蝠,但是并沒用設(shè)置打印級(jí)別音诈,所以繼承他的上級(jí)<root>
的日志級(jí)別“DEBUG”;
沒有設(shè)置addtivity绎狭,默認(rèn)為true细溅,將此loger的打印信息向上級(jí)傳遞;
沒有設(shè)置appender儡嘶,此loger本身不打印任何信息喇聊。
<logger name="logback.LogbackDemo" level="INFO" additivity="false">
控制logback.LogbackDemo類的日志打印,打印級(jí)別為“INFO”蹦狂;
additivity屬性為false誓篱,表示此loger的打印信息不再向上級(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”的日志信息交給此loger指定的名為“STDOUT”的appender處理,在控制臺(tái)中打出日志,不再向次loger的上級(jí) <logger name="logback"/>
傳遞打印信息准验;
<logger name="logback"/>
未接到任何打印信息赎线,當(dāng)然也不會(huì)給它的上級(jí)root傳遞任何打印信息;
打印結(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.LogbackDemo" level="INFO" additivity="false">
修改為 <logger name="logback.LogbackDemo" level="INFO" additivity="true">
那打印結(jié)果將是什么呢糊饱?
沒錯(cuò)垂寥,日志打印了兩次,想必大家都知道原因了另锋,因?yàn)榇蛴⌒畔⑾蛏霞?jí)傳遞滞项,logger本身打印一次,root接到后又打印一次
打印結(jié)果如下:
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 合適激活滾動(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煌茴。
例如:每天生成一個(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)唷?br>
例如:%-4relative 表示软瞎,將輸出從程序啟動(dòng)到創(chuàng)建日志記錄的時(shí)間 進(jìn)行左對(duì)齊 且最小寬度為4。
<filter>
過濾器拉讯,執(zhí)行一個(gè)過濾器會(huì)有返回個(gè)枚舉值涤浇,即DENY,NEUTRAL魔慷,ACCEPT其中之一芙代。返回DENY,日志將立即被拋棄不再經(jīng)過其他過濾器盖彭;返回NEUTRAL纹烹,有序列表里的下個(gè)過濾器過接著處理日志页滚;返回ACCEPT,日志會(huì)被立即處理铺呵,不再經(jīng)過剩余過濾器裹驰。
過濾器被添加到<Appender>
中,為<Appender>
添加一個(gè)或多個(gè)過濾器后片挂,可以用任意條件對(duì)日志進(jìn)行過濾幻林。<Appender>
有多個(gè)過濾器時(shí),按照配置順序執(zhí)行音念。
下面是幾個(gè)常用的過濾器:
LevelFilter: 級(jí)別過濾器沪饺,根據(jù)日志級(jí)別進(jìn)行過濾。如果日志級(jí)別等于配置級(jí)別闷愤,過濾器會(huì)根據(jù)onMath 和 onMismatch接收或拒絕日志整葡。有以下子節(jié)點(diǎn):
<level>
:設(shè)置過濾級(jí)別
<onMatch>
:用于配置符合過濾條件的操作
<onMismatch>
:用于配置不符合過濾條件的操作
例如:將過濾器的日志級(jí)別配置為INFO,所有INFO級(jí)別的日志交給appender處理讥脐,非INFO級(jí)別的日志遭居,被過濾掉。
<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>
%-4relative [%thread] %-5level %logger{30} - %msg%n
</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="CONSOLE" />
</root>
</configuration>
ThresholdFilter:
臨界值過濾器旬渠,過濾掉低于指定臨界值的日志俱萍。當(dāng)日志級(jí)別等于或高于臨界值時(shí),過濾器返回NEUTRAL告丢;當(dāng)日志級(jí)別低于臨界值時(shí)枪蘑,日志會(huì)被拒絕。
例如:過濾掉所有低于INFO級(jí)別的日志岖免。
<configuration>
<appender name="CONSOLE"
class="ch.qos.logback.core.ConsoleAppender">
<!-- 過濾掉 TRACE 和 DEBUG 級(jí)別的日志-->
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>INFO</level>
</filter>
<encoder>
<pattern>
%-4relative [%thread] %-5level %logger{30} - %msg%n
</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="CONSOLE" />
</root>
</configuration>
EvaluatorFilter:
求值過濾器腥寇,評(píng)估、鑒別日志是否符合指定條件觅捆。有一下子節(jié)點(diǎn):
<evaluator>
:
鑒別器,常用的鑒別器是JaninoEventEvaluato麻敌,也是默認(rèn)的鑒別器栅炒,它以任意的Java布爾值表達(dá)式作為求值條件,求值條件在配置文件解釋過成功被動(dòng)態(tài)編譯术羔,布爾值表達(dá)式返回true就表示符合過濾條件赢赊。evaluator有個(gè)子標(biāo)簽<expression>
,用于配置求值條件级历。
<onMatch>
:用于配置符合過濾條件的操作
<onMismatch>
:用于配置不符合過濾條件的操作
例如:過濾掉所有日志消息中不包含“billing”字符串的日志释移。
<configuration>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<filter class="ch.qos.logback.core.filter.EvaluatorFilter">
<evaluator> <!-- 默認(rèn)為 ch.qos.logback.classic.boolex.JaninoEventEvaluator -->
<expression>return message.contains("billing");</expression>
</evaluator>
<OnMatch>ACCEPT </OnMatch>
<OnMismatch>DENY</OnMismatch>
</filter>
<encoder>
<pattern>
%-4relative [%thread] %-5level %logger - %msg%n
</pattern>
</encoder>
</appender>
<root level="INFO">
<appender-ref ref="STDOUT" />
</root>
</configuration>
<matcher>
:
匹配器,盡管可以使用String類的matches()方法進(jìn)行模式匹配寥殖,但會(huì)導(dǎo)致每次調(diào)用過濾器時(shí)都會(huì)創(chuàng)建一個(gè)新的Pattern對(duì)象玩讳,為了消除這種開銷涩蜘,可以預(yù)定義一個(gè)或多個(gè)matcher對(duì)象,定以后就可以在求值表達(dá)式中重復(fù)引用熏纯。<matcher>
是<evaluator>
的子標(biāo)簽同诫。
<matcher>
中包含兩個(gè)子標(biāo)簽,一個(gè)是<name>
樟澜,用于定義matcher的名字误窖,求值表達(dá)式中使用這個(gè)名字來引用matcher;另一個(gè)是<regex>
秩贰,用于配置匹配條件霹俺。
<configuration debug="true">
<appender name="STDOUT" 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>
<OnMismatch>NEUTRAL</OnMismatch>
<OnMatch>DENY</OnMatch>
</filter>
<encoder>
<pattern>%-4relative [%thread] %-5level %logger - %msg%n</pattern>
</encoder>
</appender>
<root level="DEBUG">
<appender-ref ref="STDOUT" />
</root>
</configuration>