2008-06-24

Log4j 配置调查

概 要:

Apache的开源项目Log4j是一个功能强大的日志组件,Log4j 就是log for java 。本文档主要介绍了它的日志配置和级别等的说明。Log4j支持两种配置文件格式,一种是XML格式的文件,一种是Java特性文件(键=值),我们这里使用的是Java特性文件。

调 查:

1.Logger 级别配置

首先 配置根Logger说明日志记录的优先级。分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别。Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。



在Log4j.properties文件中配置根Logger,其语法为:
log4j.rootLogger = [ level ] , appenderName, appenderName2

appenderName :就是指定日志信息输出目的地,比如(打印到控制台(console),输出到文件等)。同一条日志信息可以配置多个输出目的地。

选择的level级别分别对应Logger类的四种方法
debug(Object message ) ;
info(Object message ) ;
warn(Object message ) ;
error(Object message ) ;

日志分级的原因:为了调试程序,会在很多会出错的地方加入大量的logger.info();信息。当然程序调试完毕,我们不需要这些输出信息了。可以根据log4j分级别的原因,当我们不需要输出这样调试时用到的log.info()时,我们可以把输出的级别调高,如调到warn,或error级别,这样info级别及以下的级别就不会出输出了。

这也是文件Log4j.properties 选择info的原因。就是为了避免过多的日志的输出,但某些时候需要跟踪具体问题,那么就得打开DEBUG日志。
但是如果打开log4j.rootLogger,则需要的信息就会淹没在日志的海洋中。
此时,需要单独指定某个或者某些Logger的日志级别为DEBUG,而rootLogger保持INFO不变。

2. Appenders日志目的地
在Log4j.properties文件中 :log4j.appender.console=org.apache.log4j.ConsoleAppender

Log4j提供以下几种可选择的目的地:
org.apache.log4j.ConsoleAppender(控制台)

每个ConsoleAppender都有一个target,表示它的输出目的地。它可以是System.out,标准输出设备(缓冲显示屏);或者是System.err,标准错误设备(不缓冲显示屏)

org.apache.log4j.FileAppender(文件)

可以使用FileAppender对象把日志输出到一个指定的日志文件中去。
org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)

可以使用FileAppender的子类RollingFileAppender对象,把日志输出到一个指定的日志文件中。不同的是该日志文件的大小受到限制,当日志内容超出最大的尺寸时,该文件将向上滚动(最老的日志被擦除)。还可以在该类对象中指定为日志文件做多少个备份。
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)

3. log信息的格式
在Log4j.properties文件中:

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

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

Log4j提供的layout有以下几种:

org.apache.log4j.HTMLLayout(HTML表格形式)
org.apache.log4j.SimpleLayout(简单格式的日志,只包括日志信息的级别和指定的信息字符串 ,如:DEBUG - Hello)
org.apache.log4j.TTCCLayout(日志的格式包括日志产生的时间、线程、类别等等信息)
org.apache.log4j.PatternLayout(灵活地自定义日志格式):

参数:
-X号: X信息输出时左对齐;
%m 输出代码中指定的消息

%p 输出优先级,即DEBUG,INFO,WARN,ERROR,FATAL

%r 输出自应用启动到输出该log信息耗费的毫秒数

%c 输出所属的类目,通常就是所在类的全名

%t 输出产生该日志事件的线程名

%n 输出一个回车换行符,Windows平台为“rn”,Unix平台为“n”

%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,比如:%d{yyyy MMM dd HH:mm:ss,SSS},输出类似:2002年10月18日 22:10:28,921

%l 输出日志事件的发生位置,包括类目名、发生的线程,以及在代码中的行数。


ok 上面就是Log4j.properties的基本配置,最后在程序中想要输出log的地方加入log4j的支持

(1)引入 import org.apache.log4j.Logger

(2)声明一个logger

private static Logger logger = Logger.getLogger(ClassName.class);

(3)在程序中的相应位置加入输出信息

logger.info();
评论