log4j配置参数详解

红太狼 2023-10-17 22:43 45阅读 0赞

项目中尽管对log4j有基本的配置，例如按天生成日志文件以作区分，但如果系统日志文件过大，则就需要考虑以更小的单位切分或者其他切分方式。下面就总结一下log4j常用的配置参数以及切分日志的不同方式。

**一、基本配置解析**

常用配置：

#日志级别，还可以log4j.rootLogger=INFO,file2,file3 指定file2、3的输出文件
    log4j.rootLogger=info,exception,thread
    
    #info
    #每一天产生1个日志文件
    log4j.appender.info=org.apache.log4j.DailyRollingFileAppender
    #定义日志存放路径
    log4j.appender.info.File=/usr/tomcat_logs/mailSystem_info.log
    #日志文件是否追加
    log4j.appender.info.Append=true
    #定义的时间格式，如果时间定义到分钟（mm）就是每分钟生成一个日志文件，而这里定义的这个格式就是日志名后缀
    #log4j.appender.file3.DatePattern='_' yyyy-MM-dd-HH-mm 每分钟
    #log4j.appender.file3.DatePattern='_' yyyy-MM-dd-HH 每小时
    #log4j.appender.file3.DatePattern='_' yyyy-MM-dd 每天
    #log4j.appender.file3.DatePattern='_' yyyy-MM-dd-a 每半天
    #日志输出级别
    log4j.appender.info.Threshold=INFO
    #日志编码
    #log4j.appender.file3.Encoding=UTF-8
    #日志中输出的日志的格式
    log4j.appender.info.layout=org.apache.log4j.PatternLayout
    #定义的日志格式
    log4j.appender.info.layout.ConversionPattern=%t %d %p [%c] - %m%n
    
    #debug
    log4j.appender.debug=org.apache.log4j.RollingFileAppender
    log4j.appender.debug.File=/usr/tomcat_logs/mailSystem_debug.log
    #设置日志文件的大小
    log4j.appender.debug.MaxFileSize=100MB
    #保存10个备份文件
    log4j.appender.debug.MaxBackupIndex=10
    log4j.appender.debug.Append=true
    log4j.appender.debug.Threshold=DEBUG
    log4j.appender.debug.layout=org.apache.log4j.PatternLayout
    log4j.appender.debug.layout.ConversionPattern=%t %d %p [%c] - %m%n

配置中info采用DailyRollingFileAppender类，可定义日志按照log4j给定的参数值进行配置，debug使用RollingFileAppender。两者都为log4j配置的核心类。在下进行详细介绍。

**二、配置核心类解析**

*  CLASS1：DailyRollingFileAppender

在配置1中使用到DailyRollingFileAppender，该类继承与FileAppender，so that the underlying file is rolled over at a user chosen frequency.

The rolling schedule is specified by the “DatePattern” option。使用这些rolling schedule 需要注意一个前缀问题。例如if the “File” option is set to “/foo/bar.log” and the “DatePattern” set to '.'yyyy-MM-dd ,则到了midnight，the logging file /foo/bar.log will be copied to "/foo/bar.log.2017-01-01",也就是在bar.log文件后添加 ".yyyy-MM-dd"后缀。It is possible to specify monthly, weekly,half-daily, daily,hourly, or minutely rollover schedules.

总共有：

<table> 
 <tbody> 
 <tr> 
 <td style="vertical-align:top;"> 切分类型 </td> 
 <td style="vertical-align:top;"> 切分前 </td> 
 <td style="vertical-align:top;"> 切分后 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;"> 按月'.'yyyy-MM </td> 
 <td style="vertical-align:top;"> /foo/bar.log </td> 
 <td style="vertical-align:top;"> /foo/bar.log.2002-05 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;"> 按周 '.'yyyy-ww </td> 
 <td style="vertical-align:top;"> /foo/bar.log </td> 
 <td style="vertical-align:top;"> /foo/bar.log.2002-23 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;"> 按天&nbsp;'.'yyyy-MM-dd </td> 
 <td style="vertical-align:top;"> /foo/bar.log </td> 
 <td style="vertical-align:top;"> /foo/bar.log.2002-03-08 default </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;"> 半天 '.'yyyy-MM-dd-a </td> 
 <td style="vertical-align:top;"> /foo/bar.log </td> 
 <td style="vertical-align:top;"> /foo/bar.log.2002-03-09-AM </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;"> 按时 '.'yyyy-MM-dd-HH </td> 
 <td style="vertical-align:top;"> /foo/bar.log </td> 
 <td style="vertical-align:top;"> /foo/bar.log.2002-03-09-10 </td> 
 </tr> 
 <tr> 
 <td style="vertical-align:top;"> 按分 '.'yyyy-MM-dd-HH-mm </td> 
 <td style="vertical-align:top;"> /foo/bar.log </td> 
 <td style="vertical-align:top;"> /foo/bar.log.2001-03-09-10-22 </td> 
 </tr> 
 </tbody> 
</table>

public DailyRollingFileAppender (Layout layout, String filename,String datePattern) throws IOException {
          super(layout, filename, true);
          this.datePattern = datePattern;
          activateOptions();
    }

这些参数策略会传入到DailyRollingFileAppender的初始化方法中，创建一个DailyRollingFileAppender对象。

*  CLASS2：RollingFileAppender

配置2中使用到另一个类RollingFileAppender，这个类也继承子FileAppender，用于按照一定的size文件大小，back up 日志文件。

这个类中起关键作用的两个参数maxFileSize和maxBackupIndex，用于确定每个日志文件的size大小和备份个数。默认分别为10MB和1.按照设置的index大小，会默认将文件copy to .1,.2等文件后缀进行备份。

*  CLASS3： PatternLayout

在两个配置中，均使用PatternLayout和ConventionPattern类，PatternLayout主要用于日志输出相关，ConventionPattern用于定义日志文件的输出格式。其中ConventionPattern支持多种类型的日志输出，如线程信息、类信息，均已%打头进行配置，详情如下：

%c 输出日志信息所属的类的全名，例如%c\{2\}，对于com.max.spring.demo,便会输出spring.demo两级类信息。  
%d 输出日志时间点的日期或时间，默认格式为ISO8601，也可以在其后指定格式，比如：%d\{yyy-MM-dd HH:mm:ss \}，输出类似：2002-10-18- 22：10：28  
%f 输出日志信息所属的类的类名  
%l 输出日志事件的发生位置，即输出日志信息的语句处于它所在的类的第几行  
%m 输出代码中指定的信息，如log(message)中的message  
%n 输出一个回车换行符，Windows平台为“rn”，Unix平台为“n”  
%p 输出优先级，即DEBUG，INFO，WARN，ERROR，FATAL。如果是调用debug()输出的，则为DEBUG，依此类推  
%r 输出自应用启动到输出该日志信息所耗费的毫秒数  
%t 输出产生该日志事件的线程名

**三、切分效果**

按照日期切分日志： 按照文件大小切分日志：

![Center][] ![Center 1][]

原文:[https://blog.csdn.net/daybreak1209/article/details/54020497][https_blog.csdn.net_daybreak1209_article_details_54020497]

[Center]: https://img-blog.csdn.net/20170104165233282?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvRGF5YnJlYWsxMjA5/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/Center
[Center 1]: https://img-blog.csdn.net/20170104165405001?watermark/2/text/aHR0cDovL2Jsb2cuY3Nkbi5uZXQvRGF5YnJlYWsxMjA5/font/5a6L5L2T/fontsize/400/fill/I0JBQkFCMA==/dissolve/70/gravity/Center
[https_blog.csdn.net_daybreak1209_article_details_54020497]: https://blog.csdn.net/daybreak1209/article/details/54020497