Log4j配置詳解

來自:?http://www.blogjava.net/zJun/archive/2006/06/28/55511.html

Log4J的配置文件(Configuration File)就是用來設置記錄器的級別、存放器和布局的，它可接key=value格式的設置或xml格式的設置信息。通過配置，可以創建出Log4J的運行環境。

1. 配置文件
Log4J配置文件的基本格式如下：

#配置根Logger

log4j.rootLogger??=???[?level?]???,??appenderName1?,??appenderName2?,??…

#配置日志信息輸出目的地Appender

log4j.appender.appenderName??=??fully.qualified.name.of.appender.class?

　　log4j.appender.appenderName.option1??=??value1?

　　…?

　　log4j.appender.appenderName.optionN??=??valueN?

#配置日志信息的格式（布局）

log4j.appender.appenderName.layout??=??fully.qualified.name.of.layout.class?

　　log4j.appender.appenderName.layout.option1??=??value1?

　　…?

　　log4j.appender.appenderName.layout.optionN??=??valueN?

其中?[level]?是日志輸出級別，共有5級：

FATAL???????0??
ERROR ? ???3??
WARN???????4??
INFO??????? ??6??
DEBUG ? ???7?

Appender?為日志輸出目的地，Log4j提供的appender有以下幾種：

org.apache.log4j.ConsoleAppender（控制臺），

org.apache.log4j.FileAppender（文件），

org.apache.log4j.DailyRollingFileAppender（每天產生一個日志文件），

org.apache.log4j.RollingFileAppender（文件大小到達指定尺寸的時候產生一個新的文件），

org.apache.log4j.WriterAppender（將日志信息以流格式發送到任意指定的地方）

Layout：日志輸出格式，Log4j提供的layout有以下幾種：

org.apache.log4j.HTMLLayout（以HTML表格形式布局），

org.apache.log4j.PatternLayout（可以靈活地指定布局模式），

org.apache.log4j.SimpleLayout（包含日志信息的級別和信息字符串），

org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等等信息）

打印參數:?Log4J采用類似C語言中的printf函數的打印格式格式化日志信息，如下:

?　??%m?? 輸出代碼中指定的消息

　　%p?? 輸出優先級，即DEBUG，INFO，WARN，ERROR，FATAL?

　　%r?? 輸出自應用啟動到輸出該log信息耗費的毫秒數?

　　%c?? 輸出所屬的類目，通常就是所在類的全名?

　　%t?? 輸出產生該日志事件的線程名?

　　%n?? 輸出一個回車換行符，Windows平臺為“/r/n”，Unix平臺為“/n”?

　　%d?? 輸出日志時間點的日期或時間，默認格式為ISO8601，也可以在其后指定格式，比如：%d{yyy?MMM?dd?HH:mm:ss?,SSS}，輸出類似：2002年10月18日??22?：?10?：?28?，?921??

　　%l?? 輸出日志事件的發生位置，包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main(TestLog4.java:?10?)?

2. 在代碼中初始化Logger:?
1）在程序中調用BasicConfigurator.configure()方法：給根記錄器增加一個ConsoleAppender，輸出格式通過PatternLayout設為"%-4r [%t] %-5p %c %x - %m%n"，還有根記錄器的默認級別是Level.DEBUG.?
2）配置放在文件里，通過命令行參數傳遞文件名字，通過PropertyConfigurator.configure(args[x])解析并配置；
3）配置放在文件里，通過環境變量傳遞文件名等信息，利用log4j默認的初始化過程解析并配置；
4）配置放在文件里，通過應用服務器配置傳遞文件名等信息，利用一個特殊的servlet來完成配置。

3. 為不同的 Appender 設置日志輸出級別：
當調試系統時，我們往往注意的只是異常級別的日志輸出，但是通常所有級別的輸出都是放在一個文件里的，如果日志輸出的級別是BUG！？那就慢慢去找吧。
這時我們也許會想要是能把異常信息單獨輸出到一個文件里該多好啊。當然可以，Log4j已經提供了這樣的功能，我們只需要在配置中修改Appender的Threshold?就能實現,比如下面的例子：

[配置文件]

?###?set?log?levels?###

log4j.rootLogger?=?debug?,??stdout?,??D?,??E

###?輸出到控制臺?###

log4j.appender.stdout?=?org.apache.log4j.ConsoleAppender

log4j.appender.stdout.Target?=?System.out

log4j.appender.stdout.layout?=?org.apache.log4j.PatternLayout

log4j.appender.stdout.layout.ConversionPattern?=??%d{ABSOLUTE}?%5p?%c{?1?}:%L?-?%m%n

###?輸出到日志文件?###

log4j.appender.D?=?org.apache.log4j.DailyRollingFileAppender

log4j.appender.D.File?=?logs/log.log

log4j.appender.D.Append?=?true

log4j.appender.D.Threshold?=?DEBUG?##?輸出DEBUG級別以上的日志

log4j.appender.D.layout?=?org.apache.log4j.PatternLayout

log4j.appender.D.layout.ConversionPattern?=?%-d{yyyy-MM-dd?HH:mm:ss}??[?%t:%r?]?-?[?%p?]??%m%n

###?保存異常信息到單獨文件?###

log4j.appender.D?=?org.apache.log4j.DailyRollingFileAppender

log4j.appender.D.File?=?logs/error.log?##?異常日志文件名

log4j.appender.D.Append?=?true

log4j.appender.D.Threshold?=?ERROR?##?只輸出ERROR級別以上的日志!!!

log4j.appender.D.layout?=?org.apache.log4j.PatternLayout

log4j.appender.D.layout.ConversionPattern?=?%-d{yyyy-MM-dd?HH:mm:ss}??[?%t:%r?]?-?[?%p?]??%m%n

[代碼中使用]?

?public???class??TestLog4j??{

?????public???static???void??main(String[]?args)??{

????????PropertyConfigurator.configure(?"?D:/Code/conf/log4j.properties?"?);

????????Logger?logger??=??Logger.getLogger(TestLog4j.?class?);

????????logger.debug(?"?debug?"?);

????????logger.error(?"?error?"?);

????}?

}

運行一下，看看異常信息是不是保存在了一個單獨的文件error.log中

log4j.properties 使用
一.參數意義說明
輸出級別的種類
ERROR、WARN、INFO、DEBUG
ERROR 為嚴重錯誤主要是程序的錯誤
WARN 為一般警告，比如session丟失
INFO 為一般要顯示的信息，比如登錄登出
DEBUG 為程序的調試信息
配置日志信息輸出目的地
log4j.appender.appenderName = fully.qualified.name.of.appender.class
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（將日志信息以流格式發送到任意指定的地方）
配置日志信息的格式
log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
1.org.apache.log4j.HTMLLayout（以HTML表格形式布局），
2.org.apache.log4j.PatternLayout（可以靈活地指定布局模式），
3.org.apache.log4j.SimpleLayout（包含日志信息的級別和信息字符串），
4.org.apache.log4j.TTCCLayout（包含日志產生的時間、線程、類別等等信息）
控制臺選項
Threshold=DEBUG:指定日志消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂著所有的消息都會被立即輸出。
Target=System.err：默認情況下是：System.out,指定輸出控制臺
FileAppender 選項
Threshold=DEBUF:指定日志消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂著所有的消息都會被立即輸出。
File=mylog.txt:指定消息輸出到mylog.txt文件。
Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定的文件內容。
RollingFileAppender 選項
Threshold=DEBUG:指定日志消息的輸出最低層次。
ImmediateFlush=true:默認值是true,意謂著所有的消息都會被立即輸出。
File=mylog.txt:指定消息輸出到mylog.txt文件。
Append=false:默認值是true,即將消息增加到指定文件中，false指將消息覆蓋指定的文件內容。
MaxFileSize=100KB: 后綴可以是KB, MB 或者是 GB. 在日志文件到達該大小時，將會自動滾動，即將原來的內容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以產生的滾動文件的最大數。
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
日志信息格式中幾個符號所代表的含義：
?-X號: X信息輸出時左對齊；
?%p: 輸出日志信息優先級，即DEBUG，INFO，WARN，ERROR，FATAL,
?%d: 輸出日志時間點的日期或時間，默認格式為ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，輸出類似：2002年10月18日 22：10：28，921
?%r: 輸出自應用啟動到輸出該log信息耗費的毫秒數
?%c: 輸出日志信息所屬的類目，通常就是所在類的全名
?%t: 輸出產生該日志事件的線程名
?%l: 輸出日志事件的發生位置，相當于%C.%M(%F:%L)的組合,包括類目名、發生的線程，以及在代碼中的行數。舉例：Testlog4.main (TestLog4.java:10)
?%x: 輸出和當前線程相關聯的NDC(嵌套診斷環境),尤其用到像java servlets這樣的多客戶多線程的應用中。
?%%: 輸出一個"%"字符
?%F: 輸出日志消息產生時所在的文件名稱
?%L: 輸出代碼中的行號
?%m: 輸出代碼中指定的消息,產生的日志具體信息
?%n: 輸出一個回車換行符，Windows平臺為"/r/n"，Unix平臺為"/n"輸出日志信息換行
?可以在%與模式字符之間加上修飾符來控制其最小寬度、最大寬度、和文本的對齊方式。如：
?1)%20c：指定輸出category的名稱，最小的寬度是20，如果category的名稱小于20的話，默認的情況下右對齊。
?2)%-20c:指定輸出category的名稱，最小的寬度是20，如果category的名稱小于20的話，"-"號指定左對齊。
?3)%.30c:指定輸出category的名稱，最大的寬度是30，如果category的名稱大于30的話，就會將左邊多出的字符截掉，但小于30的話也不會有空格。
?4)%20.30c:如果category的名稱小于20就補空格，并且右對齊，如果其名稱長于30字符，就從左邊較遠輸出的字符截掉。
二.文件配置Sample1
log4j.rootLogger=DEBUG,A1,R
#log4j.rootLogger=INFO,A1,R
# ConsoleAppender 輸出
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n
# File 輸出一天一個文件,輸出路徑可以定制,一般在根路徑下
log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
log4j.appender.R.File=blog_log.txt
log4j.appender.R.MaxFileSize=500KB
log4j.appender.R.MaxBackupIndex=10
log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss,SSS} [%t] [%c] [%p] - %m%n
文件配置Sample2
下面給出的Log4J配置文件實現了輸出到控制臺，文件，回滾文件，發送日志郵件，輸出到數據庫日志表，自定義標簽等全套功能。
log4j.rootLogger=DEBUG,CONSOLE,A1,im?
#DEBUG,CONSOLE,FILE,ROLLING_FILE,MAIL,DATABASE
log4j.addivity.org.apache=true
###################?
# Console Appender?
###################?
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender?
log4j.appender.Threshold=DEBUG?
log4j.appender.CONSOLE.Target=System.out?
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout?
log4j.appender.CONSOLE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n?
#log4j.appender.CONSOLE.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD] n%c[CATEGORY]%n%m[MESSAGE]%n%n
#####################?
# File Appender?
#####################?
log4j.appender.FILE=org.apache.log4j.FileAppender?
log4j.appender.FILE.File=file.log?
log4j.appender.FILE.Append=false?
log4j.appender.FILE.layout=org.apache.log4j.PatternLayout?
log4j.appender.FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n?
# Use this layout for LogFactor 5 analysis
########################?
# Rolling File?
########################?
log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender?
log4j.appender.ROLLING_FILE.Threshold=ERROR?
log4j.appender.ROLLING_FILE.File=rolling.log?
log4j.appender.ROLLING_FILE.Append=true?
log4j.appender.ROLLING_FILE.MaxFileSize=10KB?
log4j.appender.ROLLING_FILE.MaxBackupIndex=1?
log4j.appender.ROLLING_FILE.layout=org.apache.log4j.PatternLayout?
log4j.appender.ROLLING_FILE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
####################?
# Socket Appender?
####################?
log4j.appender.SOCKET=org.apache.log4j.RollingFileAppender?
log4j.appender.SOCKET.RemoteHost=localhost?
log4j.appender.SOCKET.Port=5001?
log4j.appender.SOCKET.LocationInfo=true?
# Set up for Log Facter 5?
log4j.appender.SOCKET.layout=org.apache.log4j.PatternLayout?
log4j.appender.SOCET.layout.ConversionPattern=[start]%d{DATE}[DATE]%n%p[PRIORITY]%n%x[NDC]%n%t[THREAD]%n%c[CATEGORY]%n%m[MESSAGE]%n%n
########################?
# Log Factor 5 Appender?
########################?
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender?
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
########################?
# SMTP Appender?
#######################?
log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender?
log4j.appender.MAIL.Threshold=FATAL?
log4j.appender.MAIL.BufferSize=10?
log4j.appender.MAIL.From=chenyl@yeqiangwei.com
log4j.appender.MAIL.SMTPHost=mail.hollycrm.com?
log4j.appender.MAIL.Subject=Log4J Message?
log4j.appender.MAIL.To=chenyl@yeqiangwei.com
log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout?
log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
########################?
# JDBC Appender?
#######################?
log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender?
log4j.appender.DATABASE.URL=jdbc:mysql://localhost:3306/test?
log4j.appender.DATABASE.driver=com.mysql.jdbc.Driver?
log4j.appender.DATABASE.user=root?
log4j.appender.DATABASE.password=?
log4j.appender.DATABASE.sql=INSERT INTO LOG4J (Message) VALUES ('[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n')?
log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout?
log4j.appender.DATABASE.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
log4j.appender.A1=org.apache.log4j.DailyRollingFileAppender?
log4j.appender.A1.File=SampleMessages.log4j?
log4j.appender.A1.DatePattern=yyyyMMdd-HH'.log4j'?
log4j.appender.A1.layout=org.apache.log4j.xml.XMLLayout
###################?
#自定義Appender?
###################?
log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender
log4j.appender.im.host = mail.cybercorlin.net?
log4j.appender.im.username = username?
log4j.appender.im.password = password?
log4j.appender.im.recipient =?corlin@yeqiangwei.com
log4j.appender.im.layout=org.apache.log4j.PatternLayout?
log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
三.高級使用
實驗目的：
?1.把FATAL級錯誤寫入2000NT日志
?2. WARN，ERROR，FATAL級錯誤發送email通知管理員
?3.其他級別的錯誤直接在后臺輸出
實驗步驟：
?輸出到2000NT日志
?1.把Log4j壓縮包里的NTEventLogAppender.dll拷到WINNT/SYSTEM32目錄下
?2.寫配置文件log4j.properties
# 在2000系統日志輸出
?log4j.logger.NTlog=FATAL, A8
?# APPENDER A8
?log4j.appender.A8=org.apache.log4j.nt.NTEventLogAppender
?log4j.appender.A8.Source=JavaTest
?log4j.appender.A8.layout=org.apache.log4j.PatternLayout
?log4j.appender.A8.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
3.調用代碼：
?Logger logger2 = Logger.getLogger("NTlog"); //要和配置文件中設置的名字相同
?logger2.debug("debug!!!");
?logger2.info("info!!!");
?logger2.warn("warn!!!");
?logger2.error("error!!!");
?//只有這個錯誤才會寫入2000日志
?logger2.fatal("fatal!!!");
發送email通知管理員：
?1. 首先下載JavaMail和JAF,?
??http://java.sun.com/j2ee/ja/javamail/index.html
??http://java.sun.com/beans/glasgow/jaf.html
?在項目中引用mail.jar和activation.jar。
?2. 寫配置文件
?# 將日志發送到email
?log4j.logger.MailLog=WARN,A5
?#? APPENDER A5
?log4j.appender.A5=org.apache.log4j.net.SMTPAppender
?log4j.appender.A5.BufferSize=5
?log4j.appender.A5.To=chunjie@yeqiangwei.com
?log4j.appender.A5.From=error@yeqiangwei.com
?log4j.appender.A5.Subject=ErrorLog
?log4j.appender.A5.SMTPHost=smtp.263.net
?log4j.appender.A5.layout=org.apache.log4j.PatternLayout
?log4j.appender.A5.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
?3.調用代碼：
?//把日志發送到mail
?Logger logger3 = Logger.getLogger("MailLog");
?logger3.warn("warn!!!");
?logger3.error("error!!!");
?logger3.fatal("fatal!!!");
在后臺輸出所有類別的錯誤：
?1. 寫配置文件
?# 在后臺輸出
?log4j.logger.console=DEBUG, A1
?# APPENDER A1
?log4j.appender.A1=org.apache.log4j.ConsoleAppender
?log4j.appender.A1.layout=org.apache.log4j.PatternLayout
?log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
?2．調用代碼
?Logger logger1 = Logger.getLogger("console");
?logger1.debug("debug!!!");
?logger1.info("info!!!");
?logger1.warn("warn!!!");
?logger1.error("error!!!");
?logger1.fatal("fatal!!!");
--------------------------------------------------------------------
?全部配置文件：log4j.properties
?# 在后臺輸出
?log4j.logger.console=DEBUG, A1
?# APPENDER A1
?log4j.appender.A1=org.apache.log4j.ConsoleAppender
?log4j.appender.A1.layout=org.apache.log4j.PatternLayout
?log4j.appender.A1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
# 在2000系統日志輸出
?log4j.logger.NTlog=FATAL, A8
?# APPENDER A8
?log4j.appender.A8=org.apache.log4j.nt.NTEventLogAppender
?log4j.appender.A8.Source=JavaTest
?log4j.appender.A8.layout=org.apache.log4j.PatternLayout
?log4j.appender.A8.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
# 將日志發送到email
?log4j.logger.MailLog=WARN,A5
?#? APPENDER A5
?log4j.appender.A5=org.apache.log4j.net.SMTPAppender
?log4j.appender.A5.BufferSize=5
?log4j.appender.A5.To=chunjie@yeqiangwei.com
?log4j.appender.A5.From=error@yeqiangwei.com
?log4j.appender.A5.Subject=ErrorLog
?log4j.appender.A5.SMTPHost=smtp.263.net
?log4j.appender.A5.layout=org.apache.log4j.PatternLayout
?log4j.appender.A5.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
全部代碼：Log4jTest.java

[java]?view plain?copy

1. ?import?org.apache.log4j.*;???
2. ?//import?org.apache.log4j.nt.*;???
3. ?//import?org.apache.log4j.net.*;???
4. ?/**??
5. ??*?@author?yanxu??
6. ??*/???
7. ?public?class?Log4jTest???
8. ?{???
9. ??public?static?void?main(String?args[])???
10. ??{???
11. ???PropertyConfigurator.configure("log4j.properties");???
12. ???//在后臺輸出???
13. ???Logger?logger1?=?Logger.getLogger("console");???
14. ???logger1.debug("debug!!!");???
15. ???logger1.info("info!!!");???
16. ???logger1.warn("warn!!!");???
17. ???logger1.error("error!!!");???
18. ???logger1.fatal("fatal!!!");??
19. //在NT系統日志輸出???
20. ???Logger?logger2?=?Logger.getLogger("NTlog");???
21. ???//NTEventLogAppender?nla?=?new?NTEventLogAppender();???
22. ???logger2.debug("debug!!!");???
23. ???logger2.info("info!!!");???
24. ???logger2.warn("warn!!!");???
25. ???logger2.error("error!!!");???
26. ???//只有這個錯誤才會寫入2000日志???
27. ???logger2.fatal("fatal!!!");??
28. //把日志發送到mail???
29. ???Logger?logger3?=?Logger.getLogger("MailLog");???
30. ???//SMTPAppender?sa?=?new?SMTPAppender();???
31. ???logger3.warn("warn!!!");???
32. ???logger3.error("error!!!");???
33. ???logger3.fatal("fatal!!!");???
34. ??}???
35. ?} ?