Log4j.properties配置详解

Posted 莫逸风雪

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Log4j.properties配置详解相关的知识,希望对你有一定的参考价值。

一、log4j简介

log4j主要有三个重要的组件:

  • Loggers(记录器):日志类别和级别;

  • Appenders(输出源):日志要输出的地方;

  • Layout(布局):日志以何种形式输出。

1、Loggers

Loggers组件在此系统中被分为五个级别:DEBUG、INFO、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(将日志信息以流格式发送到任意指定的地方)

 
   
   
 
  1. log4j.appender.appenderName = className

  2. log4j.appender.appenderName.Option1 = value1

  3. 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(包含日志产生的时间、线程、类别等信息)

 
   
   
 
  1. log4j.appender.appenderName.layout =className

  2. log4j.appender.appenderName.layout.Option1 = value1

  3. ...

  4. log4j.appender.appenderName.layout.OptionN = valueN

二、配置详解

在实际应用中,要使Log4j在系统中运行须事先设定配置文件。配置文件事实上也就是对Logger、Appender及Layout进行相应设定。Log4j支持两种配置文件格式:

  • 一种是XML格式的文件,

  • 一种是properties属性文件。 下面以properties属性文件为例介绍log4j.properties的配置。

1、配置根Logger:

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

  2. log4j.additivity.org.apache=false:表示Logger不会在父Loggerappender里输出,默认为true

1. level :设定日志记录的最低级别,可设的值有OFF、FATAL、ERROR、WARN、INFO、DEBUG、ALL或者自定义的级别,Log4j建议只使用中间四个级别。通过在这里设定级别,您可以控制应用程序中相应级别的日志信息的开关,比如在这里设定了INFO级别,则应用程序中所有DEBUG级别的日志信息将不会被打印出来。2. appenderName:就是指定日志信息要输出到哪里。可以同时指定多个输出目的地,用逗号隔开。例如:log4j.rootLogger=INFO,A1,B2,C3

2、配置日志信息输出目的地(appender):

 
   
   
 
  1. 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(将日志信息以流格式发送到任意指定的地方)

2.1ConsoleAppender选项

Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。Target=System.err:默认值是System.out。

2.2FileAppender选项

Threshold=WARN:指定日志信息的最低输出级别,默认为DEBUG。ImmediateFlush=true:表示所有消息都会被立即输出,设为false则不输出,默认值是true。Append=false:true表示消息增加到指定文件中,false则将消息覆盖指定的文件内容,默认值是true。File=D:/logs/logging.log4j:指定消息输出到logging.log4j文件中。

2.3DailyRollingFileAppender选项

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:每分钟

2.4RollingFileAppender选项

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)

 
   
   
 
  1. 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(包含日志产生的时间、线程、类别等等信息)

3.1HTMLLayout选项

LocationInfo=true:输出java文件名称和行号,默认值是false。Title=My Logging:默认值是Log4J Log Messages。

3.2PatternLayout选项:

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这样的多客户多线程的应用中。%%:输出一个"%"字符。另外,还可以在%与格式字符之间加上修饰符来控制其最小长度、最大长度、和文本的对齐方式。如:

1)c:指定输出category的名称,最小的长度是20,如果category的名称长度小于20的话,默认的情况下右对齐。

2)%-20c:"-"号表示左对齐。3)%.30c:指定输出category的名称,最大的长度是30,如果category的名称长度大于30的话,就会将左边多出的字符截掉,但小于30的话也不会补空格。

一个不错的参考配置

 
   
   
 
  1. #############

  2. # 输出到控制台

  3. #############

  4. # log4j.rootLogger日志输出类别和级别:只输出不低于该级别的日志信息DEBUG < INFO < WARN < ERROR < FATAL

  5. # WARN:日志级别 CONSOLE:输出位置自己定义的一个名字 logfile:输出位置自己定义的一个名字

  6. log4j.rootLogger=WARN,CONSOLE,logfile

  7. # 配置CONSOLE输出到控制台

  8. log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

  9. # 配置CONSOLE设置为自定义布局模式

  10. log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

  11. # 配置CONSOLE日志的输出格式 [frame] 2019-08-22 22:52:12,000 %r耗费毫秒数 %p日志的优先级 %t线程名 %C所属类名通常为全类名 %L代码中的行号 %x线程相关联的NDC %m日志 %n换行

  12. log4j.appender.CONSOLE.layout.ConversionPattern=[frame] %d{yyyy-MM-dd HH:mm:ss,SSS} - %-4r %-5p [%t] %C:%L %x - %m%n

  13. ################

  14. # 输出到日志文件中

  15. ################

  16. # 配置logfile输出到文件中 文件大小到达指定尺寸的时候产生新的日志文件

  17. log4j.appender.logfile=org.apache.log4j.RollingFileAppender

  18. # 保存编码格式

  19. log4j.appender.logfile.Encoding=UTF-8

  20. # 输出文件位置此为项目根目录下的logs文件夹中

  21. log4j.appender.logfile.File=logs/root.log

  22. # 后缀可以是KB,MB,GB达到该大小后创建新的日志文件

  23. log4j.appender.logfile.MaxFileSize=10MB

  24. # 设置滚定文件的最大值3 指可以产生root.log.1、root.log.2、root.log.3和root.log四个日志文件

  25. log4j.appender.logfile.MaxBackupIndex=3

  26. # 配置logfile为自定义布局模式

  27. log4j.appender.logfile.layout=org.apache.log4j.PatternLayout

  28. log4j.appender.logfile.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %F %p %m%n

  29. ##########################

  30. # 对不同的类输出不同的日志文件

  31. ##########################

  32. # club.bagedate包下的日志单独输出

  33. log4j.logger.club.bagedate=DEBUG,bagedate

  34. # 设置为false该日志信息就不会加入到rootLogger中了

  35. log4j.additivity.club.bagedate=false

  36. # 下面就和上面配置一样了

  37. log4j.appender.bagedate=org.apache.log4j.RollingFileAppender

  38. log4j.appender.bagedate.Encoding=UTF-8

  39. log4j.appender.bagedate.File=logs/bagedate.log

  40. log4j.appender.bagedate.MaxFileSize=10MB

  41. log4j.appender.bagedate.MaxBackupIndex=3

  42. log4j.appender.bagedate.layout=org.apache.log4j.PatternLayout

  43. log4j.appender.bagedate.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} %F %p %m%n


以上是关于Log4j.properties配置详解的主要内容,如果未能解决你的问题,请参考以下文章

配置log4j.properties 详解与配置步骤

log4j.properties配置详解

log4j.properties配置详解

log4j.properties配置及详解

log4j.properties配置详解

log4j.properties配置文件详解