log4j配置

Log4j配置

应用程序部署到生产环境后，日志记录非常重要。

一旦程序抛出异常，应当记录出错信息，便于排查。

日志记录因此非常重要，对于开发人员而言，要尽快解决问题就得靠日志来追踪问题。

 

配置文件

 

#配置根root

#指定日志输出级别(默认为DEBUG)

#指定日志输出的appender，每个appender可以定制不同的输出目的地和输出格式

log4j.rootLogger=[level],appenderName1, appenderName2, ....

 

#配置每个appender的具体类型

log4j.appender.appenderName1=appenderType

 

#即指定appenderName1的日志输出到哪里

log4j.appender.appenderName1.option1=value1

 

#配置日志输出格式(布局)

log4j.appender.appenderName1.layout.option=value1

 

 

 

[level]表示日志输出级别

即发生哪个级别以上的事件时才log4j才对其进行记录

FATAL     0

ERROR   3

WARN     4

INFO       6

DEBUG   7    default

 

 

Appender为日志输出目的地

log4j提供了几种日志输出目的地的配置

org.apache.log4j.ConsoleAppender     往控制台打印日志

org.apache.log4j.FileAppender             输出到文件

org.apache.log4j.DailyRollingFileAppender    输出到文件，并且每天生产一个日志文件

org.apache.log4j.RollingFileAppender            输出到文件，文件大小达到指定size时生成新的文件

org.apache.log4j.WriterAppender                   以流的方式输出日志到任何指定的地方，如发邮件

 

Layout指定日志输出样式

log4j提供了几种日志布局的方案

org.apache.log4j.HTMLLayout     html表格形式的布局，可以通过浏览器远程查看日志

org.apache.log4j.SimpleLayout    简单布局

org.apache.log4j.TTCCLayout     

org.apache.log4j.PatternLayout   自定义布局

 

Layout布局参数

%m  输出代码中指定的消息 

%p   输出日志级别，即DEBUG,INFO,WARN,ERROR,FATAL

%r    输出自应用启动到输出该日志的毫秒数

%c   输出所属的类路径全名

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

%n   输出一个回车换行符

%d   输出日志日期/时间，默认格式为外国人的格式。

基本上都需要指定为中国人看的格式

如：%d{yyyy-MM-dd HH:mm:ss}      显示： 2013-09-09 11:46:32

%l    输出事件发生的具体位置，包括类名，线程，在代码中的行数

 

 

指定日志输出的门槛--->Threshold

当调试系统时，关心的一般都是error级别的日志输出，如果日志输出级别是DEBUG，那找起来可就费劲了！log4j提供了一个功能，可以指定将某个级别的日志信息单独输出到一个文件中保存。

在配置中指定Appender的Threshold.

 

几种配置示例 

### 设置root和Appender###
log4j.rootLogger = debug ,  stdout ,  A ,  B

### 配置stdout Appender，输出到控制台，并指定输出样式###
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:%L - %m%n

### 配置A Appender，输出到文件logs/log.log中，追加，记录DEBUG级别以上的所有日志，并指定输出样式###
log4j.appender.A = org.apache.log4j.DailyRollingFileAppender
log4j.appender.A.File = logs/log.log
log4j.appender.A.Append = true
log4j.appender.A.Threshold = DEBUG
log4j.appender.A.layout = org.apache.log4j.PatternLayout
log4j.appender.A.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n

### 配置B Appender，输出到文件logs/error.log中，追加，只记录ERROR级别以上的日志，并指定输出样式 ###
log4j.appender.B = org.apache.log4j.DailyRollingFileAppender
log4j.appender.B.File = logs/error.log
log4j.appender.B.Append = true
log4j.appender.B.Threshold = ERROR
log4j.appender.B.layout = org.apache.log4j.PatternLayout
log4j.appender.B.layout.ConversionPattern = %-d{yyyy-MM-dd HH:mm:ss}  [ %t:%r ] - [ %p ]  %m%n 

 

 

 

 测试

基于以上配置，进行测试

import org.apache.log4j.Logger;


public class LogTest{
	public static void main(String[] args) {
		Logger logger = Logger.getLogger(LogTest.class);
		try{
			//debug级别，将记录到logs/log.log文件中
			logger.debug("log start");
			int j = 10/0;
		} catch(Exception e) {
			//错误信息将被记录到logs/log.log中
			//而且，日志级别为ERROR，所以会单独记录到logs/error.log中
			logger.error(e.getMessage(), e);
		}
	}
}

 运行，如果没有logs文件夹，log4j会自动创建该目录

 查看logs文件夹下的文件

log.log  记录DEBUG级别以上的日志，即所有日志信息都在这个文件中

2013-09-08 12:05:42  [ main:0 ] - [ DEBUG ]  log start
2013-09-08 12:05:42  [ main:0 ] - [ ERROR ]  / by zero
java.lang.ArithmeticException: / by zero
	at LogTest.main(LogTest.java:9)

 

error.log 只记录ERROR级别以上的日志

2013-09-08 12:05:42  [ main:0 ] - [ ERROR ]  / by zero
 java.lang.ArithmeticException: / by zero
	at LogTest.main(LogTest.java:9)

 

 

 

 

详细配置手册

 

控制台选项

 

Threshold=DEBUG:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
Target=System.err：默认情况下是：System.out,指定输出控制台

 

 

FileAppender 选项

 

Threshold=DEBUF:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。

 

 

RollingFileAppender 选项

 

Threshold=DEBUG:指定日志消息的输出最低层次。
ImmediateFlush=true:默认值是true,意谓着所有的消息都会被立即输出。
File=mylog.txt:指定消息输出到mylog.txt文件。
Append=false:默认值是true,即将消息增加到指定文件中，false指将消息覆盖指定的文件内容。
MaxFileSize=100KB: 后缀可以是KB, MB 或者是 GB. 在日志文件到达该大小时，将会自动滚动，即将原来的内容移到mylog.log.1文件。
MaxBackupIndex=2:指定可以产生的滚动文件的最大数。

 

 

日志信息格式中的符号

log4j.appender.A1.layout.ConversionPattern=%-4r %-5p %d{yyyy-MM-dd HH:mm:ssS} %c %m%n

 

%p: 输出日志信息优先级，即DEBUG，INFO，WARN，ERROR，FATAL,
%d: 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d{yyy MMM dd HH:mm:ss,SSS}，输出类似：2002年10月18日 22：10：28，921
%r: 输出自应用启动到输出该log信息耗费的毫秒数
%c: 输出日志信息所属的类目，通常就是所在类的全名
%t: 输出产生该日志事件的线程名
%l: 输出日志事件的发生位置，相当于%C.%M(%F:%L)的组合,包括类目名、发生的线程，以及在代码中的行数。举例：Testlog4.main (TestLog4.java:10)
%x: 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%%: 输出一个"%"字符
%F: 输出日志消息产生时所在的文件名称
%L: 输出代码中的行号
%m: 输出代码中指定的消息,产生的日志具体信息
%n: 输出一个回车换行符，Windows平台为"/r/n"，Unix平台为"/n"输出日志信息换行

可以在%与模式字符之间加上修饰符来控制其最小宽度、最大宽度、和文本的对齐方式。如：
  1)%20c：指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，默认的情况下右对齐。
  2)%-20c:指定输出category的名称，最小的宽度是20，如果category的名称小于20的话，"-"号指定左对齐。
  3)%.30c:指定输出category的名称，最大的宽度是30，如果category的名称大于30的话，就会将左边多出的字符截掉，但小于30的话也不会有空格。
  4)%20.30c:如果category的名称小于20就补空格，并且右对齐，如果其名称长于30字符，就从左边较远输出的字符截掉。