天天看點

Log4j配置詳解

Log4J的配置檔案(Configuration File)就是用來設定記錄器的級别、存放器和布局的,它可接key=value格式的設定或xml格式的設定資訊。通過配置,可以建立出Log4J的運作環境。

1. 配置檔案

Log4J配置檔案的基本格式如下:

其中 [level] 是日志輸出級别,共有5級:

Log4j配置詳解

FATAL       0  

Log4j配置詳解

ERROR     3  

Log4j配置詳解

WARN       4  

Log4j配置詳解

INFO          6  

Log4j配置詳解

DEBUG     7 

Log4j配置詳解

Appender 為日志輸出目的地,Log4j提供的appender有以下幾種:

Log4j配置詳解

org.apache.log4j.ConsoleAppender(控制台),

Log4j配置詳解

org.apache.log4j.FileAppender(檔案),

Log4j配置詳解

org.apache.log4j.DailyRollingFileAppender(每天産生一個日志檔案),

Log4j配置詳解

org.apache.log4j.RollingFileAppender(檔案大小到達指定尺寸的時候産生一個新的檔案),

Log4j配置詳解

org.apache.log4j.WriterAppender(将日志資訊以流格式發送到任意指定的地方)

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

Log4j配置詳解

org.apache.log4j.HTMLLayout(以HTML表格形式布局),

Log4j配置詳解

org.apache.log4j.PatternLayout(可以靈活地指定布局模式),

Log4j配置詳解

org.apache.log4j.SimpleLayout(包含日志資訊的級别和資訊字元串),

Log4j配置詳解

org.apache.log4j.TTCCLayout(包含日志産生的時間、線程、類别等等資訊)

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解

  %r   輸出自應用啟動到輸出該log資訊耗費的毫秒數 

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解

  %n   輸出一個回車換行符,Windows平台為“/r/n”,Unix平台為“/n” 

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解

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 就能實作,比如下面的例子:

[配置檔案]

Log4j配置詳解

 ### set log levels ###

Log4j配置詳解

log4j.rootLogger = debug ,  stdout ,  D ,  E

Log4j配置詳解
Log4j配置詳解

### 輸出到控制台 ###

Log4j配置詳解

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

Log4j配置詳解

log4j.appender.stdout.Target = System.out

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解
Log4j配置詳解

### 輸出到日志檔案 ###

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解

log4j.appender.D.Append = true

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解
Log4j配置詳解

### 儲存異常資訊到單獨檔案 ###

Log4j配置詳解
Log4j配置詳解

log4j.appender.D.File = logs/error.log ## 異常日志檔案名

Log4j配置詳解
Log4j配置詳解

log4j.appender.D.Threshold = ERROR ## 隻輸出ERROR級别以上的日志!!!

Log4j配置詳解
Log4j配置詳解

[代碼中使用] 

Log4j配置詳解

 public   class  TestLog4j  {

Log4j配置詳解

     public   static   void  main(String[] args)  {

Log4j配置詳解

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

Log4j配置詳解

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

Log4j配置詳解

        logger.debug( " debug " );

Log4j配置詳解

        logger.error( " error " );

Log4j配置詳解

    } 

Log4j配置詳解

}

運作一下,看看異常資訊是不是儲存在了一個單獨的檔案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:指定日志消息的輸出最低層次。

File=mylog.txt:指定消息輸出到mylog.txt檔案。

Append=false:預設值是true,即将消息增加到指定檔案中,false指将消息覆寫指定的檔案内容。

RollingFileAppender 選項

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: 輸出産生該日志事件的線程名

 %%: 輸出一個"%"字元

 %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.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.Threshold=FATAL 

log4j.appender.MAIL.BufferSize=10 

<a href="mailto:[email protected]">[email protected]</a>

log4j.appender.MAIL.SMTPHost=mail.hollycrm.com 

log4j.appender.MAIL.Subject=Log4J Message 

<a href="mailto:[email protected]">[email protected]</a>

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.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.username = username 

log4j.appender.im.password = password 

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, 

 在項目中引用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.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

# 将日志發送到email

全部代碼:Log4jTest.java

 import org.apache.log4j.*;   

 //import org.apache.log4j.nt.*;   

 //import org.apache.log4j.net.*;   

 /**  

  * @author yanxu  

  */   

 public class Log4jTest   

 {   

  public static void main(String args[])   

  {   

   PropertyConfigurator.configure("log4j.properties");   

   //在背景輸出   

   Logger logger1 = Logger.getLogger("console");   

   logger1.debug("debug!!!");   

   logger1.info("info!!!");   

   logger1.warn("warn!!!");   

   logger1.error("error!!!");   

   logger1.fatal("fatal!!!");  

//在NT系統日志輸出   

   Logger logger2 = Logger.getLogger("NTlog");   

   //NTEventLogAppender nla = new NTEventLogAppender();   

   logger2.debug("debug!!!");   

   logger2.info("info!!!");   

   logger2.warn("warn!!!");   

   logger2.error("error!!!");   

   //隻有這個錯誤才會寫入2000日志   

   logger2.fatal("fatal!!!");  

//把日志發送到mail   

   Logger logger3 = Logger.getLogger("MailLog");   

   //SMTPAppender sa = new SMTPAppender();   

   logger3.warn("warn!!!");   

   logger3.error("error!!!");   

   logger3.fatal("fatal!!!");   

  }   

 }