logback

一:根節點包含的屬性:

scan:

當此屬性設置為true時,配置文件如果發生改變,將會被重新加載,默認值為true。

scanPeriod:

設置監測配置文件是否有修改的時間間隔,如果沒有給出時間單位,默認單位是毫秒。當scan為true時,此屬性生效。默認的時間間隔為1分鐘。

debug:

當此屬性設置為true時,將打印出logback內部日志信息,實時查看logback運行狀態。默認值為false。

例如:

Xml代碼


二:根節點的子節點:

2.1設置上下文名稱:

每個logger都關聯到logger上下文,默認上下文名稱為“default”。但可以使用設置成其他名字,用于區分不同應用程序的記錄。一旦設置,不能修改。

Xml代碼

myAppName


2.2設置變量:

用來定義變量值的標簽, 有兩個屬性,name和value;其中name的值是變量的名稱,value的值時變量定義的值。通過定義的值會被插入到logger上下文中。定義變量后,可以使“${}”來使用變量。

例如使用定義上下文名稱,然后在設置logger上下文時使用。

Xml代碼

${APP_Name}


2.3獲取時間戳字符串:

兩個屬性 key:標識此的名字;datePattern:設置將當前時間(解析配置文件的時間)轉換為字符串的模式,遵循java.txt.SimpleDateFormat的格式。

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

Xml代碼

${bySecond}


2.4設置loger:

用來設置某一個包或者具體的某一個類的日志打印級別、以及指定。僅有一個name屬性,一個可選的level和一個可選的addtivity屬性。

name:

用來指定受此loger約束的某一個包或者具體的某一個類。

level:

用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,還有一個特俗值INHERITED或者同義詞NULL,代表強制執行上級的級別。

如果未設置此屬性,那么當前loger將會繼承上級的級別。

addtivity:

是否向上級loger傳遞打印信息。默認是true。

可以包含零個或多個元素,標識這個appender將會添加到這個loger。

也是元素,但是它是根loger。只有一個level屬性,應為已經被命名為"root".

level:

用來設置打印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設置為INHERITED或者同義詞NULL。

默認是DEBUG。

可以包含零個或多個元素,標識這個appender將會添加到這個loger。

例如:

LogbackDemo.java類

Java代碼

packagelogback;

importorg.slf4j.Logger;

importorg.slf4j.LoggerFactory;

publicclassLogbackDemo {

privatestaticLogger log = LoggerFactory.getLogger(LogbackDemo.class);

publicstaticvoidmain(String[] args) {

log.trace("======trace");

log.debug("======debug");

log.info("======info");

log.warn("======warn");

log.error("======error");

}

}

logback.xml配置文件

第1種:只配置root

Xml代碼


%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n

其中appender的配置表示打印到控制臺(稍后詳細講解appender);

將root的打印級別設置為“INFO”,指定了名字為“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時,root將級別為“INFO”及大于“INFO”的日志信息交給已經配置好的名為“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制臺;

打印結果如下:

Xml代碼

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種:帶有loger的配置,不指定級別,不指定appender,

Xml代碼


%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n


其中appender的配置表示打印到控制臺(稍后詳細講解appender);

將控制logback包下的所有類的日志的打印,但是并沒用設置打印級別,所以繼承他的上級的日志級別“DEBUG”;

沒有設置addtivity,默認為true,將此loger的打印信息向上級傳遞;

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

將root的打印級別設置為“DEBUG”,指定了名字為“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時,因為LogbackDemo 在包logback中,所以首先執行,將級別為“DEBUG”及大于“DEBUG”的日志信息傳遞給root,本身并不打印;

root接到下級傳遞的信息,交給已經配置好的名為“STDOUT”的appender處理,“STDOUT”appender將信息打印到控制臺;

打印結果如下:

Xml代碼

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種:帶有多個loger的配置,指定級別,指定appender

Xml代碼


%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n



其中appender的配置表示打印到控制臺(稍后詳細講解appender);

將控制logback包下的所有類的日志的打印,但是并沒用設置打印級別,所以繼承他的上級的日志級別“DEBUG”;

沒有設置addtivity,默認為true,將此loger的打印信息向上級傳遞;

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

控制logback.LogbackDemo類的日志打印,打印級別為“INFO”;

additivity屬性為false,表示此loger的打印信息不再向上級傳遞,

指定了名字為“STDOUT”的appender。

將root的打印級別設置為“ERROR”,指定了名字為“STDOUT”的appender。

當執行logback.LogbackDemo類的main方法時,先執行,將級別為“INFO”及大于“INFO”的日志信息交給此loger指定的名為“STDOUT”的appender處理,在控制臺中打出日志,不再向次loger的上級 傳遞打印信息;

未接到任何打印信息,當然也不會給它的上級root傳遞任何打印信息;

打印結果如下:

Xml代碼

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本身打印一次,root接到后又打印一次

打印結果如下:

Xml代碼

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

***********************************************詳解>******************************************

是的子節點,是負責寫日志的組件。

有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名。

1.ConsoleAppender:

把日志添加到控制臺,有以下子節點:

:對日志進行格式化。(具體參數稍后講解)

:字符串System.out或者System.err,默認System.out

例如:

Xml代碼

%-4relative [%thread] %-5level %logger{35} - %msg %n

2.FileAppender:

把日志添加到文件,有以下子節點:

:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創建,沒有默認值。

:如果是 true,日志被追加到文件結尾,如果是 false,清空現存文件,默認是true。

:對記錄事件進行格式化。(具體參數稍后講解)

:如果是 true,日志會被安全的寫入文件,即使其他的FileAppender也在向此文件做寫入操作,效率低,默認是 false。

例如:

Xml代碼

testFile.log

true

%-4relative [%thread] %-5level %logger{35} - %msg%n

3.RollingFileAppender:

滾動記錄文件,先將日志記錄到指定文件,當符合某個條件時,將日志記錄到其他文件。有以下子節點:

:被寫入的文件名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動創建,沒有默認值。

:如果是 true,日志被追加到文件結尾,如果是 false,清空現存文件,默認是true。

:對記錄事件進行格式化。(具體參數稍后講解)

:當發生滾動時,決定RollingFileAppender的行為,涉及文件移動和重命名。

>:告知RollingFileAppender合適激活滾動。

:當為true時,不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy,但是有兩個限制,1不支持也不允許文件壓縮,2不能設置file屬性,必須留空。

rollingPolicy:

TimeBasedRollingPolicy:最常用的滾動策略,它根據時間來制定滾動策略,既負責滾動也負責出發滾動。有以下子節點:

:

必要節點,包含文件名及“%d”轉換符,“%d”可以包含一個java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。如果直接使用 %d,默認格式是 yyyy-MM-dd。RollingFileAppender的file字節點可有可無,通過設置file,可以為活動文件和歸檔文件指定不同位置,當前日志總是記錄到file指定的文件(活動文件),活動文件的名字不會改變;如果沒設置file,活動文件的名字會根據fileNamePattern的值,每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。

:

可選節點,控制保留的歸檔文件的最大數量,超出數量就刪除舊文件。假設設置每個月滾動,且是6,則只保存最近6個月的文件,刪除之前的舊文件。注意,刪除舊文件是,那些為了歸檔而創建的目錄也會被刪除。

FixedWindowRollingPolicy:根據固定窗口算法重命名文件的滾動策略。有以下子節點:

:窗口索引最小值

:窗口索引最大值,當用戶指定的窗口過大時,會自動將窗口設置為12。

:

必須包含“%i”例如,假設最小值和最大值分別為1和2,命名模式為 mylog%i.log,會產生歸檔文件mylog1.log和mylog2.log。還可以指定文件壓縮選項,例如,mylog%i.log.gz 或者 沒有log%i.log.zip

triggeringPolicy:

SizeBasedTriggeringPolicy:查看當前活動文件的大小,如果超過指定大小會告知RollingFileAppender觸發當前活動文件滾動。只有一個節點:

:這是活動文件的大小,默認值是10MB。

例如:每天生成一個日志文件,保存30天的日志文件。

Java代碼

logFile.%d{yyyy-MM-dd}.log

30

%-4relative [%thread] %-5level %logger{35} - %msg%n

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

Xml代碼

test.log

tests.%i.log.zip

1

3

5MB

%-4relative [%thread] %-5level %logger{35} - %msg%n

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

負責兩件事,一是把日志信息轉換成字節數組,二是把字節數組寫入到輸出流。

目前PatternLayoutEncoder是唯一有用的且默認的encoder,有一個節點,用來設置日志的輸入格式。使用“%”加“轉換符”方式,如果要輸出“%”,則必須用“\”對“\%”進行轉義。

例如:

Xml代碼

%-4relative [%thread] %-5level %logger{35} - %msg%n

里面的轉換符說明:

轉換符作用

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}輸出執行記錄請求的調用者的全限定名。參數與上面的一樣。盡量避免使用,除非執行速度不造成任何問題。

contextNamecn輸出上下文名稱。

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-loggingstatementCaller+0atmainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)Caller+1atmainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)

例如,%caller{3}輸出為:

16[main]DEBUG-loggingstatementCaller+0atmainPackage.sub.sample.Bar.sampleMethodName(Bar.java:22)Caller+1atmainPackage.sub.sample.Bar.createLoggingRequest(Bar.java:17)Caller+2atmainPackage.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。

***********************************************詳解*****************************************

:

過濾器,執行一個過濾器會有返回個枚舉值,即DENY,NEUTRAL,ACCEPT其中之一。返回DENY,日志將立即被拋棄不再經過其他過濾器;返回NEUTRAL,有序列表里的下個過濾器過接著處理日志;返回ACCEPT,日志會被立即處理,不再經過剩余過濾器。

過濾器被添加到中,為添加一個或多個過濾器后,可以用任意條件對日志進行過濾。有多個過濾器時,按照配置順序執行。

下面是幾個常用的過濾器:

LevelFilter:級別過濾器,根據日志級別進行過濾。如果日志級別等于配置級別,過濾器會根據onMath 和 onMismatch接收或拒絕日志。有以下子節點:

:設置過濾級別

:用于配置符合過濾條件的操作

:用于配置不符合過濾條件的操作

例如:將過濾器的日志級別配置為INFO,所有INFO級別的日志交給appender處理,非INFO級別的日志,被過濾掉。

Xml代碼

INFO

ACCEPT

DENY

%-4relative [%thread] %-5level %logger{30} - %msg%n

ThresholdFilter:臨界值過濾器,過濾掉低于指定臨界值的日志。當日志級別等于或高于臨界值時,過濾器返回NEUTRAL;當日志級別低于臨界值時,日志會被拒絕。

例如:過濾掉所有低于INFO級別的日志。

Xml代碼

class="ch.qos.logback.core.ConsoleAppender">


INFO

%-4relative [%thread] %-5level %logger{30} - %msg%n

EvaluatorFilter:求值過濾器,評估、鑒別日志是否符合指定條件。有一下子節點:

:

鑒別器,常用的鑒別器是JaninoEventEvaluato,也是默認的鑒別器,它以任意的java布爾值表達式作為求值條件,求值條件在配置文件解釋過成功被動態編譯,布爾值表達式返回true就表示符合過濾條件。evaluator有個子標簽,用于配置求值條件。

求值表達式作用于當前日志,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

:用于配置符合過濾條件的操作

:用于配置不符合過濾條件的操作

例如:過濾掉所有日志消息中不包含“billing”字符串的日志。

Xml代碼

return message.contains("billing");

ACCEPT

DENY

%-4relative [%thread] %-5level %logger - %msg%n

匹配器,盡管可以使用String類的matches()方法進行模式匹配,但會導致每次調用過濾器時都會創建一個新的Pattern對象,為了消除這種開銷,可以預定義一個或多個matcher對象,定以后就可以在求值表達式中重復引用。是的子標簽。

中包含兩個子標簽,一個是,用于定義matcher的名字,求值表達式中使用這個名字來引用matcher;另一個是,用于配置匹配條件。

例如:

Xml代碼

odd


statement [13579]

odd.matches(formattedMessage)

NEUTRAL

DENY

%-4relative [%thread] %-5level %logger - %msg%n

其他Filter不太常用了,大家可以參見官網。


原文:http://my.oschina.net/arlin/blog/519731

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。

推薦閱讀更多精彩內容