log4j使用心得之一 -- 自定义日志级别并分不同文件存储

我们组由.NET切换到JAVA,现有代码都需要重构,遇到的第一个问题就是缺少一个公共基础类库,网上找的或是其他找来的代码,往往不能很好的适应公司的需求,迫切的需要一个JAVA版本的公共基础类库,适应大伙现有的开发习惯,开发风格. 而开发这样的基础类库,是我最喜欢干的事情.

我们原有的日志规范是,有两个日志级别,根据需要记录不同的内容,每个日志级别对应一个文件.每个日志级别每天归档一个日志文件.两个日志级别分别是:

Access Log:记录访问信息,关键信息输出,api调用结果等

Error Log:记录需要关注的问题,抛出的异常,错误等.

转成java后,记录log的方法首选的是log4j, 为了不改变原有的日志规范,做了如下定制

1 自定义log4j日志级别

log4j原本有5个日志级别,按级别从低到高一次是DEBUG < INFO < WARN < ERROR < FATAL.

一开始的时候,我想利用这几个日志级别,但很快发现了一些问题.

首先,程序使用的一些框架,类库等会将本身输出的信息或是错误等输出到上面几个日志级别中, 比如遇到错误时,会输出信息到ERROR或FATAL级别的log中,这基本还是满足我们需求的, 但往往还会将一些调试信息等输出到DEBUG或INFO级别中,造成输出的log文件内容较多,较乱,大伙刚刚上手就会看到log文件里记录了很多没见过的东西,肯定觉得很茫然.

了解到log4j可以自定义日志级别,那么接下来,工作开始了.

我们考虑到平时工作中遇到的问题,加上一定的扩展性需要,定义了4个日志级别:

Access Log: 记录关键信息,api调用输入,输出等
Monitor Log:记录数据库访问,api调用的耗时,后期会有其他作业来分析
Work Log:记录作业的开始和结果或API的输入和输出
Error Log:记录错误和异常

Error Log可以直接使用log4j的ERROR级别,由于log4j默认会把级别大于等于该级别的日志都输出到这个级别对应的日志文件中,所以日志中能够记录ERROR和FATAL级别的log,而另外3个级别的log,为了不让类库和框架的调试信息干扰我们,就需要自定义log级别了.

定义一个自定义的日志级别,非常容易. 首先,我们定义Access Log 的级别,AccessLevel,继承自Level接口.

import org.apache.log4j.Level;

public class AccessLevel extends Level {
public AccessLevel(int level, String name, int sysLogLevel) {
super(level, name, sysLogLevel);
}
}

MonitorLevel,WorkLevel也类似可以定义.

接下来,查看log4j的源文件org.apache.log4j.Priority,有如下定义

public final static int FATAL_INT = 50000;
public final static int ERROR_INT = 40000;
public final static int WARN_INT  = 30000;
public final static int INFO_INT  = 20000;
public final static int DEBUG_INT = 10000;

可以看到每个级别对应一个数字,我们新增的log级别,定义在WARN和ERROR之间比较合适.我们创建一个MyLogLevel接口,对我们的自定义级别进行初始化

import org.apache.log4j.Level;
import org.apache.log4j.net.SyslogAppender;

public interface MyLogLevel {
public static final Level ACCESS_LEVEL = new AccessLevel(35000, "ACCESS", SyslogAppender.LOG_LOCAL0);
public static final Level MONITOR_LEVEL = new MonitorLevel(36000, "MONITOR", SyslogAppender.LOG_LOCAL0);
public static final Level WORK_LEVEL = new WorkLevel(34000, "WORK", SyslogAppender.LOG_LOCAL0);
}

定义好我们的自定义级别后,我们就可以尝试输出log了,我们新建了一个LogWriter类来打印log.LogWriter类首先引用了Logger

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

输出一个Error Log如下:

logger.error(msg.trim());

而其他3种log都是自定义级别,如下输出一个access log:

logger.log(MyLogLevel.ACCESS_LEVEL, msg);

2 各个级别log分文件输出

log4j默认一个级别的log会输出大于等于这个级别的所有log,比如WARN级别的log会打印出WARN,ERROR,FATAL级别的所有log,而为了让我们自定义的3个日志能分别只打印各自级别的log,我们需要做如下修改.
以Access Log为例,我们定义

public class MonitorLogAppender extends FileAppender {

@Override
public boolean isAsSevereAsThreshold(Priority priority) {
// TODO Auto-generated method stub
return MyLogLevel.MONITOR_LEVEL.equals(priority);
}
}

这里其实应该继承DailyRollingFileAppender,这里继承FileAppender是由于log文件命名的问题进行的改写,这个稍后再说.
重载isAsSevereAsThreshold函数,只有等于该日志级别,才会返回true,即只会记录当前日志级别的log

2 log4j.properties配置文件

log4j.rootLogger=,error,access,monitor,work
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.Threshold = DEBUG
log4j.appender.stdout.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} - %m%n

log4j.appender.error=com.xx.base.diagnostics.ErrorLogAppender
log4j.appender.error.layout=org.apache.log4j.PatternLayout
log4j.appender.error.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} - %m%n
log4j.appender.error.datePattern='_'yyyyMMdd'.log'
log4j.appender.error.Threshold = ERROR
log4j.appender.error.append=true
log4j.appender.error.File=${webapp.root}/log/error.log

log4j.appender.access=com.xx.base.diagnostics.AccessLogAppender
log4j.appender.access.layout=org.apache.log4j.PatternLayout
log4j.appender.access.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} - %m%n
log4j.appender.access.datePattern='_'yyyyMMdd'.log'
log4j.appender.access.Threshold = ACCESS
log4j.appender.access.append=true
log4j.appender.access.File=${webapp.root}/log/access.log

log4j.appender.work=com.xx.base.diagnostics.WorkLogAppender
log4j.appender.work.layout=org.apache.log4j.PatternLayout
log4j.appender.work.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %m%n
log4j.appender.work.datePattern='_'yyyyMMdd'.log'
log4j.appender.work.Threshold = WORK
log4j.appender.work.append=true
log4j.appender.work.File=${webapp.root}/log/work.log

log4j.appender.monitor=com.xx.base.diagnostics.MonitorLogAppender
log4j.appender.monitor.layout=org.apache.log4j.PatternLayout
log4j.appender.monitor.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %m%n
log4j.appender.monitor.datePattern='_'yyyyMMdd'.log'
log4j.appender.monitor.Threshold = MONITOR
log4j.appender.monitor.append=true
log4j.appender.monitor.File=${webapp.root}/log/monitor.log

关于log4j的更多定制内容,可以关注我的下一篇博文~