Log4j日志配置详解

Log4j日志配置详解

1.Log4j组件

Loggers(记录器)
Appenders(输出源)
Layouts(布局)

####1.1. Loggers(记录器)
Loggers组件在此系统中被分为五个级别：

- DEBUG

- INFO

- WARN

- ERROR

- FATAL

五个级别的顺序,分别用来指定这条日志信息的重要程度：

DEBUG < INFO < WARN < ERROR < FATAL

Log4j规则：只输出级别不低于设定级别的日志信息，假如Loggers级别设定为INFO，则INFO、WARN、ERROR和FATAL级别的日志信息都会输出，而级别比INFO低的DEBUG则不会输出。

1.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 #将日志信息以流格式发送到任意指定的地方

- org.apache.log4j.jdbc.JDBCAppender #数据库

- org.apache.log4j.net.JMSAppender #

- org.apache.log4j.net.SocketAppender #Socket

- org.apache.log4j.net.SMTPAppender #邮件

1.3.Layouts（布局)

有时，用户希望根据自己的喜好格式化自己的日志输出，Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供四种日志输出格式，如根据HTML样式、自由指定样式、包含日志级别与信息的样式、包含日志时间、线程、类别等信息的样式。

常用类如下：

- org.apache.log4j.HTMLLayout #以HTML表格表式布局

- org.apache.log4j.PatternLayout #可以灵活批定布局模式

- org.apache.log4j.SimpleLayout #包含日志信息的级别和信息字符串

- org.apache.log4j.TTCCLayout #包含日志产生的时间、线程、类别等信息

2.Log4j配置详解

在实际应用中，要使Log4j在系统运行中运行需事先设置配置文件。配置文件事实上也就是对Logger、Appender及Layout进行相应的设定。

Log4j支持两种配置文件格式，一种是 XML格式的文件，一种是properties属性文件。下面以properties属性文件配置为例进行介绍log4j.properties的配置。

2.1.配置根Logger

格式:

log4j.rootLogger = [LEVEL], appenderName1, appenderName2,...
log3j.additivity.org.apache=false #表示Logger不会在父Logger的appender里输出，默认为true

说明：

• LEVEL: 设定日志记录的最低级别，可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义组别，Log4j建议只使用中间四个级别。

• appenderName:指定日志信息要输出到哪里，可以同时指定多个输出目的地，用逗号隔开；

例如：

log4j.rootLogger = INFO, A1,A2,A3

2.2.为不同的Appender设置输出级别

在配置文件中修改Appender的Threshold来实现，例如：

##########Set Log Levels###############
log4j.rootLogger = DEBUG, console, D, E

######### 输出到控制台 ####################
log4j.appender.console = org.apache.log4j.ConsoleAppender
log4j.appender.console.Target = System.out
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.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.E = org.apache.log4j.DailyRollingFileAppender
log4j.appender.E.File = ./logs/.error.log
log4j.appender.E.Append = true
log4j.appender.E.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

2.3.配置日志信息输出目的地(appender)

语法

java

log4j.appender.[appenderName] = [className]

- appenderName:自定义的appenderName,在log4j.rootLogger中设置;

- className: 可设置如下值:

- org.apache.log4j.ConsoleAppender #控制台

- org.apache.log4j.FileAppender #日志文件

- org.apache.log4j.DailyRollingFileAppender #每天产生一个日志文件

- org.apache.log4j.RollingFileAppender #文件大小到达指定尺寸的时候产生一个新的文件

- org.apache.log4j.WriterAppender #将日志信息以流格式发送到任意指定的地方

- org.apache.log4j.jdbc.JDBCAppender #数据库

- org.apache.log4j.net.JMSAppender #

- org.apache.log4j.net.SocketAppender #Socket

- org.apache.log4j.net.SMTPAppender #邮件

ConsoleAppender选项：

- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别，默认为DEBUG;

- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出，设为false则不输出，默认为true;

- Target = [System.out|System.err]: 默认为System.out;

FileAppender选项：

- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别，默认为DEBUG;

- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出，设为false则不输出，默认为true;

- Append = [true|false]: true表示消息增加到指定文件中，false则将消息覆盖指定文件内容，默认值为true;

- File = [path/file]:指定消息输出到目录path文件file中；

DailyRollingFileAppender选项：

- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别，默认为DEBUG;

- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出，设为false则不输出，默认为true;

- Append = [true|false]: true表示消息增加到指定文件中，false则将消息覆盖指定文件内容，默认值为true;

- File = [path/file]:指定消息输出到目录path文件file中；

- DataPattern =’.’yyyy-MM:每月滚动一次日志文件，即每月产生一个新的日志文件。当前月的日志文件名为file,前一个月的日志文件名为file.yyyy-MM,另外，可以指定按周、天、时、分等来滚动日志文件，对应的格式如下：

- ‘.’yyyy-MM: 每月

- ‘.’yyyy-ww: 每周

- ‘.’yyyy-MM-dd:每天

- ‘.’yyyy-MM-dd-a: 每天两次

- ‘.’yyyy-MM-dd-HH: 每小时

- ‘.’yyyy-MM-dd-HH-mm:每分钟

RollingFileAppender选项：

- Threshold = [DEBUG|INFO|WARN|ERROR|FATAL]: 指定日志信息的最低输出级别，默认为DEBUG;

- ImmediateFlush = [true|false]: 表示所有消息都会被立即输出，设为false则不输出，默认为true;

- Append = [true|false]: true表示消息增加到指定文件中，false则将消息覆盖指定文件内容，默认值为true;

- File = [path/file]:指定消息输出到目录path文件file中；

- MaxFileSize = [num][KB|MB|GB]:在日志文件达到该大小时，将会自动滚动，即将原来的内容移到file.1文件中。

- MaxBackupIndex = [num]: 指定可以产生的滚动文件的最大数，例如，设为2时则可以产生file.1, file.2两个滚动文件和一个file文件；

2.4.配置日志信息的输出格式(Layout)

语法

‘java’

‘log4j.appender.[appenderName].layout = [className]’

说明：

- className可设置如下：

- org.apache.log4j.HTMLLayout #以HTML表格表式布局

- org.apache.log4j.PatternLayout #可以灵活批定布局模式

- org.apache.log4j.SimpleLayout #包含日志信息的级别和信息字符串

- org.apache.log4j.TTCCLayout #包含日志产生的时间、线程、类别等信息

HTMLLayout选项：

- LocationInfo = [true|false]: 输出java文件名称和行号，默认值为false;

- Title = My Logging: 默认值为Log4j Log Messages

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	输出一个回车换行符	Windws平台为”rn”,Unix/Linux平台为”n”
%x	输出和当前线程相关联的DNC(嵌套诊断环境），尤其用到像java servlets这样的多客户多线程的应用中
%%	输出一个%字符

另外，还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式，如:

1)%20c：指定输出类的名称，最小的宽度是20，如果categories的名称小于20的话，默认的情况下右对齐。

2)%-20c:指定输出类的名称，最小的宽度是20，如果categories的名称小于20的话，”-“号指定左对齐。

3)%.30c:指定输出类的名称，最大的宽度是30，如果categories的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。

4)%20.30c:如果类的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边较远输出的字符截掉;

3.经典Log4j配置大全

####################Logger###########################
log4j.rootLogger = DEBUG,console,logFile,rollingFile,dailyFile,socket,mail,jdbc,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.out
log4j.appender.console.layout = org.apache.log4j.PatternLayout
log4j.appender.console.layout.ConversionPatter =[%-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 = ./log/logfile.log
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 = ./log/rollfile.log
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 = ./log/dailfile.log
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######################
#client
log4j.appender.socket = org.apache.log4j.net.SocketAppender
log4j.appender.socket.RemoteHost = localhost
log4j.appender.socket.Port = 5001
log4j.appender.socket.LocationInfo = true
log4j.appender.socket.ReconnectionDelay = 10000

#server
log4j.rootLogger = DEBUG, socketFile
log4j.appender.socketFile = org.apache.log4j.RollingFileAppender
log4j.appender.socketFile.File = ./log/servercollected.log
log4j.appender.socketFile.MaxFileSize = 200KB
log4j.appender.socketFile.MaxBackupIndex = 50
log4j.appender.socketFile.layout = org.apache.log4j.PatternLayout
log4j.appender.socketFile.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n

#########################mail##########################
log4j.appender.mail = org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold = FATAL
log4j.appender.mail.BufferSize = 10
log4j.appender.mail.From = xxxx@mail.com
log4j.appender.mail.SMTPHost = mail.com
log4j.appender.mail.Subject = Log4j Message
log4j.appender.mail.To = david.tian@live.com
log4j.appender.mail.layout = org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n

###########################JDBC############################
log4j.appender.jdbc = org.apache.log4j.jdbc.JDBCAppender
log4j.appender.jdbc.URL = jdbc:mysql://localhost:3306/logdb
log4j.appender.jdbc.driver = com.mysql.jdbc.Driver
log4j.appender.jdbc.user = root
log4j.appender.jdbc.password = root
log4j.appender.jdbc.sql = INSERT INTO log4j(Message) VALUES ('[%-5p] %d(%r) -->[%t] %l: %m %x %n')
log4j.appender.jdbc.layout = org.apache.log4j.PatternLayout
log4j.appender.jdbc.layout.ConversionPattern = [%-5p] %d(%r) -->[%t] %l: %m %x %n

#######################自定义Appender###############
log4j.appender.im = com.dvtn.www.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=[%-5p] %d(%r) --> [%t] %l: %m %x %n