Log4j配置详解
原文:http://sharep.blog.51cto.com/539048/143734/
版本:log4j-1.2.16
来源:http://www.cnblogs.com/snidget/archive/2012/05/22/2513824.html
前段时间的那个服务器部署项目有个要求,要输出部署的结果,在中控端可以方便的查看,以方便控制和调试,找时间看了看日志管理源包,记录一下。
1,用途
日志记录输出管理工具,通过配置文件可以灵活的控制,比如说输出的对象,样式,级别等。
2,配置文件的写法
首先配置文件可以使用属性文件(*.properties)和xml文件(*.xml),下面对基本元素的意义和使用做下记录。
2.1配置根级别的logger
log4j.rootLogger=[level],AppenderName
level:日志的级别,可以是OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL;
AppenderName:日志的输出的目的地,这里只是名字,说明要把日志放到几个地方,具体的属性分别定义
2.2配置日志的输出目的地
log4j.appender.AppenderName=value
value:输出的目的地,可以是org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
2.3配置日志的格式
log4j.appender.AppenderName.layout=value
value:日志的格式,可以是org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
2.4配置日志的条目格式
log4j.appender.E.layout.ConversionPattern=value
value:具体日志条目的格式,可以是以下项目的组合
%p输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r输出自应用启动到输出该log信息耗费的毫秒数
%c输出所属的类目,通常就是所在类的全名
%t输出产生该日志事件的线程名
%n输出一个回车换行符,Windows平台为“\r\n”,Unix平台为“\n”
%d输出日志时间点的日期或时间,默认格式为ISO8601,
%l输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。
2.5详细的例子
log4j.properties
3,使用要注意的地方
3.1使用的步骤是,首先读取配置文件,然后得到日志记录器,最后是使用记录器进行记录。
3.2读取配置文件的方式
主要有三种:BasicConfigurator.configure():自动快速地使用缺省Log4j环境。
PropertyConfigurator.configure(StringconfigFilename):读取使用Java的特性文件编写的配置文件。
DOMConfigurator.configure(Stringfilename):读取XML形式的配置文件。
注意fileName可以是绝对路径也可以是相对路径。
4,使用举例
这里我主要研究了一下Example中的例子,通过看代码,记下一些对代码的理解。
4.1一个最简单的例子,(引入了log4j.jar,配置文件放在应用程序路径下)
Trivaial中日志的使用
这里主要注意有个NDC静态类,它好像一个栈,push一个项目进去,就在日志的条目中增加一个,要是push多个,就在日志条目中的某个位置增加多个,pop是移除最后push的那条数据,其它的方法相当于对栈的相应操作。
输出结果是:
run:
0[main]INFOcom.lifc.log4j.example.TrivialClient#45890-Awakeawake.Putonthystrength.
0[main]DEBUGcom.lifc.log4j.example.TrivialClient#45890DB-NowkingDavidwasold.
0[main]INFOcom.lifc.log4j.example.Trivial$InnerTrivial-Enteredfoo.
0[main]INFOcom.lifc.log4j.example.Trivial-ExitingTrivial.
成功生成(总时间:1秒)
还有几个比较复杂的例子,比如说自定义pattern和layout,自定义Logger等以及把日志输出到网络套接字中,时间有限,这里就不记录了,有兴趣的可以去就看看例子。
nopays,nogains!
版本:log4j-1.2.8
log4j配置祥解
第一步:加入log4j-1.2.8.jar到lib下。
第二步:在CLASSPATH下建立log4j.properties。内容如下:
1log4j.rootCategory=INFO,stdout,R
2
3log4j.appender.stdout=org.apache.log4j.ConsoleAppender
4log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
5log4j.appender.stdout.layout.ConversionPattern=[QC]%p[%t]%C.%M(%L)|%m%n
6
7log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
8log4j.appender.R.File=D:\Tomcat5.5\logs\qc.log
9log4j.appender.R.layout=org.apache.log4j.PatternLayout
10log4j.appender.R.layout.ConversionPattern=%d-[TS]%p%t%c-%m%n
11
12log4j.logger.com.neusoft=DEBUG
13log4j.logger.com.opensymphony.oscache=ERROR
14log4j.logger.net.sf.navigator=ERROR
15log4j.logger.org.apache.commons=ERROR
16log4j.logger.org.apache.struts=WARN
17log4j.logger.org.displaytag=ERROR
18log4j.logger.org.springframework=DEBUG
19log4j.logger.com.ibatis.db=WARN
20log4j.logger.org.apache.velocity=FATAL
21
22log4j.logger.com.canoo.webtest=WARN
23
24log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
25log4j.logger.org.hibernate=DEBUG
26log4j.logger.org.logicalcobwebs=WARN
第三步:相应的修改其中属性,修改之前就必须知道这些都是干什么的,在第二部分讲解。
第四步:在要输出日志的类中加入相关语句:
定义属性:protectedfinalLoglog=LogFactory.getLog(getClass());
在相应的方法中:
if(log.isDebugEnabled())
{
log.debug(“System…..”);
}
二、Log4j说明
1log4j.rootCategory=INFO,stdout,R
此句为将等级为INFO的日志信息输出到stdout和R这两个目的地,stdout和R的定义在下面的代码,可以任意起名。等级可分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL,如果配置OFF则不打出任何信息,如果配置为INFO这样只显示INFO,WARN,ERROR的log信息,而DEBUG信息不会被显示,具体讲解可参照第三部分定义配置文件中的logger。
3log4j.appender.stdout=org.apache.log4j.ConsoleAppender
此句为定义名为stdout的输出端是哪种类型,可以是
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
具体讲解可参照第三部分定义配置文件中的Appender。
4log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
此句为定义名为stdout的输出端的layout是哪种类型,可以是
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
具体讲解可参照第三部分定义配置文件中的Layout。
5log4j.appender.stdout.layout.ConversionPattern=[QC]%p[%t]%C.%M(%L)|%m%n
如果使用pattern布局就要指定的打印信息的具体格式ConversionPattern,打印参数如下:
%m输出代码中指定的消息
%p输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r输出自应用启动到输出该log信息耗费的毫秒数
%c输出所属的类目,通常就是所在类的全名
%t输出产生该日志事件的线程名
%n输出一个回车换行符,Windows平台为“rn”,Unix平台为“n”
%d输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyyMMMddHH:mm:ss,SSS},输出类似:2002年10月18日22:10:28,921
%l输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。
[QC]是log信息的开头,可以为任意字符,一般为项目简称。
输出的信息
[TS]DEBUG[main]AbstractBeanFactory.getBean(189)|Returningcachedinstanceofsingletonbean'MyAutoProxy'
具体讲解可参照第三部分定义配置文件中的格式化日志信息。
7log4j.appender.R=org.apache.log4j.DailyRollingFileAppender
此句与第3行一样。定义名为R的输出端的类型为每天产生一个日志文件。
8log4j.appender.R.File=D:\Tomcat5.5\logs\qc.log
此句为定义名为R的输出端的文件名为D:\Tomcat5.5\logs\qc.log
可以自行修改。
9log4j.appender.R.layout=org.apache.log4j.PatternLayout
与第4行相同。
10log4j.appender.R.layout.ConversionPattern=%d-[TS]%p%t%c-%m%n
与第5行相同。
12log4j.logger.com.neusoft=DEBUG
指定com.neusoft包下的所有类的等级为DEBUG。
可以把com.neusoft改为自己项目所用的包名。
13log4j.logger.com.opensymphony.oscache=ERROR
14log4j.logger.net.sf.navigator=ERROR
这两句是把这两个包下出现的错误的等级设为ERROR,如果项目中没有配置EHCache,则不需要这两句。
15log4j.logger.org.apache.commons=ERROR
16log4j.logger.org.apache.struts=WARN
这两句是struts的包。
17log4j.logger.org.displaytag=ERROR
这句是displaytag的包。(QC问题列表页面所用)
18log4j.logger.org.springframework=DEBUG
此句为Spring的包。
24log4j.logger.org.hibernate.ps.PreparedStatementCache=WARN
25log4j.logger.org.hibernate=DEBUG
此两句是hibernate的包。
以上这些包的设置可根据项目的实际情况而自行定制。
三、log4j详解
1、定义配置文件
Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件log4j.properties(键=值)。下面将介绍使用log4j.properties文件作为配置文件的方法:
①、配置根Logger
Logger负责处理日志记录的大部分操作。
其语法为:
log4j.rootLogger=[level],appenderName,appenderName,…
其中,level是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。通过在这里定义的级别,您可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,只有等于及高于这个级别的才进行处理,则应用程序中所有DEBUG级别的日志信息将不被打印出来。ALL:打印所有的日志,OFF:关闭所有的日志输出。appenderName就是指定日志信息输出到哪个地方。可同时指定多个输出目的地。
②、配置日志信息输出目的地Appender
Appender负责控制日志记录操作的输出。
其语法为:
log4j.appender.appenderName=fully.qualified.name.of.appender.class
log4j.appender.appenderName.option1=value1
…
log4j.appender.appenderName.optionN=valueN
这里的appenderName为在①里定义的,可任意起名。
其中,Log4j提供的appender有以下几种:
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件),可通过log4j.appender.R.MaxFileSize=100KB设置文件大小,还可通过log4j.appender.R.MaxBackupIndex=1设置为保存一个备份文件。
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
例如:log4j.appender.stdout=org.apache.log4j.ConsoleAppender
定义一个名为stdout的输出目的地,ConsoleAppender为控制台。
③、配置日志信息的格式(布局)Layout
Layout负责格式化Appender的输出。
其语法为:
log4j.appender.appenderName.layout=fully.qualified.name.of.layout.class
log4j.appender.appenderName.layout.option1=value1
…
log4j.appender.appenderName.layout.optionN=valueN
其中,Log4j提供的layout有以下几种:
org.apache.log4j.HTMLLayout(以HTML表格形式布局),
org.apache.log4j.PatternLayout(可以灵活地指定布局模式),
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串),
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
2、格式化日志信息
Log4J采用类似C语言中的printf函数的打印格式格式化日志信息,打印参数如下:
%m输出代码中指定的消息
%p输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL
%r输出自应用启动到输出该log信息耗费的毫秒数
%c输出所属的类目,通常就是所在类的全名
%t输出产生该日志事件的线程名
%n输出一个回车换行符,Windows平台为“rn”,Unix平台为“n”
%d输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyyMMMddHH:mm:ss,SSS},输出类似:2002年10月18日22:10:28,921
%l输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。
3、在代码中使用Log4j
我们在需要输出日志信息的类中做如下的三个工作:
1、导入所有需的commongs-logging类:
importorg.apache.commons.logging.Log;
importorg.apache.commons.logging.LogFactory;
2、在自己的类中定义一个org.apache.commons.logging.Log类的私有静态类成员:
privatefinalLoglog=LogFactory.getLog(getClass());
LogFactory.getLog()方法的参数使用的是当前类的class。
3、使用org.apache.commons.logging.Log类的成员方法输出日志信息:
if(log.isDebugEnabled())
{
log.debug("111");
}
if(log.isInfoEnabled())
{
log.info("222");
}
if(log.isWarnEnabled())
{
log.warn("333");
}
if(log.isErrorEnabled())
{
log.error("444");
}
if(log.isFatalEnabled())
{
log.fatal("555")
}