logback.xml解釋(轉載)
logback 配置詳解(一)<configuration> and <logger>
一:根節點<configuration>包含的屬性:
scan:
當此屬性設定為true時,配置檔案如果發生改變,將會被重新載入,預設值為true。
scanPeriod:
設定監測配置檔案是否有修改的時間間隔,如果沒有給出時間單位,預設單位是毫秒。當scan為true時,此屬性生效。預設的時間間隔為1分鐘。
debug:
當此屬性設定為true時,將打印出logback內部日誌資訊,實時檢視logback執行狀態。預設值為false。
例如:
Xml程式碼- <configuration scan="true" scanPeriod="60 seconds" debug="false">
- <!-- 其他配置省略-->
- </configuration>
二:根節點<configuration>的子節點:
2.1設定上下文名稱:<contextName>
每個logger都關聯到logger上下文,預設上下文名稱為“default”。但可以使用<contextName>設定成其他名字,用於區分不同應用程式的記錄。一旦設定,不能修改。
Xml程式碼- <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上下文時使用。
Xml程式碼- <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的格式。
例如將解析配置檔案的時間作為上下文名稱:
Xml程式碼- <configuration scan="true" scanPeriod="60 seconds" debug="false">
- <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>
- <contextName>${bySecond}</contextName>
- <!-- 其他配置省略-->
- </configuration>
2.4設定loger:
<loger>
用來設定某一個包或者具體的某一個類的日誌列印級別、以及指定<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。
<root>
也是<loger>元素,但是它是根loger。只有一個level屬性,應為已經被命名為"root".
level:
用來設定列印級別,大小寫無關:TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF,不能設定為INHERITED或者同義詞NULL。
預設是DEBUG。
<root>可以包含零個或多個<appender-ref>元素,標識這個appender將會新增到這個loger。
例如:
LogbackDemo.java類
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
Xml程式碼- <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的配置表示列印到控制檯(稍後詳細講解appender );
<root level="INFO">將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程式碼- <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將資訊列印到控制檯;
列印結果如下:
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程式碼- <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的配置表示列印到控制檯(稍後詳細講解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="ERROR">將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傳遞任何列印資訊;
列印結果如下:
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 name="logback.LogbackDemo" level="INFO" additivity="false">修改為 <logger name="logback.LogbackDemo" level="INFO" additivity="true">那列印結果將是什麼呢?
沒錯,日誌列印了兩次,想必大家都知道原因了,因為列印資訊向上級傳遞,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
logback 常用配置詳解(二) <appender>
<appender>:
<appender>是<configuration>的子節點,是負責寫日誌的元件。
<appender>有兩個必要屬性name和class。name指定appender名稱,class指定appender的全限定名。
1.ConsoleAppender:
把日誌新增到控制檯,有以下子節點:
<encoder>:對日誌進行格式化。(具體引數稍後講解 )
<target>:字串 System.out 或者 System.err ,預設 System.out ;
例如:
Xml程式碼- <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>
2.FileAppender:
把日誌新增到檔案,有以下子節點:
<file>:被寫入的檔名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動建立,沒有預設值。
<append>:如果是 true,日誌被追加到檔案結尾,如果是 false,清空現存檔案,預設是true。
<encoder>:對記錄事件進行格式化。(具體引數稍後講解 )
<prudent>:如果是 true,日誌會被安全的寫入檔案,即使其他的FileAppender也在向此檔案做寫入操作,效率低,預設是 false。
例如:
Xml程式碼- <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>
3.RollingFileAppender:
滾動記錄檔案,先將日誌記錄到指定檔案,當符合某個條件時,將日誌記錄到其他檔案。有以下子節點:
<file>:被寫入的檔名,可以是相對目錄,也可以是絕對目錄,如果上級目錄不存在會自動建立,沒有預設值。
<append>:如果是 true,日誌被追加到檔案結尾,如果是 false,清空現存檔案,預設是true。
<encoder>:對記錄事件進行格式化。(具體引數稍後講解 )
<rollingPolicy>:當發生滾動時,決定 RollingFileAppender 的行為,涉及檔案移動和重新命名。
<triggeringPolicy >: 告知 RollingFileAppender 合適啟用滾動。
<prudent>:當為true時,不支援FixedWindowRollingPolicy。支援TimeBasedRollingPolicy,但是有兩個限制,1不支援也不允許檔案壓縮,2不能設定file屬性,必須留空。
rollingPolicy:
TimeBasedRollingPolicy: 最常用的滾動策略,它根據時間來制定滾動策略,既負責滾動也負責出發滾動。有以下子節點:
<fileNamePattern>:
必要節點,包含檔名及“%d”轉換符, “%d”可以包含一個java.text.SimpleDateFormat指定的時間格式,如:%d{yyyy-MM}。如果直接使用 %d,預設格式是 yyyy-MM-dd。
RollingFileAppender 的file位元組點可有可無,通過設定file,可以為活動檔案和歸檔檔案指定不同位置,當前日誌總是記錄到file指定的檔案(活動檔案),活動檔案的名字不會改變;如果沒設定file,活動檔案的名字會根據fileNamePattern 的值,每隔一段時間改變一次。“/”或者“\”會被當做目錄分隔符。
<maxHistory>:
可選節點,控制保留的歸檔檔案的最大數量,超出數量就刪除舊檔案。假設設定每個月滾動,且<maxHistory>是6,則只儲存最近6個月的檔案,刪除之前的舊檔案。注意,刪除舊檔案是,那些為了歸檔而建立的目錄也會被刪除。
FixedWindowRollingPolicy: 根據固定視窗演算法重新命名檔案的滾動策略。有以下子節點:
<minIndex>:視窗索引最小值
<maxIndex>:視窗索引最大值,當用戶指定的視窗過大時,會自動將視窗設定為12。
<fileNamePattern >:
必須包含“%i”例如,假設最小值和最大值分別為1和2,命名模式為 mylog%i.log,會產生歸檔檔案mylog1.log和mylog2.log。還可以指定檔案壓縮選項,例如,mylog%i.log.gz 或者 沒有log%i.log.zip
triggeringPolicy:
SizeBasedTriggeringPolicy: 檢視當前活動檔案的大小,如果超過指定大小會告知 RollingFileAppender 觸發當前活動檔案滾動。只有一個節點:
<maxFileSize>:這是活動檔案的大小,預設值是10MB。
例如:每天生成一個日誌檔案,儲存30天的日誌檔案。
Java程式碼- <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>
例如:按照固定視窗模式生成日誌檔案,當檔案大於20MB時,生成新的日誌檔案。視窗大小是1到3,當儲存了3個歸檔檔案後,將覆蓋最早的日誌。
Xml程式碼- <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>
4.另外還有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender,並不常用,這些就不在這裡講解了,大家可以參考官方文件。當然大家可以編寫自己的Appender。
<encoder>:
負責兩件事,一是把日誌資訊轉換成位元組陣列,二是把位元組陣列寫入到輸出流。
目前PatternLayoutEncoder 是唯一有用的且預設的encoder ,有一個<pattern>節點,用來設定日誌的輸入格式。使用“%”加“轉換符”方式,如果要輸出“%”,則必須用“\”對“\%”進行轉義。
例如:
Xml程式碼- <encoder>
- <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>
- </encoder
<pattern>裡面的轉換符說明:
轉換符 作用
c {length } lo {length } logger {length } |
輸出日誌的logger名,可有一個整形引數,功能是縮短logger名,設定為0表示只輸入logger最右邊點符號之後的字串。 Conversion specifier Logger name Result
|
|||||||||||||||||||||
C {length } class {length } |
輸出執行記錄請求的呼叫者的全限定名。引數與上面的一樣。儘量避免使用,除非執行速度不造成任何問題。 | |||||||||||||||||||||
contextName cn |
輸出上下文名稱。 | |||||||||||||||||||||
d {pattern } date {pattern } |
輸出日誌的列印日誌,模式語法與java.text.SimpleDateFormat 相容。 Conversion Pattern Result
|
|||||||||||||||||||||
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。