Log4j配置文件以及配置方法

Log4J的配置文件(Configuration File)就是用来设置记录器的级别、存放器和布局的，它可接key=value格式的设置或xml格式的设置信息。通过配置，可以创建出Log4J的运行环境。Log4j的配置文件是一个叫做Log4j.properties的文件。

log4j.properties文件：

#newhappy  log4j.properties start

log4j.rootLogger=DEBUG,myConsole,myLogFile
#console appender
log4j.appender.myConsole=org.apache.log4j.ConsoleAppender
log4j.appender.myConsole.layout=org.apache.log4j.PatternLayout
log4j.appender.myConsole.layout.ConversionPattern=%5p [%t] (%F:%L) -%m%n
log4j.appender.myConsole.threshold=FATAL
#rolling file appender
log4j.appender.myLogFile=org.apache.log4j.RollingFileAppender
log4j.appender.myLogFile.File=mylog.log
log4j.appender.myLogFile.MaxFileSize=100KB
log4j.appender.myLogFile.MaxBackupIndex=2
log4j.appender.myLogFile.layout=org.apache.log4j.PatternLayout
log4j.appender.myLogFile.layout.ConversionPattern=%d{mmm d,yyyy hh:mm:ss a} : %p [%t] %m%n
log4j.appender.myLogFile.threshold=ERROR

#newhappy log4j.properties end

1. 配置文件
Log4J配置文件的基本格式如下：
 #配置根Logger
log4j.rootLogger  =   [ level ]   ,  appenderName1 ,  appenderName2 ,  …

#配置日志信息输出目的地Appender
log4j.appender.appenderName  =  fully.qualified.name.of.appender.class
　　log4j.appender.appenderName.option1  =  value1
　　…
　　log4j.appender.appenderName.optionN  =  valueN

#配置日志信息的格式（布局）
log4j.appender.appenderName.layout  =  fully.qualified.name.of.layout.class
　　log4j.appender.appenderName.layout.option1  =  value1
　　…
　　log4j.appender.appenderName.layout.optionN  =  valueN 

其中 [level] 是日志输出级别，共有5级：

 

 FATAL      0 
ERROR      3 
WARN       4 
INFO       6 
DEBUG      7
 

Appender 为日志输出目的地，Log4j提供的appender有以下几种：

 

 org.apache.log4j.ConsoleAppender（控制台），
org.apache.log4j.FileAppender（文件），
org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）

Layout：日志输出格式，Log4j提供的layout有以下几种：

 

 org.apache.log4j.HTMLLayout（以HTML表格形式布局），
org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

打印参数: Log4J采用类似C语言中的printf函数的打印格式格式化日志信息，如下:

 

 　 %m 输出代码中指定的消息
　　%p   输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL
　　%r   输出自应用启动到输出该log信息耗费的毫秒数
　　%c   输出所属的类目，通常就是所在类的全名
　　%t   输出产生该日志事件的线程名
　　%n   输出一个回车换行符，Windows平台为“/r/n”，Unix平台为“/n”
　　%d   输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss , SSS}，输出类似：2002年10月18日  22 ： 10 ： 28 ， 921 
　　%l   输出日志事件的发生位置，包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main(TestLog4.java: 10 ) 

2. 在代码中初始化Logger:
1）在程序中调用BasicConfigurator.configure()方法：给根记录器增加一个ConsoleAppender，输出格式通过PatternLayout设为"%-4r [%t] %-5p %c %x - %m%n"，还有根记录器的默认级别是Level.DEBUG.
2）配置放在文件里，通过命令行参数传递文件名字，通过PropertyConfigurator.configure(args[x])解析并配置；
3）配置放在文件里，通过环境变量传递文件名等信息，利用log4j默认的初始化过程解析并配置；
4）配置放在文件里，通过应用服务器配置传递文件名等信息，利用一个特殊的servlet来完成配置。

3. 为不同的 Appender 设置日志输出级别：
当调试系统时，我们往往注意的只是异常级别的日志输出，但是通常所有级别的输出都是放在一个文件里的，如果日志输出的级别是BUG！？那就慢慢去找吧。
这时我们也许会想要是能把异常信息单独输出到一个文件里该多好啊。当然可以，Log4j已经提供了这样的功能，我们只需要在配置中修改Appender的Threshold 就能实现,比如下面的例子：

[配置文件]

 

 ### set log levels ###
log4j.rootLogger = debug ,  stdout ,  D ,  E

### 输出到控制台 ###
log4j.appender.stdout = org.apache.log4j.ConsoleAppender
log4j.appender.stdout.Target = System.out
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.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.D = org.apache.log4j.DailyRollingFileAppender

  log4j.appender.D.File = logs/error.log ## 异常日志文件名
log4j.appender.D.Append = true
log4j.appender.D.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

[代码中使用]

 

  public   class  TestLog4j   {
     public   static   void  main(String[] args)   {
        PropertyConfigurator.configure( " D:/Code/conf/log4j.properties " );
        Logger logger  =  Logger.getLogger(TestLog4j. class );
        logger.debug( " debug " );
        logger.error( " error " );
    }
}

运行一下，看看异常信息是不是保存在了一个单独的文件error.log中。

4、对不同的包设置不同输出信息级别
eg：
打印OppenSessionInViewFilter中debug级别信息方法：
log4j.logger.org.springframework.orm.hibernate3.support.OpenSessionInViewFilter=debug
打印Struts标签中warn级别信息的方法：
log4j.logger.org.apache.struts.util=WARN

原理：
 Suppose   we   are   no   longer   interested   in   seeing   the   output   of   any   component   belonging   to   the   com.foo   package.   The   following   configuration   file   shows   one   possible   way   of   achieving   this.    
   
  log4j.rootLogger=DEBUG,   A1  
  log4j.appender.A1=org.apache.log4j.ConsoleAppender  
  log4j.appender.A1.layout=org.apache.log4j.PatternLayout  
   
  #   Print   the   date   in   ISO   8601   format  
  log4j.appender.A1.layout.ConversionPattern=%d   [%t]   %-5p   %c   -   %m%n  
   
  #   Print   only   messages   of   level   WARN   or   above   in   the   package   com.foo.  
  log4j.logger.com.foo=WARN

 

 

 

第二种思路

 

配置过程：
 1) 加载 log4j-1.2.9.jar
 2) 在根路径配置log4j.properties，参照下面的log4j配置代码
 3) 在需要记录日志的java文件、jsp或servlet中添加下面的记录日志代码

其他：
-----------
 1. Log4j.jar下载地址：http://www.apache.org/dist/jakarta/log4j/jakarta-log4j-1.2.8.zip
 2. log4e.jar下载地址：http://log4e.jayefem.de/index.php/Download
说明：log4e为Eclipse的log4j插件，放入插件文件夹后重起Eclipse，程序里右键即可看到Log4E选项。

 
log4j.properties
================
log4j.rootLogger=debug, A1 ,R
#RollingFileAppender
log4j.appender.A1=org.apache.log4j.RollingFileAppender
log4j.appender.A1.File=c:sys.log
log4j.appender.A1.MaxFileSize=100KB
log4j.appender.A1.MaxBackupIndex=1
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-d...{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
#backup
log4j.appender.R=org.apache.log4j.RollingFileAppender
log4j.appender.R.File=log4j.log
log4j.appender.R.MaxFileSize=100KB
log4j.appender.R.MaxBackupIndex=1
log4j.appender.R.layout=org.apache.log4j.TTCCLayout

#ConsoleAppender
log4j.appender.B1=org.apache.log4j.ConsoleAppender
log4j.appender.B1.layout=org.apache.log4j.PatternLayout
log4j.appender.B1.layout.ConversionPattern=%-4r %-5p [%t] %37c %3x - %m%n
log4j.appender.B1.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n

MyLogTest.java
================
import java.util.Locale;
import java.util.ResourceBundle;
import org.apache.log4j.*;

public class MyLogTest ...{
    static Logger logger = Logger.getLogger(MyLogTest.class.getName());
 
    public static void main(String[] args) ...{
     logger.setResourceBundle(ResourceBundle.getBundle("Log4j", Locale.SIMPLIFIED_CHINESE));       MyLogTest.logger.info("测试信息开始 ");
 MyLogTest.logger.info("测试信息结束 ");
        try...{
         Integer.parseInt("a");
        }catch(Exception e)...{
         logger.error(e);
        }
    }
}

 

 

 

资料：

===========

log4j.properties文件例子

1.==================
这个文件就是本文的重点，也就是log4j的配置文件。

# Set root logger level to DEBUG and its only appender to A1
#log4j中有五级logger
#FATAL 0
#ERROR 3
#WARN 4
#INFO 6
#DEBUG 7
#配置根Logger，其语法为：
#log4j.rootLogger = [ level ] , appenderName, appenderName, …
log4j.rootLogger=INFO, A1 ,R
#这一句设置以为着所有的log都输出
#如果为log4j.rootLogger=WARN, 则意味着只有WARN,ERROR,FATAL
#被输出，DEBUG,INFO将被屏蔽掉.
# A1 is set to be a ConsoleAppender.
#log4j中Appender有几层如控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等
#ConsoleAppender输出到控制台
log4j.appender.A1=org.apache.log4j.ConsoleAppender
# A1 使用的输出布局，其中log4j提供4种布局. org.apache.log4j.HTMLLayout（以HTML表格形式布局）
#org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
#org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
#org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）

log4j.appender.A1.layout=org.apache.log4j.PatternLayout
#灵活定义输出格式 具体查看log4j javadoc org.apache.log4j.PatternLayout
#d 时间 ....
log4j.appender.A1.layout.ConversionPattern=%-d...{yyyy-MM-dd HH:mm:ss} [%c]-[%p] %m%n
#R 输出到文件 RollingFileAppender的扩展，可以提供一种日志的备份功能。
log4j.appender.R=org.apache.log4j.RollingFileAppender
#日志文件的名称
log4j.appender.R.File=log4j.log
#日志文件的大小
log4j.appender.R.MaxFileSize=100KB
# 保存一个备份文件
log4j.appender.R.MaxBackupIndex=1

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

2.=========
下面我给出一个在weblogic下使用log4j的配置过程，首先给出这个配置文件的完整信息。

#log4j.rootLogger=INFO,A1,R //这一句指定了日志输出的级别为info,A1和R分别代表日志输出到什么地方。
log4j.category.hybl_wshabcm=debug,A1,R //这一句指定了日志具体输出哪个包的信息，以及输出位置
log4j.appender.A1=org.apache.log4j.ConsoleAppender //这里指定了日志输出的第一个位置A1是控制台ConsoleAppender
/**//*
*其中，Log4j提供的appender有以下几种：
*org.apache.log4j.ConsoleAppender（控制台），
*org.apache.log4j.FileAppender（文件），
*org.apache.log4j.DailyRollingFileAppender（每天产生一个日志文件），
*org.apache.log4j.RollingFileAppender（文件大小到达指定尺寸的时候产生一个新的文件），
*org.apache.log4j.WriterAppender（将日志信息以流格式发送到任意指定的地方）
*
*/
log4j.appender.A1.layout=org.apache.log4j.PatternLayout //指定A1的布局模式

/**//*
*其中，Log4j提供的layout有以下几种：
×org.apache.log4j.HTMLLayout（以HTML表格形式布局），
*org.apache.log4j.PatternLayout（可以灵活地指定布局模式），
*org.apache.log4j.SimpleLayout（包含日志信息的级别和信息字符串），
*org.apache.log4j.TTCCLayout（包含日志产生的时间、线程、类别等等信息）
*/
log4j.appender.A1.layout.ConversionPattern=%-d...{yyyy-MM-dd HH:mm:ss,SSS} [%c]-[%p] %m%n //指定日志的输出格式

log4j.appender.R=org.apache.log4j.RollingFileAppender //指定以文件的方式输出日志
log4j.appender.R.File=c:/sys.html //文件位置
log4j.appender.R.MaxFileSize=500KB //文件最大尺寸
log4j.appender.R.MaxBackupIndex=1 //备份数
log4j.appender.R.layout=org.apache.log4j.HTMLLayout //文件的格式为Html格式
#log4j.appender.R.layout=org.apache.log4j.PatternLayout
log4j.appender.R.layout.ConversionPattern=%d...{yyyy-MM-dd HH:mm:ss,SSS} [%t] [%c] [%p] - %m%n