www.cnblogs.com/hafiz/p/6170702.html

⼀、背景

昨天了解了⼀下slf4j和log4j2,想要进⾏总结记录,配置步骤⼗分简单,唯⼀需要具体了解的就是log4j2.xml的配置,于是找到了这篇博⽂,配置讲解⼗分详 细,便转载作记录,再次感谢阿豪聊⼲货。以下原⽂:  
  最近由于项⽬的需要,我们把log4j 1.x的版本全部迁移成log4j 2.x 的版本,那随之⽽来的slf4j整合log4j的配置()以及log4j2配置⽂件的详解,就需要我们来 好好聊⼀聊了。本⽂就专门来讲解下log4j2.xml配置⽂件的各项标签的意义。

⼆、配置全解

1.关于配置⽂件的名称以及在项⽬中的存放位置

log4j 2.x版本不再⽀持像1.x中的.properties后缀的⽂件配置⽅式,2.x版本配置⽂件后缀名只能为”.xml”,”.json”或者”.jsn”.
系统选择配置⽂件的优先级(从先到后)如下:
(1).classpath下的名为log4j2-test.json 或者log4j2-test.jsn的⽂件.
(2).classpath下的名为log4j2-test.xml的⽂件.
(3).classpath下名为log4j2.json 或者log4j2.jsn的⽂件.
(4).classpath下名为log4j2.xml的⽂件.

我们⼀般默认使⽤log4j2.xml进⾏命名。如果本地要测试,可以把log4j2-test.xml放到classpath,⽽正式环境使⽤log4j2.xml,则在打包部署的时候不 要打包log4j2-test.xml即可。

2.缺省默认配置⽂件

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <Configuration status="WARN">
  3. <Appenders>
  4. <Console name="Console" target="SYSTEM_OUT">
  5. <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
  6. </Console>
  7. </Appenders>
  8. <Loggers>
  9. <Root level="error">
  10. <AppenderRef ref="Console"/>
  11. </Root>
  12. </Loggers>
  13. </Configuration>

3.配置⽂件节点解析    

(1).根节点Configuration有两个属性:status和monitorinterval,有两个⼦节点:Appenders和Loggers(表明可以定义多个Appender和Logger).
status⽤来指定log4j本⾝的打印⽇志的级别.
monitorinterval⽤于指定log4j⾃动重新配置的监测间隔时间,单位是s,最⼩是5s.

(2).Appenders节点,常见的有三种⼦节点:Console、RollingFile、File.

Console节点⽤来定义输出到控制台的Appender.
name:指定Appender的名字.
target:SYSTEM_OUT 或 SYSTEM_ERR,⼀般只设置默认:SYSTEM_OUT.
PatternLayout:输出格式,不设置默认为:%m%n.

File节点⽤来定义输出到指定位置的⽂件的Appender.
name:指定Appender的名字.
fileName:指定输出⽇志的⽬的⽂件带全路径的⽂件名.
PatternLayout:输出格式,不设置默认为:%m%n.

RollingFile节点⽤来定义超过指定⼤⼩⾃动删除旧的创建新的的Appender.
name:指定Appender的名字.
fileName:指定输出⽇志的⽬的⽂件带全路径的⽂件名.
PatternLayout:输出格式,不设置默认为:%m%n.
filePattern:指定新建⽇志⽂件的名称格式.
Policies:指定滚动⽇志的策略,就是什么时候进⾏新建⽇志⽂件输出⽇志.

TimeBasedTriggeringPolicy:Policies⼦节点,基于时间的滚动策略,interval属性⽤来指定多久滚动⼀次,默认是1 hour。modulate=true⽤来调
整时间:⽐如现在是早上3am,interval是4,那么第⼀次滚动是在4am,接着是8am,12am…⽽不是7am.
SizeBasedTriggeringPolicy:Policies⼦节点,基于指定⽂件⼤⼩的滚动策略,size属性⽤来定义每个⽇志⽂件的⼤⼩.
DefaultRolloverStrategy:⽤来指定同⼀个⽂件夹下最多有⼏个⽇志⽂件时开始删除最旧的,创建新的(通过max属性)。

(3).Loggers节点,常见的有两种:Root和Logger.
Root节点⽤来指定项⽬的根⽇志,如果没有单独指定Logger,那么就会默认使⽤该Root⽇志输出
level:⽇志输出级别,共有8个级别,按照从低到⾼为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
AppenderRef:Root的⼦节点,⽤来指定该⽇志输出到哪个Appender.
Logger节点⽤来单独指定⽇志的形式,⽐如要为指定包下的class指定不同的⽇志级别等。
level:⽇志输出级别,共有8个级别,按照从低到⾼为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
name:⽤来指定该Logger所适⽤的类或者类所在的包全路径,继承⾃Root节点.
AppenderRef:Logger的⼦节点,⽤来指定该⽇志输出到哪个Appender,如果没有指定,就会默认继承⾃Root.如果指定了,那么会在指定的
这个Appender和Root的Appender中都会输出,此时我们可以设置Logger的additivity=”false”只在⾃定义的Appender中进⾏输出。

(4).关于⽇志level. 共有8个级别,按照从低到⾼为:All < Trace < Debug < Info < Warn < Error < Fatal < OFF.
All:最低等级的,⽤于打开所有⽇志记录.
Trace:是追踪,就是程序推进以下,你就可以写个trace输出,所以trace应该会特别多,不过没关系,我们可以设置最低⽇志级别不让他输出.
Debug:指出细粒度信息事件对调试应⽤程序是⾮常有帮助的.
Info:消息在粗粒度级别上突出强调应⽤程序的运⾏过程.
Warn:输出警告及warn以下级别的⽇志.
Error:输出错误信息⽇志.
Fatal:输出每个严重的错误事件将会导致应⽤程序的退出的⽇志.
OFF:最⾼等级的,⽤于关闭所有⽇志记录.
程序会打印⾼于或等于所设置级别的⽇志,设置的⽇志等级越⾼,打印出来的⽇志就越少。

4.⽐较完整的log4j2.xml配置模板

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <!--⽇志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->
  3. <!--Configuration后⾯的status,这个⽤于设置log4j2⾃⾝内部的信息输出,可以不设置,当设置成trace时,你会看到log4j2内部各种详细输出-->
  4. <!--monitorInterval:Log4j能够⾃动检测修改配置⽂件和重新配置本⾝,设置间隔秒数-->
  5. <configuration status="WARN" monitorInterval="30">
  6. <!--先定义所有的appender-->
  7. <appenders>
  8. <!--这个输出控制台的配置-->
  9. <console name="Console" target="SYSTEM_OUT">
  10. <!--输出⽇志的格式-->
  11. <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  12. </console>
  13. <!--⽂件会打印出所有信息,这个log每次运⾏程序会⾃动清空,由append属性决定,这个也挺有⽤的,适合临时测试⽤-->
  14. <File name="log" fileName="log/test.log" append="false">
  15. <PatternLayout pattern="%d{HH:mm:ss.SSS} %-5level %class{36} %L %M - %msg%xEx%n"/>
  16. </File>
  17. <!-- 这个会打印出所有的info及以下级别的信息,每次⼤⼩超过size,则这size⼤⼩的⽇志会⾃动存⼊按年份-⽉份建⽴的⽂件夹下⾯并进⾏压缩,作为存档-->
  18. <RollingFile name="RollingFileInfo" fileName="${sys:user.home}/logs/info.log"
  19. filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log">
  20. <!--控制台只输出level及以上级别的信息(onMatch),其他的直接拒绝(onMismatch)-->
  21. <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
  22. <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  23. <Policies>
  24. <TimeBasedTriggeringPolicy/>
  25. <SizeBasedTriggeringPolicy size="100 MB"/>
  26. </Policies>
  27. </RollingFile>
  28. <RollingFile name="RollingFileWarn" fileName="${sys:user.home}/logs/warn.log"
  29. filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log">
  30. <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
  31. <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  32. <Policies>
  33. <TimeBasedTriggeringPolicy/>
  34. <SizeBasedTriggeringPolicy size="100 MB"/>
  35. </Policies>
  36. <!-- DefaultRolloverStrategy属性如不设置,则默认为最多同⼀⽂件夹下7个⽂件,这⾥设置了20 -->
  37. <DefaultRolloverStrategy max="20"/>
  38. </RollingFile>
  39. <RollingFile name="RollingFileError" fileName="${sys:user.home}/logs/error.log"
  40. filePattern="${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log">
  41. <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
  42. <PatternLayout pattern="[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"/>
  43. <Policies>
  44. <TimeBasedTriggeringPolicy/>
  45. <SizeBasedTriggeringPolicy size="100 MB"/>
  46. </Policies>
  47. </RollingFile>
  48. </appenders>
  49. <!--然后定义logger,只有定义了logger并引⼊的appender,appender才会⽣效-->
  50. <loggers>
  51. <!--过滤掉spring和mybatis的⼀些⽆⽤的DEBUG信息-->
  52. <logger name="org.springframework" level="INFO"></logger>
  53. <logger name="org.mybatis" level="INFO"></logger>
  54. <root level="all">
  55. <appender-ref ref="Console"/>
  56. <appender-ref ref="RollingFileInfo"/>
  57. <appender-ref ref="RollingFileWarn"/>
  58. <appender-ref ref="RollingFileError"/>
  59. </root>
  60. </loggers>
  61. </configuration>