log4j配置大全

一、Log4j簡介

插叙：web.xml 配置

<context-param>

<param-name>webAppRootKey</param-name>

<param-value>pews.root</param-value>

</context-param>

進入主題：

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平台為"\r\n"，Unix平台為"\n"。

%x：輸出和目前線程相關聯的NDC(嵌套診斷環境)，尤其用到像java servlets這樣的多客戶多線程的應用中。

%%：輸出一個"%"字元。

另外，還可以在%與格式字元之間加上修飾符來控制其最小長度、最大長度、和文本的對齊方式。如：

1)%20c：指定輸出category的名稱，最小的長度是20，如果category的名稱長度小于20的話，預設的情況下右對齊。

2)%-20c："-"号表示左對齊。

3)%.30c：指定輸出category的名稱，最大的長度是30，如果category的名稱長度大于30的話，就會将左邊多出的字元截掉，但小于30的話也不會補空格。

附：Log4j比較全面的配置

Log4j配置檔案實作了輸出到控制台、檔案、復原檔案、發送日志郵件、輸出到資料庫日志表、自定義标簽等全套功能。

log4j.rootLogger=DEBUG,console,dailyFile,im

log4j.additivity.org.apache=true

# 控制台(console)

log4j.appender.console=org.apache.log4j.ConsoleAppender

log4j.appender.console.Threshold=DEBUG

log4j.appender.console.ImmediateFlush=true

log4j.appender.console.Target=System.err

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

log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 日志檔案(logFile)

log4j.appender.logFile=org.apache.log4j.FileAppender

log4j.appender.logFile.Threshold=DEBUG

log4j.appender.logFile.ImmediateFlush=true

log4j.appender.logFile.Append=true

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

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

log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 復原檔案(rollingFile)

log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender

log4j.appender.rollingFile.Threshold=DEBUG

log4j.appender.rollingFile.ImmediateFlush=true

log4j.appender.rollingFile.Append=true

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

log4j.appender.rollingFile.MaxFileSize=200KB

log4j.appender.rollingFile.MaxBackupIndex=50

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

log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 定期復原日志檔案(dailyFile)

log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender

log4j.appender.dailyFile.Threshold=DEBUG

log4j.appender.dailyFile.ImmediateFlush=true

log4j.appender.dailyFile.Append=true

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

log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd

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

log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 應用于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 Factor 5

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

log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# Log Factor 5 Appender

log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender

log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000

# 發送日志到指定郵件

log4j.appender.mail=org.apache.log4j.net.SMTPAppender

log4j.appender.mail.Threshold=FATAL

log4j.appender.mail.BufferSize=10

log4j.appender.mail.From = [email protected]

log4j.appender.mail.SMTPHost=mail.com

log4j.appender.mail.Subject=Log4J Message

log4j.appender.mail.To= [email protected]

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

log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 應用于資料庫

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('=[%-5p] %d(%r) --> [%t] %l: %m %x %n')

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

log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

# 自定義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 = [email protected]

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

log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n