SSM框架整合log4j的配置详情
最近将框架中的log4j深入学习了一下,以前虽然一直在用,但是也是知其然不知其所以然,所有的配置信息都是网上照搬的,最近有时间想着深入的整理学习一下。
一、maven配置
maven 配置详情
<dependency>
<groupId>log4j</groupId>
<artifactId>log4j</artifactId>
<version>1.2.16</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.6.1</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.6.1</version>
</dependency>
二、WEB.xml 配置
<!-- log4j 配置 -->
<context-param>
<param-name>log4jConfigLocation</param-name>
<param-value>classpath:log4j.properties</param-value>
</context-param>
<!--Spring log4j Config loader-->
<listener>
<listener-class> org.springframework.web.util.Log4jConfigListener</listener-class>
</listener>
三、log4j.properties 配置(重点)
### 设置输出类型 debug级别 ###
log4j.rootLogger=debug,stdout,logfile
#---------------------------------------------------------------------
### stdout=ConsoleAppender 输出到控制台 ###
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
# 定义日志输出形式,out正常信息,err错误信息 默认为System.out
log4j.appender.stdout.Target = System.out
#Threshold用来设置该Appender的级别,只对该Appender生效。所有的Appender都可通过设置Threshold来设置本Appender的启用级别
#log4j.appender.file.Threshold= INFO、
log4j.appender.stdout.layout = org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern = [%-5p] %d{yyyy-MM-dd HH:mm:ss,SSS} method:%l%n%m%n
1、log4j.rootLogger
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
appenderName:就是指定日志信息输出到哪个地方。可以同时指定多个输出目的地。
例如:log4j.rootLogger=info,A1,B2,C3 配置了3个输出地方,A1、B2、C3这些变量名称可以随便起,但必须与我们在后面进行的设置名字对应。
例如:
log4j.rootLogger=debug,stdout,logfile
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
…
log4j.appender.logfile=org.apache.log4j.DailyRollingFileAppender
…
level : 是日志记录的优先级,分为OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL。
Log4j建议只使用四个级别,优先级从高到低分别是ERROR、WARN、INFO、DEBUG。
通过在这里定义的级别,可以控制到应用程序中相应级别的日志信息的开关。比如在这里定义了INFO级别,则应用程序中所有DEBUG级别的日志信息将不被打印出来。
可以通过 log4j.appender.xxx.Threshold= [level] 来设置自己的输出级别
如果当前logger没有设定Level,那么它在输出日志时采用的策略是:它会使用它继承的Logger的Level作为它自己的Level来处理。
如果它的上级也没有设置Level,那么就找上上级,几次类推,直到root为止,(root的Level是不能设为空的,所以最终一定会找到一个Level)。
默认root的Level是INFO,其他logger的Level默认都是null,需要手动指定。
当然这里有个前提 那就是rootLogger里配置的level比如小于Threshold层级 ,否则Threshold无效,还是按照总的rootLogger里的level来输出,一般我们实际实用的话 rootLogger里配置DEBUG,然后某个文件专门存储ERRO日志,就配置下Threshold为ERROR
另外控制台如果输出有乱码的话,可以加上如下配置信息
#防止乱码
log4j.appender.stdout.Encoding=UTF-8
2、log4j.appender.xxx=…
Log4j官方的appender给出了一下几种实现
org.apache.log4j.ConsoleAppender(控制台),
org.apache.log4j.FileAppender(文件),
org.apache.log4j.DailyRollingFileAppender(按照时间规则自动一个日志文件),
org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
DailyRollingFileAppender 有一个参数需要注意
- DatePattern 按照规则格式生成文件
yyyy-MM,对应monthly(每月)
yyyy-ww,对应weekly(每周)
yyyy-MM-dd,对应daily(每天)
yyyy-MM-dd-a,对应half-daily(每半天)
yyyy-MM-dd-HH,对应hourly(每小时)
yyyy-MM-dd-HH-mm,对应minutely(每分钟)
例如:
log4j.appender.RollingFile = org.apache.log4j.DailyRollingFileAppender
log4j.appender.RollingFile.File = D://log4.log #输出文件地址
log4j.appender.RollingFile.Append=true # 输出方式 是否追加
#Threshold用来设置该Appender的级别,只对该Appender生效。所有的Appender都可通过设置Threshold来设置本Appender的启用级别
log4j.appender.RollingFile.Threshold= INFO
log4j.appender.RollingFile.DatePattern=yyyy-MM-dd
RollingFileAppender (文件大小到达指定尺寸的时候产生一个新的文件) 有两个参数需要介绍一下。
-
MaxFileSize 是日志文件的最大尺寸;根据实际需求来定 10KB 100KB也行
-
MaxBackupIndex是日志文件的个数,假如超过了,则覆盖,主要考虑到的是硬盘的容量问题,根据实际需求来定 比如 100 500;
例如:
log4j.appender.RollingFile = org.apache.log4j.RollingFileAppender
log4j.appender.RollingFile.File = D://log4.log #输出文件地址
log4j.appender.RollingFile.MaxFileSize=1KB #最大1kb
#Threshold用来设置该Appender的级别,只对该Appender生效。所有的Appender都可通过设置Threshold来设置本Appender的启用级别
log4j.appender.RollingFile.Threshold= INFO
log4j.appender.RollingFile.MaxBackupIndex=3 #最多三个文件
3、log4j.appender.xxx.layout=…
Log4j提供的layout有以下几种:
org.apache.log4j.HTMLLayout(以HTML表格形式布局)
org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
选择 PatternLayout 后可以制定输出格式 ConversionPattern
4.log4j.appender.xxx.layout.ConversionPattern=…
格式名 含义
[QC] 是log信息的开头,可以为任意字符,一般为项目简称。
%p 输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。
%d 输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。
%r 输出自应用程序启动到输出该log信息耗费的毫秒数。
%t 输出产生该日志事件的线程名。
%l 输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。
%c 输出日志信息所属的类目,通常就是所在类的全名。
%M 输出产生日志信息的方法名。
%F 输出日志消息产生时所在的文件名称。
%L 输出代码中的行号。
%m 输出代码中指定的具体日志信息。
%n 输出一个回车换行符,Windows平台为"rn",Unix平台为"n"。
%x 输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%% 输出一个"%"字符。
另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:
1) c 指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。
2)%-20c "-"号表示左对齐。
3)%.30c 指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。
例如
log4j.appender.stdout.layout.ConversionPattern= [QC] %p [%t] %C.%M(%L) | %m%n
这个是我自己配置的ConversionPattern
下面是一些其他的配置详情
输出到数据库 org.apache.log4j.jdbc.JDBCAppender
例如:
log4j.appender.MYSQL_LOG=org.apache.log4j.jdbc.JDBCAppender
log4j.appender.MYSQL_LOG.driver=com.mysql.jdbc.Driver
log4j.appender.MYSQL_LOG.URL=jdbc:mysql://127.0.0.1:3306/txl
log4j.appender.MYSQL_LOG.Threshold=ERROR
log4j.appender.MYSQL_LOG.user=root
log4j.appender.MYSQL_LOG.password=
log4j.appender.MYSQL_LOG.sql=insert into log_monitor(level,category,thread,time,location,note) values('%p','%c','%t','%d{yyyy-MM-dd HH:mm:ss:SSS}','%l','%m')
log4j.appender.MYSQL_LOG.layout=org.apache.log4j.PatternLayout
输出到socket
log4j.appender.socket=org.apache.log4j.RollingFileAppender
log4j.appender.socket.RemoteHost=localhost
log4j.appender.socket.Port=5001
log4j.appender.socket.LocationInfo=true
# Set up for Log Factor 5
log4j.appender.socket.layout=org.apache.log4j.PatternLayout
log4j.appender.socket.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
# Log Factor 5 Appender
log4j.appender.LF5_APPENDER=org.apache.log4j.lf5.LF5Appender
log4j.appender.LF5_APPENDER.MaxNumberOfRecords=2000
输出到邮件
log4j.appender.mail=org.apache.log4j.net.SMTPAppender
log4j.appender.mail.Threshold=FATAL
log4j.appender.mail.BufferSize=10
log4j.appender.mail.From = xxx@mail.com
log4j.appender.mail.SMTPHost=mail.com
log4j.appender.mail.Subject=Log4J Message
log4j.appender.mail.To= xxx@mail.com
log4j.appender.mail.layout=org.apache.log4j.PatternLayout
log4j.appender.mail.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n
部分内容出自其他博客,总结的相当全面。原文地址
下面就是从该博客转载的内容,和上面内容有重复,转载过来有便于总结记忆。
在实际应用中,要使Log4j在系统中运行须事先设定配置文件。配置文件事实上也就是对Logger、Appender及Layout进行相应设定。Log4j支持两种配置文件格式,一种是XML格式的文件,一种是properties属性文件。下面以properties属性文件为例介绍log4j.properties的配置。
1、配置根Logger:
log4j.rootLogger = [ level ] , appenderName1, appenderName2, …
log4j.additivity.org.apache=false:表示Logger不会在父Logger的appender里输出,默认为true。
level :设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别。通过在这里设定级别,您可以控制应用程序中相应级别的日志信息的开关,比如在这里设定了INFO级别,则应用程序中所有DEBUG级别的日志信息将不会被打印出来。
appenderName:就是指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开。
例如:log4j.rootLogger=INFO,A1,B2,C3
2、配置日志信息输出目的地(appender):
log4j.appender.appenderName = className
appenderName:自定义appderName,在log4j.rootLogger设置中使用;
className:可设值如下:
(1)org.apache.log4j.ConsoleAppender(控制台)
(2)org.apache.log4j.FileAppender(文件)
(3)org.apache.log4j.DailyRollingFileAppender(每天产生一个日志文件)
(4)org.apache.log4j.RollingFileAppender(文件大小到达指定尺寸的时候产生一个新的文件)
(5)org.apache.log4j.WriterAppender(将日志信息以流格式发送到任意指定的地方)
(1)ConsoleAppender选项:
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
Target=System.err:默认值是System.out。
(2)FileAppender选项:
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。
(3)DailyRollingFileAppender选项:
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
File=D:/logs/logging.log4j:指定当前消息输出到logging.log4j文件中。
DatePattern=’.‘yyyy-MM:每月滚动一次日志文件,即每月产生一个新的日志文件。当前月的日志文件名为logging.log4j,前一个月的日志文件名为logging.log4j.yyyy-MM。
另外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
1)’.‘yyyy-MM:每月
2)’.‘yyyy-ww:每周
3)’.‘yyyy-MM-dd:每天
4)’.‘yyyy-MM-dd-a:每天两次
5)’.‘yyyy-MM-dd-HH:每小时
6)’.'yyyy-MM-dd-HH-mm:每分钟
(4)RollingFileAppender选项:
Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。
ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。
MaxFileSize=100KB:后缀可以是KB, MB 或者GB。在日志文件到达该大小时,将会自动滚动,即将原来的内容移到logging.log4j.1文件中。
MaxBackupIndex=2:指定可以产生的滚动文件的最大数,例如,设为2则可以产生logging.log4j.1,logging.log4j.2两个滚动文件和一个logging.log4j文件。
3、配置日志信息的输出格式(Layout):
log4j.appender.appenderName.layout=className
className:可设值如下:
(1)org.apache.log4j.HTMLLayout(以HTML表格形式布局)
(2)org.apache.log4j.PatternLayout(可以灵活地指定布局模式)
(3)org.apache.log4j.SimpleLayout(包含日志信息的级别和信息字符串)
(4)org.apache.log4j.TTCCLayout(包含日志产生的时间、线程、类别等等信息)
(1)HTMLLayout选项:
LocationInfo=true:输出java文件名称和行号,默认值是false。
Title=My Logging: 默认值是Log4J Log Messages。
(2)PatternLayout选项:
ConversionPattern=%m%n:设定以怎样的格式显示消息。
格式化符号说明:
%p:输出日志信息的优先级,即DEBUG,INFO,WARN,ERROR,FATAL。
%d:输出日志时间点的日期或时间,默认格式为ISO8601,也可以在其后指定格式,如:%d{yyyy/MM/dd HH:mm:ss,SSS}。
%r:输出自应用程序启动到输出该log信息耗费的毫秒数。
%t:输出产生该日志事件的线程名。
%l:输出日志事件的发生位置,相当于%c.%M(%F:%L)的组合,包括类全名、方法、文件名以及在代码中的行数。例如:test.TestLog4j.main(TestLog4j.java:10)。
%c:输出日志信息所属的类目,通常就是所在类的全名。
%M:输出产生日志信息的方法名。
%F:输出日志消息产生时所在的文件名称。
%L::输出代码中的行号。
%m::输出代码中指定的具体日志信息。
%n:输出一个回车换行符,Windows平台为"rn",Unix平台为"n"。
%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
%%:输出一个"%“字符。
另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:
(1) c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。
(2) %-20c:”-"号表示左对齐。
(3) %.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。