Log4J日志配置详解
一、Log4j简介
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)等,可以根据天数或者文件大小产生新的文件,可以以流的形式发送到其它地方等等。
常使用的类如下:
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 log4j.appender.appenderName = className 2 log4j.appender.appenderName.Option1 = value1 3 … 4 log4j.appender.appenderName.OptionN = valueN
3、Layouts
有时用户希望根据自己的喜好格式化自己的日志输出,Log4j可以在Appenders的后面附加Layouts来完成这个功能。Layouts提供四种日志输出样式,如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。
常使用的类如下:
1 org.apache.log4j.HTMLLayout(以HTML表格形式布局) 2 org.apache.log4j.PatternLayout(可以灵活地指定布局模式) 3 org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串) 4 org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等信息)
配置模式:
1 log4j.appender.appenderName.layout =className 2 log4j.appender.appenderName.layout.Option1 = value1 3 … 4 log4j.appender.appenderName.layout.OptionN = valueN
二、配置详解
在实际应用中,要使Log4j在系统中运行须事先设定配置文件。配置文件事实上也就是对Logger、Appender及Layout进行相应设定。Log4j支持两种配置文件格式,一种是XML格式的文件,一种是properties属性文件。下面以properties属性文件为例介绍log4j.properties的配置。
1、配置根Logger:
1 log4j.rootLogger = [ level ] , appenderName1, appenderName2, … 2 log4j.additivity.org.apache=false:表示Logger不会在父Logger的appender里输出,默认为true。
level :设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别。通过在这里设定级别,您可以控制应用程序中相应级别的日志信息的开关,比如在这里设定了INFO级别,则应用程序中所有DEBUG级别的日志信息将不会被打印出来。
1 appenderName:就是指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开。 2 例如:log4j.rootLogger=INFO,A1,B2,C3
2、配置日志信息输出目的地(appender):
1 log4j.appender.appenderName = className
appenderName:自定义appderName,在log4j.rootLogger设置中使用;
className:可设值如下:
1 (1)org.apache.log4j.ConsoleAppender(控制台) 2 (2)org.apache.log4j.FileAppender(文件) 3 (3)org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件) 4 (4)org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件) 5 (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):
1 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平台为"rn",Unix平台为"n"。
%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%%:输出一个"%"字符。
另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:
1) c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。
2)%-20c:"-"号表示左对齐。
3)%.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。
附:Log4j比较全面的配置
Log4j配置文件实现了输出到控制台、文件、回滚文件、发送日志邮件、输出到数据库日志表、自定义标签等全套功能。
1 log4j.rootLogger=DEBUG,console,dailyFile,im 2 log4j.additivity.org.apache=true 3 # 控制台(console) 4 log4j.appender.console=org.apache.log4j.ConsoleAppender 5 log4j.appender.console.Threshold=DEBUG 6 log4j.appender.console.ImmediateFlush=true 7 log4j.appender.console.Target=System.err 8 log4j.appender.console.layout=org.apache.log4j.PatternLayout 9 log4j.appender.console.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n 10 # 日志文件(logFile) 11 log4j.appender.logFile=org.apache.log4j.FileAppender 12 log4j.appender.logFile.Threshold=DEBUG 13 log4j.appender.logFile.ImmediateFlush=true 14 log4j.appender.logFile.Append=true 15 log4j.appender.logFile.File=D:/logs/log.log4j 16 log4j.appender.logFile.layout=org.apache.log4j.PatternLayout 17 log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n 18 # 回滚文件(rollingFile) 19 log4j.appender.rollingFile=org.apache.log4j.RollingFileAppender 20 log4j.appender.rollingFile.Threshold=DEBUG 21 log4j.appender.rollingFile.ImmediateFlush=true 22 log4j.appender.rollingFile.Append=true 23 log4j.appender.rollingFile.File=D:/logs/log.log4j 24 log4j.appender.rollingFile.MaxFileSize=200KB 25 log4j.appender.rollingFile.MaxBackupIndex=50 26 log4j.appender.rollingFile.layout=org.apache.log4j.PatternLayout 27 log4j.appender.rollingFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n 28 # 定期回滚日志文件(dailyFile) 29 log4j.appender.dailyFile=org.apache.log4j.DailyRollingFileAppender 30 log4j.appender.dailyFile.Threshold=DEBUG 31 log4j.appender.dailyFile.ImmediateFlush=true 32 log4j.appender.dailyFile.Append=true 33 log4j.appender.dailyFile.File=D:/logs/log.log4j 34 log4j.appender.dailyFile.DatePattern='.'yyyy-MM-dd 35 log4j.appender.dailyFile.layout=org.apache.log4j.PatternLayout 36 log4j.appender.dailyFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n 37 # 应用于socket 38 log4j.appender.socket=org.apache.log4j.RollingFileAppender 39 log4j.appender.socket.RemoteHost=localhost 40 log4j.appender.socket.Port=5001 41 log4j.appender.socket.LocationInfo=true 42 # Set up for Log Factor 5 43 log4j.appender.socket.layout=org.apache.log4j.PatternLayout 44 log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n 45 # Log Factor 5 Appender 46 log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender 47 log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000 48 # 发送日志到指定邮件 49 log4j.appender.mail=org.apache.log4j.net.SMTPAppender 50 log4j.appender.mail.Threshold=FATAL 51 log4j.appender.mail.BufferSize=10 52 log4j.appender.mail.From = xxx@mail.com 53 log4j.appender.mail.SMTPHost=mail.com 54 log4j.appender.mail.Subject=Log4J Message 55 log4j.appender.mail.To= xxx@mail.com 56 log4j.appender.mail.layout=org.apache.log4j.PatternLayout 57 log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n 58 # 应用于数据库 59 log4j.appender.database=org.apache.log4j.jdbc.JDBCAppender 60 log4j.appender.database.URL=jdbc:mysql://localhost:3306/test 61 log4j.appender.database.driver=com.mysql.jdbc.Driver 62 log4j.appender.database.user=root 63 log4j.appender.database.password= 64 log4j.appender.database.sql=INSERT INTO LOG4J (Message) VALUES('=[%-5p] %d(%r) --> [%t] %l: %m %x %n') 65 log4j.appender.database.layout=org.apache.log4j.PatternLayout 66 log4j.appender.database.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n 67 # 自定义Appender 68 log4j.appender.im = net.cybercorlin.util.logger.appender.IMAppender 69 log4j.appender.im.host = mail.cybercorlin.net 70 log4j.appender.im.username = username 71 log4j.appender.im.password = password 72 log4j.appender.im.recipient = corlin@cybercorlin.net 73 log4j.appender.im.layout=org.apache.log4j.PatternLayout 74 log4j.appender.im.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
log4j的强大功能无可置疑,但实际应用中免不了遇到某个功能需要输出独立的日志文件的情况,怎样才能把所需的内容从原有日志中分离,形成单独的日志文件呢?其实只要在现有的log4j基础上稍加配置即可轻松实现这一功能。
配置好的log4j.xml 文件如下;
1 ################ levl:DEBUG < INFO< WARN< ERROR<FATAL ; OFF/ ALL 2 log4j.rootLogger = CONSOLE , logFile ,INFO , ERROR ,FATAL , WARN 3 4 # Set hibernate's log level to Info begin 5 log4j.logger.org.hibernate=WARN 6 # log4j.logger.net.sf.hibernate=INFO 7 log4j.logger.net.sf=WARN 8 # Set hibernate's log level to Info end 9 log4j.logger.org.jbpm=WARN 10 log4j.logger.org.quartz=WARN 11 12 13 log4j.logger.org.hibernate.SQL=INFO 14 log4j.logger.org.apache.commons.beanutils.ConvertUtils=INFO 15 log4j.additivity.org.apache.commons.beanutils.ConvertUtils=false 16 17 log4j.logger.org.apache.commons.beanutils.BeanUtils=INFO 18 log4j.additivity.org.apache.commons.beanutils.BeanUtils=false 19 20 log4j.logger.org.apache = WARN 21 #log4j.logger.org.apache.tomcat.util = INFO 22 #log4j.logger.org.apache.commons = INFO 23 #log4j.logger.org.apache.catalina = INFO 24 #log4j.additivity.org.apache.tomcat.util = false 25 #log4j.additivity.org.apache.commons = false 26 log4j.logger.org.springframework=WARN 27 # 28 29 #CONSOLE 30 #org.apache.log4j.ConsoleAppender 31 log4j.appender.CONSOLE = org.apache.log4j.ConsoleAppender 32 log4j.appender.CONSOLE.Threshold = DEBUG 33 log4j.appender.console.ImmediateFlush=true 34 #System.out 35 log4j.appender.CONSOLE.Target = System.err 36 log4j.appender.CONSOLE.layout = org.apache.log4j.PatternLayout 37 log4j.appender.CONSOLE.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} [%t] %-5p %c - %m%n 38 # 39 # \u65E5\u5FD7\u6587\u4EF6(logFile) 40 log4j.appender.logFile=org.apache.log4j.DailyRollingFileAppender 41 log4j.appender.logFile.Threshold=DEBUG 42 log4j.appender.logFile.ImmediateFlush=true 43 log4j.appender.logFile.Append=true 44 log4j.appender.logFile.File= target/pwp-log/logFile.log 45 log4j.appender.logFile.layout=org.apache.log4j.PatternLayout 46 log4j.appender.logFile.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l\: %m %x %n 47 # 48 49 #INFO 50 log4j.logger.com.alexgaoyh.util.INFO=INFO 51 log4j.appender.INFO = org.apache.log4j.DailyRollingFileAppender 52 log4j.appender.INFO.layout = org.apache.log4j.PatternLayout 53 log4j.appender.INFO.layout.ConversionPattern = "%p %d{yyyy-MM-dd HH:mm:ss} %-50.50c(%L) - %m%n 54 log4j.appender.INFO.File = target/pwp-log/INFO.log 55 log4j.appender.INFO.Append = true 56 log4j.appender.INFO.Threshold = INFO 57 58 # 59 60 #ERROR 61 log4j.appender.ERROR = org.apache.log4j.DailyRollingFileAppender 62 log4j.appender.ERROR.Threshold = ERROR 63 log4j.appender.ERROR.File = target/pwp-log/ERROR.log 64 log4j.appender.ERROR.Append = true 65 log4j.appender.ERROR.layout = org.apache.log4j.PatternLayout 66 log4j.appender.ERROR.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %5p %c:%t - %m%n 67 # 68 69 #FATAL 70 log4j.appender.FATAL = org.apache.log4j.DailyRollingFileAppender 71 log4j.appender.FATAL.File = target/pwp-log/FATAL.log 72 log4j.appender.FATAL.Append = true 73 log4j.appender.FATAL.Threshold = FATAL 74 log4j.appender.FATAL.layout = org.apache.log4j.PatternLayout 75 log4j.appender.FATAL.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %5p %c:%t - %m%n 76 # 77 78 #WARN 79 log4j.appender.WARN = org.apache.log4j.DailyRollingFileAppender 80 log4j.appender.WARN.File = target/pwp-log/WARN.log 81 log4j.appender.WARN.Append = true 82 log4j.appender.WARN.Threshold = WARN 83 log4j.appender.WARN.layout = org.apache.log4j.PatternLayout 84 log4j.appender.WARN.layout.ConversionPattern = %d{yyyy-MM-dd HH:mm:ss} %5p %c:%t - %m%n 85 # 86 87 88 89 90 91 92
学问:纸上得来终觉浅,绝知此事要躬行
为事:工欲善其事,必先利其器。
态度:道阻且长,行则将至;行而不辍,未来可期
.....................................................................
------- 桃之夭夭,灼灼其华。之子于归,宜其室家。 ---------------
------- 桃之夭夭,有蕡其实。之子于归,宜其家室。 ---------------
------- 桃之夭夭,其叶蓁蓁。之子于归,宜其家人。 ---------------
=====================================================================
* 博客文章部分截图及内容来自于学习的书本及相应培训课程以及网络其他博客,仅做学习讨论之用,不做商业用途。
* 如有侵权,马上联系我,我立马删除对应链接。 * @author Alan -liu * @Email no008@foxmail.com
转载请标注出处! ✧*꧁一品堂.技术学习笔记꧂*✧. ---> https://www.cnblogs.com/ios9/