日志論
在應用程序中輸出日志有有三個目的:
(1)監視代碼中變量的變化情況,把數據周期性地記錄到文件中供其他應用進行統計分析工作。
(2)跟蹤代碼運行進軌跡,作為日后審計的依據。
(3)擔當集成開發環境中的調試器,向文件或控制臺打印代碼的調試信息。
Apache能用日志包(Commons Logging Package)是Apache的一個開放源代碼項目,它提供了一組通用的日志接口,用戶可以自由地選擇實現日志接口的第三方軟件。通用日志包目前支持以下日志實現:
通用日志包中的兩個常用接口:LogFactory和Log,分別介紹如下:
通用日志包把消息分為6個級別:FATAL、ERROR、WARN、INFO、DEBUG和TRACE。其中FATAL級別最高,TRACE級別最低。Log接口提供輸出不同級別消息的方法:
off---------------------------------最高等級的,用于關閉所有日志記錄
fatal(Object message)-------輸出FATAL級別的消息。
error(Object message)-------輸出ERROR級別的消息。
warn(Object message)-------輸出WARN級別的消息。
info(Object message)-------輸出INFO級別的消息。
debug(Object message)-------輸出DEBUG級別的消息。
trace(Object message)-------輸出TRACE級別的消息。
all----------------------------------最低等級的,用于打開所有日志記錄
注:只有當輸出日志的級別大于或等于為日志配置器配置的日志級別時,這個方法才會執行。
如何指定日志器的日志級別,不同的日志器實現會有不同的實現方案。
LogFactory接口提供了獲得日志器實例的兩個靜態方法:
public static Log getLog(String name) throws LogConfigurationException;
public static Log getLog(Class class) throws LogConfigurationException;
注:name參數作為日志器的名字;class參數指定類名作為日志器名字。
log4j簡介
幾乎每個大的應用程序都有它自己的日志和跟蹤程序的API。順應這一規則,E.U.?SEMPER項目組決定編寫它自己的程序跟蹤API(tracing?API)。這開始于1996年早期。經過無數的工作,更改和性能加強,這個API終于成為一個十分受歡迎的Java日志軟件包,那就是log4j。這個軟件包的發行遵守open?source動議認證的Apache?Software?License。最新的log4j版本包括全部的源代碼,類文件和文檔資料,可以在?http://logging.apache.org/log4j/找到它們。另外,log4j已經被轉換成?C,?C++,?C#,?Perl,?Python,?Ruby,?和?Eiffel?語言。
Log4j是Apache的一個開放源代碼項目,通過使用Log4j,我們可以控制日志信息輸送的目的地是控制臺、文件、GUI組件、甚至是套接口服務 器、NT的事件記錄器、UNIX Syslog守護進程等;我們也可以控制每一條日志的輸出格式;通過定義每一條日志信息的級別,我們能夠更加細致地控制日志的生成過程。最令人感興趣的就 是,這些可以通過一個配置文件來靈活地進行配置,而不需要修改應用的代碼。
log4j三個組件
?????? 通常,我們都提供一個名為 log4j.properties的文件,在第一次調用到Log4J時,Log4J會在類路徑(../web-inf/class/當然也可以放到其它任何目錄,只要該目錄被包含到類路徑中即可)中定位這個文件,并讀入這個文件完成的配置。這個配置文件告 訴Log4J以什么樣的格式、把什么樣的信息、輸出到什么地方。
Log4j有三個主要的組件:Loggers(記錄器),Appenders(輸出源)和Layouts(布局),這里可簡單理解為日志類別,日志要輸出的地方和日志以何種形式輸出。綜合使用這三個組件可以輕松的記錄信息的類型和級別,并可以在運行時控制日志輸出的樣式和位置。下面對三個組件分別進行說明:
1、 Loggers
Loggers組件在此系統中被分為五個級別:DEBUG、INFO、WARN、ERROR和FATAL。這五個級別是有順序的,DEBUG < INFO < WARN < ERROR < FATAL,分別用來指定這條日志信息的重要程度,明白這一點很重要,這里Log4j有一個規則:假設Loggers級別為P,如果在Loggers中發生了一個級別Q比P高,則可以啟動,否則屏蔽掉。
假設你定義的級別是info,那么error和warn的日志可以顯示而比他低的debug信息就不顯示了。
?
Java程序舉例來說:
//建立Logger的一個實例,命名為“com.foo”
Logger logger = Logger.getLogger("com.foo"); //"com.foo"是實例進行命名,也可以任意
//設置logger的級別。通常不在程序中設置logger的級別。一般在配置文件中設置。
logger.setLevel(Level.INFO);
Logger barlogger = Logger.getLogger("com.foo.Bar");
//下面這個請求可用,因為WARN >= INFO
logger.warn("Low fuel level.");
//下面這個請求不可用,因為DEBUG < INFO
logger.debug("Starting search for nearest gas station.");
//命名為“com.foo.bar”的實例barlogger會繼承實例“com.foo”的級別。因此,下面這個請求可用,因為INFO >= INFO
barlogger.info("Located nearest gas station.");
//下面這個請求不可用,因為DEBUG < INFO
barlogger.debug("Exiting gas station search");
這里“是否可用”的意思是能否輸出Logger信息。
在對Logger實例進行命名時,沒有限制,可以取任意自己感興趣的名字。一般情況下建議以類的所在位置來命名Logger實例,這是目前來講比較有效的Logger命名方式。這樣可以使得每個類建立自己的日志信息,便于管理。比如:
static Logger logger = Logger.getLogger(ClientWithLog4j.class.getName());
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 = fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1 = value1
…
??? log4j.appender.appenderName.option = 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 =fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1 = value1
…
log4j.appender.appenderName.layout.option = valueN
?
log4j基本編程方法
以上是從原理方面說明Log4j的使用方法,在具體Java編程使用Log4j可以參照以下示例:
1、 建立Logger實例:
語法表示:public static Logger getLogger( String name)
實際使用:static Logger logger = Logger.getLogger(ServerWithLog4j.class.getName ()) ;
2、 讀取配置文件:
獲得了Logger的實例之后,接下來將配置Log4j使用環境:
語法表示:
BasicConfigurator.configure():自動快速地使用缺省Log4j環境。
PropertyConfigurator.configure(String configFilename):讀取使用Java的特性文件編寫的配置文件。
DOMConfigurator.configure(String filename):讀取XML形式的配置文件。
實際使用:
??? PropertyConfigurator.configure("ServerWithLog4j.properties");
3、 插入日志信息
完成了以上連個步驟以后,下面就可以按日志的不同級別插入到你要記錄日志的任何地方了。
語法表示:
Logger.debug(Object message);//調試信息
Logger.info(Object message);//一般信息
Logger.warn(Object message);//警告信息
Logger.error(Object message);//錯誤信息
Logger.fatal(Object message);//致命錯誤信息
實際使用:logger.info("ServerSocket before accept: " + server);
log4j配置文件
在實際編程時,要使Log4j真正在系統中運行事先還要對配置文件進行定義。定義步驟就是對Logger、Appender及Layout的分別使用。
??? Log4j支持兩種配置文件格式,一種是XML格式的文件,一種是java properties(key=value)【Java特性文件(鍵=值)】。下面我們介紹使用Java特性文件做為配置文件的方法
?? 具體如下:
1、配置根Logger,其語法為:
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
???????? level : 是日志記錄的優先級,分為OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者您定義的級別。Log4j建議只使用四個級別,優先級從高到低分別是ERROR、WARN、INFO、DEBUG。通過在這里定義的級別,您可以控制到應用程序中相應級別的日志信息的開關。比如在這里定 義了INFO級別,則應用程序中所有DEBUG級別的日志信息將不被打印出來。
???? appenderName:就是指定日志信息輸出到哪個地方。您可以同時指定多個輸出目的地。
?? 例如:log4j.rootLogger=info,A1,B2,C3
2、配置日志信息輸出目的地,其語法為:
log4j.appender.appenderName = fully.qualified.name.of.appender.class? //
? "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(將日志信息以流格式發送到任意指定的地方)
???????????? 1.ConsoleAppender選項
??????????????????? Threshold=WARN:指定日志消息的輸出最低層次。
??????????????????? ImmediateFlush=true:默認值是true,意謂著所有的消息都會被立即輸出。
??????????????????? Target=System.err:默認情況下是:System.out,指定輸出控制臺
??????????????2.FileAppender 選項
??????????????????? Threshold=WARN:指定日志消息的輸出最低層次。
??????????????????? ImmediateFlush=true:默認值是true,意謂著所有的消息都會被立即輸出。
??????????????????? File=mylog.txt:指定消息輸出到mylog.txt文件。
??????????????????? Append=false:默認值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內容。
??????????? 3.DailyRollingFileAppender 選項
??????????????????? Threshold=WARN:指定日志消息的輸出最低層次。
??????????????????? ImmediateFlush=true:默認值是true,意謂著所有的消息都會被立即輸出。
????????????????????File=mylog.txt:指定消息輸出到mylog.txt文件。
??????????????????? Append=false:默認值是true,即將消息增加到指定文件中,false指將消息覆蓋指定的文件內容。
??????????????????? DatePattern='.'yyyy-ww:每周滾動一次文件,即每周產生一個新的文件。當然也可以指定按月、周、天、時和分。即對應的格式如下:
??????????????????? 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:指定日志消息的輸出最低層次。
????????????????????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=org.apache.log4j.ConsoleAppender //這里指定了日志輸出的第一個位置A1是控制臺ConsoleAppender
╭=========================================╮
??? 青山不改 綠水長流http://blog.csdn.net/wangyihust
????? 歡迎各位轉貼,但需聲明版權,尊重技術原創性 :)
?????? E-mail:wangyihust@163.com??? OICQ:76406573???
╰=========================================╯
3、配置日志信息的格式,其語法為:
1).log4j.appender.appenderName.layout = fully.qualified.name.of.layout.class
???????????? ?"fully.qualified.name.of.layout.class" 可以指定下面4個格式中的一個:
?????????????? 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:默認值是false,輸出java文件名稱和行號
????????????????????? Title=my app file: 默認值是 Log4J Log Messages.
???????????????????2.PatternLayout 選項
????????????????????? ConversionPattern=%m%n :指定怎樣格式化指定的消息。
?????????????????? 3.XMLLayout? 選項
????????????????????? LocationInfo=true:默認值是false,輸出java文件和行號
?? 實際應用:
?? log4j.appender.A1.layout=org.apache.log4j.PatternLayout
?????? 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字符,就從左邊交遠銷出的字符截掉。
這里上面三個步驟是對前面Log4j組件說明的一個簡化;下面給出一個具體配置例子,在程序中可以參照執行:
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
? 根據上面的日志格式,某一個程序的輸出結果如下:
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. 當輸出信息于回滾文件時
??????????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? //備份數
???????????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?
???????? 5.Log4J對應用性能的影響
???????? 如果在程序運行中輸出大量日志,顯然會對應用的性能造成一定的影響。Log4J對性能的影響取決于以下因素:
- 日志輸出目的地:輸出到控制臺的速度和輸出到文件系統的速度是不一樣的。
- 日志輸出格式:格式簡單,速度也更快。
- 日志級別:日志級別設置的越低,輸出的日志內容越多,對性能的影響也越大。
log4j全能配置文件(轉自gmmgood)
?????? 下面給出得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@hollycrm.com log4j.appender.MAIL.SMTPHost=mail.hollycrm.com log4j.appender.MAIL.Subject=Log4J Message log4j.appender.MAIL.To=chenyl@hollycrm.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@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 |
?
使用XML配置文件
首先,看看下面的XML配置文件示例:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="???????
? <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
??? <layout class="org.apache.log4j.SimpleLayout"/>
? </appender>
? <root>
??? <priority value ="debug" />
??? <appender-ref ref="ConsoleAppender"/>
? </root>
</log4j:configuration>
???
?
文件以標準的XML聲明作為開始,后面跟著指出DTD(文檔類型定義)的DOCTYPE聲明,它定義了XML文件的結構,例如,什么元素可以嵌入在其他元素中等等。上面文件在log4j發行版的src/java/org/apache/log4j/xml目錄中。 接著看看封裝所有元素的 log4j:configuration 元素,它在DOCTYPE聲明中被指定為根元素。嵌入在根元素中有兩個結構:
? <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
??? <layout class="org.apache.log4j.SimpleLayout"/>
? </appender>?????
???
?
這里創建一個名叫"ConsoleAppender"的 Appender,注意,你可以選擇任何名字,該示例之所以選擇"ConsoleAppender",完全是為了示例的設計。接著這個appender類以全名形式給出,經常用規范(fully qualified)類名。 Appender必須具有一個指定的 name和class。嵌入在 Appender之內的是 layout元素,這里它被指定為SimpleLayout。 Layout 必須具有一個 class屬性。
? <root>
??? <priority value ="debug" />
??? <appender-ref ref="ConsoleAppender"/>
? </root>??????
???
root元素必須存在且不能被子類化。示例中的優先級被設置為"debug",設置appender飽含一個appender-ref元素。還有更多的屬性或元素可以指定。查看log4j發行版中的src/java/org/apache/log4j/xml/log4j.dtd以了解關于XML配置文件結構的更多信息。可以用下面這種方法把配置信息文件讀入到Java程序中:
DOMConfigurator.configure("configurationfile.xml");???
DOMConfigurator 用一棵DOM樹來初始化log4j環境。這里是示例中的XML配置文件:configurationfile.xml。這里是執行該配置文件的java程序:
import org.apache.log4j.Logger;
import org.apache.log4j.xml.DOMConfigurator;
public class externalxmltest {
?? static Logger logger = Logger.getLogger(filetest.class);
?? public static void main(String args[]) {
????? DOMConfigurator.configure("xmllog4jconfig.xml");
????? logger.debug("Here is some DEBUG");
????? logger.info("Here is some INFO");
????? logger.warn("Here is some WARN");
????? logger.error("Here is some ERROR");
????? logger.fatal("Here is some FATAL");
?? }
}
???
對于帶有PatternLayout的FileAppender的日志記錄器Logger的XML配置文件:
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">
<log4j:configuration xmlns:log4j="???????
? <appender name="appender" class="org.apache.log4j.FileAppender">
??? <param name="File" value="Indentify-Log.txt"/>
??? <param name="Append" value="true"/>
??? <layout class="org.apache.log4j.PatternLayout">
????? <param name="ConversionPattern" value="%d [%t] %p - %m%n"/>
??? </layout>
? </appender>
? <root>
??? <priority value ="info"/>
??? <appender-ref ref="appender"/>
? </root>
</log4j:configuration>
???
?
log4j日志寫入數據庫
首先創建一數據庫表:
字段 | 描述 |
GUID | 流水號 IDENTITY (1, 1) |
DATE | 時間 |
THREAD | 當前線程 |
LEVEL | 當前級別 |
CLASS | 當前類的java程序/方法 |
MESSAGES | 當前輸出信息 |
EXCEPTION | 異常信息 |
log4j.properties如下配置:
log4j.rootLogger=DEBUG,CONSOLE,DATABASE
log4j.addivity.org.apache=true
########################
# JDBC Appender
#######################
log4j.appender.DATABASE.Threshold=INFO
log4j.appender.DATABASE=org.apache.log4j.jdbc.JDBCAppender
#log4j.appender.DATABASE.BufferSize=10
log4j.appender.DATABASE.URL=you jdbcurl
log4j.appender.DATABASE.driver=you jdbc driver
log4j.appender.DATABASE.user=
log4j.appender.DATABASE.password=
log4j.appender.DATABASE.sql=INSERT INTO?YOU_LOG_TABLE?VALUES ('%d{yyyy-MM-dd HH:mm:ss}', '%t', '%p', '%l', '%m', '')
log4j.appender.DATABASE.layout=org.apache.log4j.PatternLayout
?
下面我們對“%d %t %p %l %m %n”一一講解:
?
l???????? %d輸出日志時間點的日期或時間,默認格式為ISO8601,也可以在其后指定格式,比如:%d{yyyy-MM-dd HH:mm:ss},輸出類似:2006-01-18 17:50:22',剛好適合插入SQLServer;
?
l???????? %t?產生該日志事件的線程名;
?
l???????? %p 日志的log_level,如DEBUG、WARN或者INFO;
?
l???????? %c?輸出所屬的類目,通常就是所在類的全名,如“com.eking.TestLog”;
?
l???????? %m 日志的內容;
?
l???????? %l ?輸出日志事件的發生位置,包括類目名、發生的線程,以及在代碼中的行數。如Wite2Database.main(Wite2Database.java:18);
?
l???????? %n ?輸出一個回車換行符,Windows平臺為“ ”,Unix平臺為“ ”
程序代碼:
import sun.jdbc.odbc.*;
import java.sql.*;
import org.apache.log4j.Category;
import org.apache.log4j.Level;
import org.apache.log4j.Logger;
import org.apache.log4j.PropertyConfigurator;
import org.apache.log4j.jdbc.*;
public class Write2Database{
? public static void main(String[] args){
??? static Logger logger = Logger.getLogger
??????????? ( write2database.class.getName () ) ;
??? PropertyConfigurator.configure ( "log4j2database.properties" ) ;
??? logger.info ( "test" ) ;
? }
}
運行起來,你就會看到有這樣的sql語句被執行了:
?????? INSERT INTO jws_log? VALUES ('2006-01-18 17:50:22', 'main', 'INFO', 'Wite2Database.main(Write2Database.java:18)', 'test', '')
注意:在賽迪論壇上有一個筆者按照上述類似的方法沒有運行成功,現將他所出現的問題和解決方法轉載。
上述方法是利用傳統的數據庫連接方法,對于數據庫的管理和效率嚴重不足,在現在這個連接池橫行的時代,為什么我們不能給給Log4j配上連接池,讓Log4j利用數據連接池的連接和數據庫進行通訊。現查看Log4j的Api,發現JDBCAppender這個類有以下幾段話:WARNING: This version of JDBCAppender is very likely to be completely replaced in the future. Moreoever, it does not log exceptions. The JDBCAppender provides for sending log events to a database.
For use as a base class:
- Override
getConnection()
to pass any connection you want. Typically this is used to enable application wide connection pooling.
- Override
closeConnection(Connection con)
-- if you override getConnection make sure to implement closeConnection
to handle the connection you generated. Typically this would return the connection to the pool it came from.
- Override
getLogStatement(LoggingEvent event)
to produce specialized or dynamic statements. The default uses the sql option value.
原來log4j建議我們把其提供的JDBCAppender作為基類來使用,然后Override三個父類的方法:getConnection(),closeConnection(Connection con)和getLogStatement(LoggingEvent event)。
原來如此,那就寫一個子類JDBCPoolAppender來替代這個JDBCAppender
JDBCPoolAppender代碼和其相關代碼如下:
JDBCPoolAppender.java:
package common.log;
import java.sql.Connection;
import org.apache.log4j.spi.LoggingEvent;
import java.sql.SQLException;
import java.sql.Statement;
import java.util.Iterator;
import org.apache.log4j.spi.ErrorCode;
import org.apache.log4j.PatternLayout;
import common.sql.MyDB;
import common.sql.GeneralDb;
public class JDBCPoolAppender extends org.apache.log4j.jdbc.JDBCAppender {
private MyDB mydb = null;
protected String sqlname=""; //增加一個數據庫jndiName的屬性
protected Connection connection = null;
protected String sqlStatement = "";
/**
* size of LoggingEvent buffer before writting to the database.
* Default is 1.
*/
protected int bufferSize = 1;
public JDBCPoolAppender() {
super();
}
/**
* ArrayList holding the buffer of Logging Events.
*/
public void append(LoggingEvent event) {
buffer.add(event);
if (buffer.size() >= bufferSize)
flushBuffer();
}
/**
* By default getLogStatement sends the event to the required Layout object.
* The layout will format the given pattern into a workable SQL string.
*
* Overriding this provides direct access to the LoggingEvent
* when constructing the logging statement.
*
*/
protected String getLogStatement(LoggingEvent event) {
return getLayout().format(event);
}
/**
*
* Override this to provide an alertnate method of getting
* connections (such as caching). One method to fix this is to open
* connections at the start of flushBuffer() and close them at the
* end. I use a connection pool outside of JDBCAppender which is
* accessed in an override of this method.
* */
protected void execute(String sql) throws SQLException {
Connection con = null;
Statement stmt = null;
try {
con = getConnection();
stmt = con.createStatement();
stmt.executeUpdate(sql);
} catch (SQLException e) {
if (stmt != null)
stmt.close();
throw e;
}
stmt.close();
closeConnection(con);
//System.out.println("Execute: " + sql);
}
/**
* Override this to return the connection to a pool, or to clean up the
* resource.
*
* The default behavior holds a single connection open until the appender
* is closed (typically when garbage collected).
*/
protected void closeConnection(Connection con) {
mydb=null;
try {
if (connection != null && !connection.isClosed())
connection.close();
} catch (SQLException e) {
errorHandler.error("Error closing connection", e,
ErrorCode.GENERIC_FAILURE);
}
}
/**
* Override 此函數來利用連接池返回一個Connetion對象
*
*/
protected Connection getConnection() throws SQLException {
try {
mydb = GeneralDb.getInstance(sqlname);
connection = mydb.getConnection();
} catch (Exception e) {
errorHandler.error("Error opening connection", e, ErrorCode.GENERIC_FAILURE);
}
return connection;
}
/**
* Closes the appender, flushing the buffer first then closing the default
* connection if it is open.
*/
public void close() {
flushBuffer();
try {
if (connection != null && !connection.isClosed())
connection.close();
} catch (SQLException e) {
errorHandler.error("Error closing connection", e,
ErrorCode.GENERIC_FAILURE);
}
this.closed = true;
}
/**
* loops through the buffer of LoggingEvents, gets a
* sql string from getLogStatement() and sends it to execute().
* Errors are sent to the errorHandler.
*
* If a statement fails the LoggingEvent stays in the buffer!
*/
public void flushBuffer() {
//Do the actual logging
removes.ensureCapacity(buffer.size());
for (Iterator i = buffer.iterator(); i.hasNext(); ) {
try {
LoggingEvent logEvent = (LoggingEvent) i.next();
String sql = getLogStatement(logEvent);
execute(sql);
removes.add(logEvent);
} catch (SQLException e) {
errorHandler.error("Failed to excute sql", e,
ErrorCode.FLUSH_FAILURE);
}
}
// remove from the buffer any events that were reported
buffer.removeAll(removes);
// clear the buffer of reported events
removes.clear();
}
/** closes the appender before disposal */
public void finalize() {
close();
}
/**
* JDBCAppender requires a layout.
* */
public boolean requiresLayout() {
return true;
}
/**
*
*/
public void setSql(String s) {
sqlStatement = s;
if (getLayout() == null) {
this.setLayout(new PatternLayout(s));
} else {
((PatternLayout) getLayout()).setConversionPattern(s);
}
}
/**
* Returns pre-formated statement eg: insert into LogTable (msg) values ("%m")
*/
public String getSql() {
return sqlStatement;
}
public void setSqlname(String sqlname){
sqlname=sqlname;
}
public String getSqlname(){
return sqlname;
}
public void setBufferSize(int newBufferSize) {
bufferSize = newBufferSize;
buffer.ensureCapacity(bufferSize);
removes.ensureCapacity(bufferSize);
}
public int getBufferSize() {
return bufferSize;
}
}
MyDB.java:
package common.sql;
import java.sql.*;
import com.codestudio.sql.*; //引入開源項目Poolman數據庫連接池的包
public class MyDB {
public static final String module = MyDB.class.getName();
private String dbName = "";
private PoolMan plmn = null;
public MyDB(String dbName) {
try {
if (plmn == null) {
plmn = (PoolMan) Class.forName("com.codestudio.sql.PoolMan").
newInstance();
}
} catch (Exception ec) {
System.out.println(ec.toString()+module);
}
this.dbName = dbName;
}
private Connection getNewConnection() {
Connection conn = null;
try {
conn = plmn.connect("jdbc:poolman://" + dbName);
conn.setAutoCommit(true);
} catch (Exception ec) {
System.out.println(ec.toString()+"First:Connect sqlsever failed"+module);
try {
Thread.sleep(1000);
conn = plmn.connect("jdbc:poolman://" + dbName);
conn.setAutoCommit(true);
} catch (Exception ecs) {
System.out.println(ecs.toString()+"Again:Connect sqlsever faile"+module);
}
}
return conn;
}
public Connection getConnection() {
return getNewConnection();
}
}
GeneralDb.java:
package common.sql;
package common.sql;
import java.util.*;
public class GeneralDb {
private static Hashtable dbPool;
public static MyDB getInstance(String dbname) {
if (dbPool == null) {
dbPool = new Hashtable();
}
MyDB db = (MyDB) dbPool.get(dbname);
if (db == null) {
db = new MyDB(dbname);
dbPool.put(dbname, db);
}
return db;
}
}
Log4j數據庫連接池的配置如下:
log4j.appender.JDBC=common.log.JDBCPoolAppender
log4j.appender.JDBC.sqlname=log
log4j.appender.JDBC.layout=org.apache.log4j.PatternLayout
log4j.appender.JDBC.sql=INSERT INTO LOGGING (log_date, log_level,
location, message) VALUES ('%d{ISO8601}', '%-5p', '%C,%L', '%m')
poolman.xml配置如下:
〈?xml version="1.0" encoding="UTF-8"?>
〈poolman>
〈management-mode>local〈/management-mode>
〈datasource>
〈dbname>log〈/dbname>
〈jndiName>log〈/jndiName>
〈driver>com.mysql.jdbc.Driver〈/driver>
〈url>jdbc:mysql://localhost:3306/test〈/url>
〈username>use〈/username>
〈password>password〈/password>
〈minimumSize>0〈/minimumSize>
〈maximumSize>10〈/maximumSize>
〈logFile>logs/mysql.log〈/logFile>
〈/datasource>
〈/poolman>
?? 運行成功!對于JDBCPoolAppender的屬性(比如sqlname屬性)我們可以利用Log4j的反射機制隨便添加,只要在配置文件給其附上值即可應用,而原來的父類里面的一些屬性(username什么的)和其get,set方法由于在連接池中不需要,所以刪除。而在JDBCPoolAppender類中,我也只是將getConnection 方法Override ,在這個方法中我們可以根據需要生成我們的Connection對象,另外兩個方法大家可以根據需求來決定怎樣Override。
?
Log4Net? for .net framework
???? 等待研究?
?????? 用戶可以從http://logging.apache.org/log4net/下載log4net的源代碼。解壓軟件包后,在解壓的src目錄下將log4net.sln載入Visual Studio .NET,編譯后可以得到log4net.dll。用戶要在自己的程序里加入日志功能,只需將log4net.dll引入工程即可。??
?╭=========================================╮
??? 青山不改 綠水長流http://blog.csdn.net/wangyihust
????? 歡迎各位轉貼,但需聲明版權,尊重技術原創性 :)
?????? E-mail:wangyihust@163.com??? OICQ:76406573???
╰=========================================╯
?
posted on 2006-10-17 09:44
SIMONE 閱讀(1674)
評論(0) 編輯 收藏