Log4j日志管理系統(tǒng)簡(jiǎn)單使用說(shuō)明
??? 通常,我們都提供一個(gè)名為 log4j.properties的文件,在第一次調(diào)用到Log4J時(shí),Log4J會(huì)在類(lèi)路徑(../web-inf/class/當(dāng)然也可以放到其它任何目錄,只要該目錄被包含到類(lèi)路徑中即可)中定位這個(gè)文件,并讀入這個(gè)文件完成的配置。這個(gè)配置文件告訴Log4J以什么樣的格式、把什么樣的信息、輸出到什么地方。
Log4j有三個(gè)主要的組件:Loggers(記錄器),Appenders (輸出源)和Layouts(布局),這里可簡(jiǎn)單理解為日志類(lèi)別,日志要輸出的地方和日志以何種形式輸出。綜合使用這三個(gè)組件可以輕松的記錄信息的類(lèi)型和級(jí)別,并可以在運(yùn)行時(shí)控制日志輸出的樣式和位置。下面對(duì)三個(gè)組件分別進(jìn)行說(shuō)明:
1、 Loggers
Loggers組件在此系統(tǒng)中被分為五個(gè)級(jí)別:DEBUG、INFO、WARN、ERROR和FATAL。這五個(gè)級(jí)別是有順序的,DEBUG < INFO < WARN < ERROR < FATAL,分別用來(lái)指定這條日志信息的重要程度,明白這一點(diǎn)很重要,這里L(fēng)og4j有一個(gè)規(guī)則:假設(shè)Loggers級(jí)別為P,如果在Loggers中發(fā)生了一個(gè)級(jí)別Q比P高,則可以啟動(dòng),否則屏蔽掉。
假設(shè)你定義的級(jí)別是info,那么error和warn的日志可以顯示而比他低的debug信息就不顯示了。
?
Java程序舉例來(lái)說(shuō):
//建立Logger的一個(gè)實(shí)例,命名為“com.foo”
Logger logger = Logger.getLogger("com.foo"); //"com.foo"是實(shí)例進(jìn)行命名,也可以任意
//設(shè)置logger的級(jí)別。通常不在程序中設(shè)置logger的級(jí)別。一般在配置文件中設(shè)置。
logger.setLevel(Level.INFO);
Logger barlogger = Logger.getLogger("com.foo.Bar");
//下面這個(gè)請(qǐng)求可用,因?yàn)閃ARN >= INFO
logger.warn("Low fuel level.");
//下面這個(gè)請(qǐng)求不可用,因?yàn)镈EBUG < INFO
logger.debug("Starting search for nearest gas station.");
//命名為“com.foo.bar”的實(shí)例barlogger會(huì)繼承實(shí)例“com.foo”的級(jí)別。因此,下面這個(gè)請(qǐng)求可用,因?yàn)镮NFO >= INFO
barlogger.info("Located nearest gas station.");
//下面這個(gè)請(qǐng)求不可用,因?yàn)镈EBUG < INFO
barlogger.debug("Exiting gas station search");
這里“是否可用”的意思是能否輸出Logger信息。
在對(duì)Logger實(shí)例進(jìn)行命名時(shí),沒(méi)有限制,可以取任意自己感興趣的名字。一般情況下建議以類(lèi)的所在位置來(lái)命名Logger實(shí)例,這是目前來(lái)講比較有效的Logger命名方式。這樣可以使得每個(gè)類(lèi)建立自己的日志信息,便于管理。比如:
static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());
2、Appenders
禁用與使用日志請(qǐng)求只是Log4j其中的一個(gè)小小的地方,Log4j日志系統(tǒng)允許把日志輸出到不同的地方,如控制臺(tái)(Console)、文件(Files)、根據(jù)天數(shù)或者文件大小產(chǎn)生新的文件、以流的形式發(fā)送到其它地方等等。
其語(yǔ)法表示為:
org.apache.log4j.ConsoleAppender(控制臺(tái))
org.apache.log4j.FileAppender(文件)
org.apache.log4j.DailyRollingFileAppender(每天產(chǎn)生一個(gè)日志文件)
??? org.apache.log4j.RollingFileAppender(文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件)
org.apache.log4j.WriterAppender(將日志信息以流格式發(fā)送到任意指定的地方)
配置時(shí)使用方式為:
log4j.appender.appenderName = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
??? log4j.appender.appenderName.option = valueN
這樣就為日志的輸出提供了相當(dāng)大的便利。
3、Layouts
有時(shí)用戶(hù)希望根據(jù)自己的喜好格式化自己的日志輸出。Log4j可以在Appenders的后面附加Layouts來(lái)完成這個(gè)功能。Layouts提供了四種日志輸出樣式,如根據(jù)HTML樣式、自由指定樣式、包含日志級(jí)別與信息的樣式和包含日志時(shí)間、線程、類(lèi)別等信息的樣式等等。
其語(yǔ)法表示為:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以靈活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的級(jí)別和信息字符串),
org.apache.log4j.TTCCLayout(包含日志產(chǎn)生的時(shí)間、線程、類(lèi)別等等信息)
配置時(shí)使用方式為:
log4j.appender.appenderName.layout =fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
?Log4j的配置
以上是從原理方面說(shuō)明Log4j的使用方法,在具體Java編程使用Log4j可以參照以下示例:
1、 建立Logger實(shí)例:
語(yǔ)法表示:public static Logger getLogger( String name)
實(shí)際使用:static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName ()) ;
2、 讀取配置文件:
獲得了Logger的實(shí)例之后,接下來(lái)將配置Log4j使用環(huán)境:
語(yǔ)法表示:
BasicConfigurator.configure():自動(dòng)快速地使用缺省Log4j環(huán)境。
PropertyConfigurator.configure(String configFilename):讀取使用Java的特性文件編寫(xiě)的配置文件。
DOMConfigurator.configure(String filename):讀取XML形式的配置文件。
實(shí)際使用:
??? PropertyConfigurator.configure("ServerWithLog4j.properties");
3、 插入日志信息
完成了以上連個(gè)步驟以后,下面就可以按日志的不同級(jí)別插入到你要記錄日志的任何地方了。
語(yǔ)法表示:
Logger.debug(Object message);//調(diào)試信息
Logger.info(Object message);//一般信息
Logger.warn(Object message);//警告信息
Logger.error(Object message);//錯(cuò)誤信息
Logger.fatal(Object message);//致命錯(cuò)誤信息
實(shí)際使用:logger.info("ServerSocket before accept: " + server);
? 配置過(guò)程
在實(shí)際編程時(shí),要使Log4j真正在系統(tǒng)中運(yùn)行事先還要對(duì)配置文件進(jìn)行定義。定義步驟就是對(duì)Logger、Appender及Layout的分別使用。
??? Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是java properties(key=value)【Java特性文件(鍵=值)】。下面我們介紹使用Java特性文件做為配置文件的方法
?? 具體如下:
1、配置根Logger,其語(yǔ)法為:
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
???????? level : 是日志記錄的優(yōu)先級(jí),分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級(jí)別。Log4j建議只使用四個(gè)級(jí)別,優(yōu)先級(jí)從高到低分別是ERROR、WARN、INFO、DEBUG。通過(guò)在這里定義的級(jí)別,您可以控制到應(yīng)用程序中相應(yīng)級(jí)別的日志信息的開(kāi)關(guān)。比如在這里定義了INFO級(jí)別,則應(yīng)用程序中所有DEBUG級(jí)別的日志信息將不被打印出來(lái)。
???? appenderName:就是指定日志信息輸出到哪個(gè)地方。您可以同時(shí)指定多個(gè)輸出目的地。
?? 例如:log4j.rootLogger=info,A1,B2,C3
2、配置日志信息輸出目的地,其語(yǔ)法為:
log4j.appender.appenderName = fully.qualified.name.of.appender.class? //
? "fully.qualified.name.of.appender.class" 可以指定下面五個(gè)目的地中的一個(gè):
??????????1.org.apache.log4j.ConsoleAppender(控制臺(tái))
??????????2.org.apache.log4j.FileAppender(文件)
????????? 3.org.apache.log4j.DailyRollingFileAppender(每天產(chǎn)生一個(gè)日志文件)
????????? 4.org.apache.log4j.RollingFileAppender(文件大小到達(dá)指定尺寸的時(shí)候產(chǎn)生一個(gè)新的文件)
????????? 5.org.apache.log4j.WriterAppender(將日志信息以流格式發(fā)送到任意指定的地方)
???????????? 1.ConsoleAppender選項(xiàng)
??????????????????? Threshold=WARN:指定日志消息的輸出最低層次。
??????????????????? ImmediateFlush=true:默認(rèn)值是true,意謂著所有的消息都會(huì)被立即輸出。
??????????????????? Target=System.err:默認(rèn)情況下是:System.out,指定輸出控制臺(tái)
??????????????2.FileAppender 選項(xiàng)
??????????????????? Threshold=WARN:指定日志消息的輸出最低層次。
??????????????????? ImmediateFlush=true:默認(rèn)值是true,意謂著所有的消息都會(huì)被立即輸出。
??????????????????? File=mylog.txt:指定消息輸出到mylog.txt文件。
??????????????????? Append=false:默認(rèn)值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內(nèi)容。
??????????? 3.DailyRollingFileAppender 選項(xiàng)
??????????????????? Threshold=WARN:指定日志消息的輸出最低層次。
??????????????????? ImmediateFlush=true:默認(rèn)值是true,意謂著所有的消息都會(huì)被立即輸出。
????????????? ???????File=mylog.txt:指定消息輸出到 mylog.txt文件。
??????????????????? Append=false:默認(rèn)值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內(nèi)容。
??????????????????? DatePattern='.'yyyy-ww:每周滾動(dòng)一次文件,即每周產(chǎn)生一個(gè)新的文件。當(dāng)然也可以指定按月、周、天、時(shí)和分。即對(duì)應(yīng)的格式如下:
??????????????????? 1)'.'yyyy-MM: 每月
??????????????????? 2)'.'yyyy-ww: 每周?
??????????????????? 3)'.'yyyy-MM-dd: 每天
??????????????????? 4)'.'yyyy-MM-dd-a: 每天兩次
??????????????????? 5)'.'yyyy-MM-dd-HH: 每小時(shí)
??????????????????? 6)'.'yyyy-MM-dd-HH-mm: 每分鐘
??????????? 4.RollingFileAppender 選項(xiàng)
????????????? ???????Threshold=WARN:指定日志消息的輸出最低層次。
????????????? ???????ImmediateFlush=true:默認(rèn)值是true,意謂著所有的消息都會(huì)被立即輸出。
??????????????????? File=mylog.txt:指定消息輸出到mylog.txt文件。
??????????????????? Append=false:默認(rèn)值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內(nèi)容。
??????????????????? MaxFileSize=100KB: 后綴可以是KB, MB 或者是 GB. 在日志文件到達(dá)該大小時(shí),將會(huì)自動(dòng)滾動(dòng),即將原來(lái)的內(nèi)容移到mylog.log.1文件。
??????????????????? MaxBackupIndex=2:指定可以產(chǎn)生的滾動(dòng)文件的最大數(shù)。
實(shí)際應(yīng)用:
log4j.appender.A1=org.apache.log4j.ConsoleAppender //這里指定了日志輸出的第一個(gè)位置A1是控制臺(tái)ConsoleAppender
3、配置日志信息的格式,其語(yǔ)法為:
A.log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
???????????? ?"fully.qualified.name.of.layout.class" 可以指定下面4個(gè)格式中的一個(gè):
?????????????? 1.org.apache.log4j.HTMLLayout(以HTML表格形式布局),
?????? 2.org.apache.log4j.PatternLayout(可以靈活地指定布局模式),
?????? 3.org.apache.log4j.SimpleLayout(包含日志信息的級(jí)別和信息字符串),
?????? 4.org.apache.log4j.TTCCLayout(包含日志產(chǎn)生的時(shí)間、線程、類(lèi)別等等信息)
?????????????????? 1.HTMLLayout 選項(xiàng)
????????????????????? LocationInfo=true:默認(rèn)值是false,輸出java文件名稱(chēng)和行號(hào)
????????????????????? Title=my app file: 默認(rèn)值是 Log4J Log Messages.
???????????????????2.PatternLayout 選項(xiàng)
????????????????????? ConversionPattern=%m%n :指定怎樣格式化指定的消息。
?????????????????? 3.XMLLayout? 選項(xiàng)
????????????????????? LocationInfo=true:默認(rèn)值是false,輸出java文件和行號(hào)
?? 實(shí)際應(yīng)用:
?? log4j.appender.A1.layout=org.apache.log4j.PatternLayout
?????? B. log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
?????????? 這里需要說(shuō)明的就是日志信息格式中幾個(gè)符號(hào)所代表的含義:
???????? -X號(hào): X信息輸出時(shí)左對(duì)齊;
?????????????????? %p: 輸出日志信息優(yōu)先級(jí),即DEBUG,INFO,WARN,ERROR,F(xiàn)ATAL,
?????????????????? %d: 輸出日志時(shí)間點(diǎn)的日期或時(shí)間,默認(rèn)格式為ISO8601,也可以在其后指定格式,比如:%d{yyy MMM dd HH:mm:ss,SSS},輸出類(lèi)似:2002年10月18日 22:10:28,921
?????????????????? %r: 輸出自應(yīng)用啟動(dòng)到輸出該log信息耗費(fèi)的毫秒數(shù)
?????????????????? %c: 輸出日志信息所屬的類(lèi)目,通常就是所在類(lèi)的全名
?????????????????? %t: 輸出產(chǎn)生該日志事件的線程名
?????????????????? %l: 輸出日志事件的發(fā)生位置,相當(dāng)于%C.%M(%F:%L)的組合,包括類(lèi)目名、發(fā)生的線程,以及在代碼中的行數(shù)。舉例:Testlog4.main (TestLog4.java:10)
?????????????????? %x: 輸出和當(dāng)前線程相關(guān)聯(lián)的NDC(嵌套診斷環(huán)境),尤其用到像java servlets這樣的多客戶(hù)多線程的應(yīng)用中。
?????????????????? %%: 輸出一個(gè)"%"字符
?????????????????? %F: 輸出日志消息產(chǎn)生時(shí)所在的文件名稱(chēng)
???????????????????%L: 輸出代碼中的行號(hào)
?????????????????? %m: 輸出代碼中指定的消息,產(chǎn)生的日志具體信息
?????????????????? %n: 輸出一個(gè)回車(chē)換行符,Windows平臺(tái)為"\r\n",Unix平臺(tái)為"\n"輸出日志信息換行
??????????? 可以在%與模式字符之間加上修飾符來(lái)控制其最小寬度、最大寬度、和文本的對(duì)齊方式。如:
???????????????????? 1)%20c:指定輸出category的名稱(chēng),最小的寬度是20,如果category的名稱(chēng)小于20的話,默認(rèn)的情況下右對(duì)齊。
???????????????????? 2)%-20c:指定輸出category的名稱(chēng),最小的寬度是20,如果category的名稱(chēng)小于20的話,"-"號(hào)指定左對(duì)齊。
???????????????????? 3)%.30c:指定輸出category的名稱(chēng),最大的寬度是30,如果category的名稱(chēng)大于30的話,就會(huì)將左邊多出的字符截掉,但小于30的話也不會(huì)有空格。
???????????????????? 4)%20.30c:如果category的名稱(chēng)小于20就補(bǔ)空格,并且右對(duì)齊,如果其名稱(chēng)長(zhǎng)于30字符,就從左邊交遠(yuǎn)銷(xiāo)出的字符截掉。
這里上面三個(gè)步驟是對(duì)前面Log4j組件說(shuō)明的一個(gè)簡(jiǎn)化;下面給出一個(gè)具體配置例子,在程序中可以參照?qǐng)?zhí)行:
log4j.rootLogger=INFO,A1,B2
log4j.appender.A1=org.apache.log4j.ConsoleAppender
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n
? 根據(jù)上面的日志格式,某一個(gè)程序的輸出結(jié)果如下:
0 INFO 2003-06-13 13:23:46968 ClientWithLog4j Client socket: Socket[addr=localhost/127.0.0.1,port=8002,localport=2014]
???????? 16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server says: 'Java server with log4j, Fri Jun 13 13:23:46 CST 2003'
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j GOOD
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Command 'HELLO' not understood.'
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j HELP
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j Server responds: 'Vocabulary: HELP QUIT'
16 DEBUG 2003-06-13 13:23:46984 ClientWithLog4j QUIT
?
????? 4. # 當(dāng)輸出信息于回滾文件時(shí)
??????????log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender?? //指定以文件的方式輸出日志
???????????log4j.appender.ROLLING_FILE.Threshold=ERROR?
???????????log4j.appender.ROLLING_FILE.File=rolling.log? //文件位置,也可以用變量${java.home}、rolling.log
???????????log4j.appender.ROLLING_FILE.Append=true?
???????????log4j.appender.ROLLING_FILE.MaxFileSize=10KB? //文件最大尺寸
???????????log4j.appender.ROLLING_FILE.MaxBackupIndex=1? //備份數(shù)
???????????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?
××××××××××××××××××××××××××××××××××××××××××××××××
?
?Log4j比較全面的配置
?LOG4J的配置之簡(jiǎn)單使它遍及于越來(lái)越多的應(yīng)用中了:Log4J配置文件實(shí)現(xiàn)了輸出到控制臺(tái)、文件、回滾文件、發(fā)送日志郵件、輸出到數(shù)據(jù)庫(kù)日志表、自定義標(biāo)簽等全套功能。擇其一二使用就夠用了,
?log4j.rootLogger=DEBUG,CONSOLE,A1,im
?log4j.addivity.org.apache=true
?# 應(yīng)用于控制臺(tái)
?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
?#應(yīng)用于文件
?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
?# 應(yīng)用于文件回滾
?log4j.appender.ROLLING_FILE=org.apache.log4j.RollingFileAppender
?log4j.appender.ROLLING_FILE.Threshold=ERROR
?log4j.appender.ROLLING_FILE.File=rolling.log? //文件位置,也可以用變量${java.home}、rolling.log
?log4j.appender.ROLLING_FILE.Append=true?????? //true:添加? false:覆蓋
?log4j.appender.ROLLING_FILE.MaxFileSize=10KB?? //文件最大尺寸
?log4j.appender.ROLLING_FILE.MaxBackupIndex=1? //備份數(shù)
?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
?#應(yīng)用于socket
?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
?# 發(fā)送日志給郵件
?log4j.appender.MAIL=org.apache.log4j.net.SMTPAppender
?log4j.appender.MAIL.Threshold=FATAL
?log4j.appender.MAIL.BufferSize=10
?log4j.appender.MAIL.From=web@www.wuset.com
?log4j.appender.MAIL.SMTPHost=www.wusetu.com
?log4j.appender.MAIL.Subject=Log4J Message
?log4j.appender.MAIL.To=web@www.wusetu.com
?log4j.appender.MAIL.layout=org.apache.log4j.PatternLayout
?log4j.appender.MAIL.layout.ConversionPattern=[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
?# 用于數(shù)據(jù)庫(kù)
?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@cybercorlin.net
?log4j.appender.im.layout=org.apache.log4j.PatternLayout
?log4j.appender.im.layout.ConversionPattern =[framework] %d - %c -%-4r [%t] %-5p %c %x - %m%n
摘自:http://blog.csdn.net/eako/archive/2005/09/23/488099.aspx