Log4j.properties配置详情
参考博客https://www.cnblogs.com/zhangguangxiang/p/12007924.html
一、Log4j简介
Log4j主要有三个重要的组件
- Loggers(记录器):日志类别和级别;
- Appenders(输出源):日志要输出的地方;
- Layout(布局):日志以何种形式输出。
1、Loggers
Loggers组件大概分为五个级别:DEBUG、INNFO、WARN、ERROR和FATAL。这五个级别是有顺序的,DEBUG < INFO < WARN < ERROR < FATAL,分别用来指定这条日志信息的重要程度。
Log4j有一个规则:只要输出级别不低于设定级别的日志信息,都会输出,假设Loggers级别设定为INFO,则INFO、WARN、ERROR和FATAL级别的日志都会输出,而级别比INFO低的DEBUG则不会输出。
2、Appenders
禁用和使用日志请求只是Log4j的基本功能,Log4j日志系统还提供许多强大的功能,比如允许把日志输出到不同的地方,如控制台(Console)、文件(Files)等,可以根据天数或者文件大小产生新的文件,可以以流的形式发送到其它地方等等。
常使用的类如下:
- org.apache.log4j.ConsoleAppender (控制台)
- org.apache.log4j.FileAppender (文件)
- org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件)
- org.apache.log4j.RollingFileAppender (文件大小到达指定尺寸的时候产生一个新的文件)
- org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)
log4j.appender.appenderName = className
log4j.appender.appenderName.Option1 = value1
...
log4j.appender.appenderName.OptionN = valueN
3、Layouts
Log4j可以再Appenders的后面附加Layouts来完成这个功能。
Layouts提供四种日志输出样式,如根据HTML样式、自由指定样式、包含日志级别与信息的样式和包含日志时间、线程、类别等信息的样式。
常使用的类如下:
- org.apache.log4j.HTMLLayout (以HTML表格形式布局)
- org.apache.log4j.PatternLayout (可以灵活地指定布局模式)
- org.apache.log4j.SimpleLayout (包含日志信息的级别和信息字符串)
- org.apache.log4j.TTCCLayout (包含日志产生的时间、线程、类别等信息)
log4j.appender.appenderName.layout = className
log4j.appender.appenderName.layout.Option1 = value1
...
log4j.appender.appenderName.layout.OptionN = valueN
二、配置详情
在实际应用中,要使用Log4j在系统中运行须事先设定配置文件。配置文件事实上也就是对Logger、Appender以及Layout进行相应设定。
Log4支持两种配置文件格式:
- 一种是XML格式的文件
- 一种是properties属性文件
下面以properties属性文件为例介绍log4j.properties的配置
1、配置根Logger:
log4j.rootLogger = [ level], appenderName1, appenderName2, ...
#表示Logger不会在父Logger的appender里输出,默认为true
log4j.additivity.org.apache = false
- **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:自定义appenderName,在log4j.rootLogger设置中使用;
calssName:可设置值如下:
- org.apache.log4j.ConsoleAppender (控制台)
- org.apache.log4j.FileAppender (文件)
- org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件)
- org.apache.log4j.RollingFileAppender (文件大小到达指定尺寸的时候产生一个新的文件)
- org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)
2.1、ConsoleAppender选项
Threshold = WARN
:指定日志信息的最低输出级别,默认为DEBUG。
ImmediateFlush = true
:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
Target = System.err
:默认值是System.out。
2.2、FileAppender选项
Threshold = WARN
:指定日志信息的最低输出级别,默认为DEBUG。
ImmediateFlush = true
:表示所有消息都会被立即输出,设为false则不输出,默认值是true。
Append = false
:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。
File = D://logs/logging.log4j
:指定消息输出到logging.log4j文件中。
2.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。
另外,也可以指定按周、天、时、分等来滚动日志文件,对应的格式如下:
- '.'yyyy-MM:每月
- '.'yyyy-ww:每周
- '.'yyyy-MM-dd:每天
- '.'yyyy-MM-dd-a:每天两次
- '.'yyyy-MM-dd-HH:每小时
- '.'yyyy-MM-dd-HH-mm:每分钟
2.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:可设值如下:
- org.apache.log4j.HTMLLayout (以HTML表格形式布局)
- org.apache.log4j.PatternLayout (可以灵活的指定布局)
- org.apache.log4j.SimpleLayout (包含日志信息的级别和信息字符串)
- org.apache.log4j.TTCCLayout (包含日志产生的时间、线程、类别等等信息)
3.1、HTMLLayout选项
LocationInfo = true
:输出java文件名和行号,默认值是false。
Title = My Logging
:默认值是Log4j Log Messages。
3.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系统为"\r\n",Unix系统为"\n"。
-
%x:输出和当前线程相关联的NDC(嵌套诊断环境),尤其用到像java servlets这样的多客户多线程的应用中。
-
%%:输出一个"%"字符。
另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度和文本对齐方式。如:
参考配置
#############
# 输出到控制台
#############
# log4j.rootLogger日志输出类别和级别:只输出不低于该级别的日志信息DEBUG < INFO < WARN < ERROR < FATAL
# WARN:日志级别 CONSOLE:输出位置自己定义的一个名字 logfile:输出位置自己定义的一个名字
log4j.rootLogger=WARN,CONSOLE,logfile
# 配置CONSOLE输出到控制台
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
# 配置CONSOLE设置为自定义布局模式
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
# 配置CONSOLE日志的输出格式 [frame] 2019-08-22 22:52:12,000 %r耗费毫秒数 %p日志的优先级 %t线程名 %C所属类名通常为全类名 %L代码中的行号 %x线程相关联的NDC %m日志 %n换行
log4j.appender.CONSOLE.layout.ConversionPattern=[frame] %d{yyyy-MM-dd HH:mm:ss,SSS} - %-4r %-5p [%t] %C:%L %x - %m%n
################
# 输出到日志文件中
################
# 配置logfile输出到文件中 文件大小到达指定尺寸的时候产生新的日志文件
log4j.appender.logfile=org.apache.log4j.RollingFileAppender
# 保存编码格式
log4j.appender.logfile.Encoding=UTF-8
# 输出文件位置此为项目根目录下的logs文件夹中
log4j.appender.logfile.File=logs/root.log
# 后缀可以是KB,MB,GB达到该大小后创建新的日志文件
log4j.appender.logfile.MaxFileSize=10MB
# 设置滚定文件的最大值3 指可以产生root.log.1、root.log.2、root.log.3和root.log四个日志文件
log4j.appender.logfile.MaxBackupIndex=3
# 配置logfile为自定义布局模式
log4j.appender.logfile.layout=org.apache.log4j.PatternLayout
log4j.appender.logfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %F %p %m%n
##########################
# 对不同的类输出不同的日志文件
##########################
# club.bagedate包下的日志单独输出
log4j.logger.club.bagedate=DEBUG,bagedate
# 设置为false该日志信息就不会加入到rootLogger中了
log4j.additivity.club.bagedate=false
# 下面就和上面配置一样了
log4j.appender.bagedate=org.apache.log4j.RollingFileAppender
log4j.appender.bagedate.Encoding=UTF-8
log4j.appender.bagedate.File=logs/bagedate.log
log4j.appender.bagedate.MaxFileSize=10MB
log4j.appender.bagedate.MaxBackupIndex=3
log4j.appender.bagedate.layout=org.apache.log4j.PatternLayout
log4j.appender.bagedate.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %F %p %m%n