log4j日誌配置詳解

一、Log4j簡介

Log4j有三個主要的元件：Loggers(記錄器)，Appenders (輸出源)和Layouts(佈局)。這裡可簡單理解為日誌類別，日誌要輸出的地方和日誌以何種形式輸出。綜合使用這三個元件可以輕鬆地記錄資訊的型別和級別，並可以在執行時控制日誌輸出的樣式和位置。

1、Loggers

Loggers元件在此係統中被分為五個級別：DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的，DEBUG < INFO < WARN < ERROR < FATAL，分別用來指定這條日誌資訊的重要程度，明白這一點很重要，Log4j有一個規則：只輸出級別不低於設定級別的日誌資訊，假設Loggers級別設定為INFO，則INFO、WARN、ERROR和FATAL級別的日誌資訊都會輸出，而級別比INFO低的DEBUG則不會輸出。

2、Appenders

禁用和使用日誌請求只是Log4j的基本功能，Log4j日誌系統還提供許多強大的功能，比如允許把日誌輸出到不同的地方，如控制檯（Console）、檔案（Files）等，可以根據天數或者檔案大小產生新的檔案，可以以流的形式傳送到其它地方等等。

常使用的類如下：

org.apache.log4j.ConsoleAppender（控制檯）
org.apache.log4j.FileAppender（檔案）
org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌檔案）
org.apache.log4j.RollingFileAppender（檔案大小到達指定尺寸的時候產生一個新的檔案）
org.apache.log4j.WriterAppender（將日誌資訊以流格式傳送到任意指定的地方）

配置模式：
log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
…
log4j.appender.appenderName.OptionN = valueN

3、Layouts

有時使用者希望根據自己的喜好格式化自己的日誌輸出，Log4j可以在Appenders的後面附加Layouts來完成這個功能。Layouts提供四種日誌輸出樣式，如根據HTML樣式、自由指定樣式、包含日誌級別與資訊的樣式和包含日誌時間、執行緒、類別等資訊的樣式。

常使用的類如下：

org.apache.log4j.HTMLLayout（以HTML表格形式佈局）
org.apache.log4j.PatternLayout（可以靈活地指定佈局模式）
org.apache.log4j.SimpleLayout（包含日誌資訊的級別和資訊字串）
org.apache.log4j.TTCCLayout（包含日誌產生的時間、執行緒、類別等資訊）

配置模式：

log4j.appender.appenderName.layout =className
log4j.appender.appenderName.layout.Option1 = value1
…
log4j.appender.appenderName.layout.OptionN = valueN

 

二、配置詳解

在實際應用中，要使Log4j在系統中執行須事先設定配置檔案。配置檔案事實上也就是對Logger、Appender及Layout進行相應設定。Log4j支援兩種配置檔案格式，一種是XML格式的檔案，一種是properties屬性檔案。下面以properties屬性檔案為例介紹log4j.properties的配置。

1、配置根Logger：
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
log4j.additivity.org.apache=false：表示Logger不會在父Logger的appender裡輸出，預設為true。
level ：設定日誌記錄的最低階別，可設的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定義的級別，Log4j建議只使用中間四個級別。通過在這裡設定級別，您可以控制應用程式中相應級別的日誌資訊的開關，比如在這裡設定了INFO級別，則應用程式中所有DEBUG級別的日誌資訊將不會被列印出來。
appenderName：就是指定日誌資訊要輸出到哪裡。可以同時指定多個輸出目的地，用逗號隔開。
例如：log4j.rootLogger＝INFO,A1,B2,C3

2、配置日誌資訊輸出目的地（appender）：
log4j.appender.appenderName = className
appenderName：自定義appderName，在log4j.rootLogger設定中使用；
className：可設值如下：
(1)org.apache.log4j.ConsoleAppender（控制檯）
(2)org.apache.log4j.FileAppender（檔案）
(3)org.apache.log4j.DailyRollingFileAppender（每天產生一個日誌檔案）
(4)org.apache.log4j.RollingFileAppender（檔案大小到達指定尺寸的時候產生一個新的檔案）
(5)org.apache.log4j.WriterAppender（將日誌資訊以流格式傳送到任意指定的地方）
(1)ConsoleAppender選項：
Threshold=WARN：指定日誌資訊的最低輸出級別，預設為DEBUG。
ImmediateFlush=true：表示所有訊息都會被立即輸出，設為false則不輸出，預設值是true。
Target=System.err：預設值是System.out。
(2)FileAppender選項：
Threshold=WARN：指定日誌資訊的最低輸出級別，預設為DEBUG。
ImmediateFlush=true：表示所有訊息都會被立即輸出，設為false則不輸出，預設值是true。
Append=false：true表示訊息增加到指定檔案中，false則將訊息覆蓋指定的檔案內容，預設值是true。
File=D:/logs/logging.log4j：指定訊息輸出到logging.log4j檔案中。
(3)DailyRollingFileAppender選項：
Threshold=WARN：指定日誌資訊的最低輸出級別，預設為DEBUG。
ImmediateFlush=true：表示所有訊息都會被立即輸出，設為false則不輸出，預設值是true。
Append=false：true表示訊息增加到指定檔案中，false則將訊息覆蓋指定的檔案內容，預設值是true。
File=D:/logs/logging.log4j：指定當前訊息輸出到logging.log4j檔案中。
DatePattern='.'yyyy-MM：每月滾動一次日誌檔案，即每月產生一個新的日誌檔案。當前月的日誌檔名為logging.log4j，前一個月的日誌檔名為logging.log4j.yyyy-MM。
另外，也可以指定按周、天、時、分等來滾動日誌檔案，對應的格式如下：
1)'.'yyyy-MM：每月
2)'.'yyyy-ww：每週
3)'.'yyyy-MM-dd：每天
4)'.'yyyy-MM-dd-a：每天兩次
5)'.'yyyy-MM-dd-HH：每小時
6)'.'yyyy-MM-dd-HH-mm：每分鐘
(4)RollingFileAppender選項：
Threshold=WARN：指定日誌資訊的最低輸出級別，預設為DEBUG。
ImmediateFlush=true：表示所有訊息都會被立即輸出，設為false則不輸出，預設值是true。
Append=false：true表示訊息增加到指定檔案中，false則將訊息覆蓋指定的檔案內容，預設值是true。
File=D:/logs/logging.log4j：指定訊息輸出到logging.log4j檔案中。
MaxFileSize=100KB：字尾可以是KB, MB 或者GB。在日誌檔案到達該大小時，將會自動滾動，即將原來的內容移到logging.log4j.1檔案中。
MaxBackupIndex=2：指定可以產生的滾動檔案的最大數，例如，設為2則可以產生logging.log4j.1，logging.log4j.2兩個滾動檔案和一個logging.log4j檔案。

3、配置日誌資訊的輸出格式（Layout）：
log4j.appender.appenderName.layout=className
className：可設值如下：
(1)org.apache.log4j.HTMLLayout（以HTML表格形式佈局）
(2)org.apache.log4j.PatternLayout（可以靈活地指定佈局模式）
(3)org.apache.log4j.SimpleLayout（包含日誌資訊的級別和資訊字串）
(4)org.apache.log4j.TTCCLayout（包含日誌產生的時間、執行緒、類別等等資訊）
(1)HTMLLayout選項：
LocationInfo=true：輸出java檔名稱和行號，預設值是false。
Title=My Logging： 預設值是Log4J Log Messages。
(2)PatternLayout選項：
ConversionPattern=%m%n：設定以怎樣的格式顯示訊息。

格式化符號說明：

%p：輸出日誌資訊的優先順序，即DEBUG，INFO，WARN，ERROR，FATAL。
%d：輸出日誌時間點的日期或時間，預設格式為ISO8601，也可以在其後指定格式，如：%d{yyyy/MM/dd HH:mm:ss,SSS}。
%r：輸出自應用程式啟動到輸出該log資訊耗費的毫秒數。
%t：輸出產生該日誌事件的執行緒名。
%l：輸出日誌事件的發生位置，相當於%c.%M(%F:%L)的組合，包括類全名、方法、檔名以及在程式碼中的行數。例如：test.TestLog4j.main(TestLog4j.java:10)。
%c：輸出日誌資訊所屬的類目，通常就是所在類的全名。
%M：輸出產生日誌資訊的方法名。
%F：輸出日誌訊息產生時所在的檔名稱。
%L:：輸出程式碼中的行號。
%m:：輸出程式碼中指定的具體日誌資訊。
%n：輸出一個回車換行符，Windows平臺為"rn"，Unix平臺為"n"。
%x：輸出和當前執行緒相關聯的NDC(巢狀診斷環境)，尤其用到像java servlets這樣的多客戶多執行緒的應用中。
%%：輸出一個"%"字元。
另外，還可以在%與格式字元之間加上修飾符來控制其最小長度、最大長度、和文字的對齊方式。如：
1) c：指定輸出category的名稱，最小的長度是20，如果category的名稱長度小於20的話，預設的情況下右對齊。
2)%-20c："-"號表示左對齊。
3)%.30c：指定輸出category的名稱，最大的長度是30，如果category的名稱長度大於30的話，就會將左邊多出的字元截掉，但小於30的話也不會補空格。