Log4j2 简明教程

小灰灰 2022-03-02 04:36 247阅读 0赞

转载：http://blog.bensonlin.me/post/log4j2-tutorial

## 一、概述 ##

log4j2官方文档内容非常多，要一次性了解全部是不可能的。正确的步骤应当是先了解最常见的配置，当发现原有知识无法解决问题，再重新查看文档看有没有合适的配置。  
下面将从文件结构入手，再到简单的实例，从实例入手分析常见的配置的用途，其中涉及其中包括Appenders, Filters, Layout, Lookups的知识，最后根据学习。

可以搜索到的关于log4j2的教程非常少，这篇文章更多的是让大家对log4j2有个大体的了解，免得大家看到官方文档那么多就晕了！

欢迎关注我的github: https://github.com/benson-lin

如果觉得排版不好，可以访问：http://blog.bensonlin.me/post/log4j2-tutorial

### log4j2.xml文件结构 ###

下面是一个比较完整的例子：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 </td> 
 <td> <code>&lt;?xml version=</code><code>"1.0"</code>&nbsp;<code>encoding=</code><code>"UTF-8"</code><code>?&gt;</code> <code>&lt;!-- 设置log4j2的自身log级别为warn --&gt;</code> <code>&lt;!-- OFF &gt; FATAL &gt; ERROR &gt; WARN &gt; INFO &gt; DEBUG &gt; TRACE &gt; ALL --&gt;</code> <code>&lt;configuration status=</code><code>"WARN"</code>&nbsp;<code>monitorInterval=</code><code>"30"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;appenders&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;console name=</code><code>"Console"</code>&nbsp;<code>target=</code><code>"SYSTEM_OUT"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/console&gt;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;RollingFile name=</code><code>"RollingFileInfo"</code>&nbsp;<code>fileName=</code><code>"${sys:user.home}/logs/info.log"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filePattern=</code><code>"${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）--&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Filters&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"INFO"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"WARN"</code>&nbsp;<code>onMatch=</code><code>"DENY"</code>&nbsp;<code>onMismatch=</code><code>"NEUTRAL"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Filters&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;TimeBasedTriggeringPolicy/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;SizeBasedTriggeringPolicy size=</code><code>"100 MB"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/RollingFile&gt;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;RollingFile name=</code><code>"RollingFileWarn"</code>&nbsp;<code>fileName=</code><code>"${sys:user.home}/logs/warn.log"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filePattern=</code><code>"${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Filters&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"WARN"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"ERROR"</code>&nbsp;<code>onMatch=</code><code>"DENY"</code>&nbsp;<code>onMismatch=</code><code>"NEUTRAL"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Filters&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;TimeBasedTriggeringPolicy/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;SizeBasedTriggeringPolicy size=</code><code>"100 MB"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/RollingFile&gt;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;RollingFile name=</code><code>"RollingFileError"</code>&nbsp;<code>fileName=</code><code>"${sys:user.home}/logs/error.log"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filePattern=</code><code>"${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"ERROR"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;TimeBasedTriggeringPolicy/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;SizeBasedTriggeringPolicy size=</code><code>"100 MB"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/RollingFile&gt;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/appenders&gt;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;loggers&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!--过滤掉spring和mybatis的一些无用的DEBUG信息--&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;logger name=</code><code>"org.springframework"</code>&nbsp;<code>level=</code><code>"INFO"</code><code>&gt;&lt;/logger&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;logger name=</code><code>"org.mybatis"</code>&nbsp;<code>level=</code><code>"INFO"</code><code>&gt;&lt;/logger&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;root level=</code><code>"all"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;appender-ref ref=</code><code>"Console"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;appender-ref ref=</code><code>"RollingFileInfo"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;appender-ref ref=</code><code>"RollingFileWarn"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;appender-ref ref=</code><code>"RollingFileError"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/root&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/loggers&gt;</code> &nbsp; <code>&lt;/configuration&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

log4j2有默认的配置，如果要替换配置，只需要在classpath根目录下放置log4j2.xml。  
log4j 2.0与以往的1.x有一个明显的不同，其配置文件只能采用.xml, .json或者 .jsn。在默认情况下，系统选择configuration文件的优先级如下：（classpath为src文件夹）

*  classpath下名为 log4j-test.json 或者log4j-test.jsn文件
 *  classpath下名为 log4j2-test.xml
 *  classpath下名为 log4j.json 或者log4j.jsn文件
 *  classpath下名为 log4j2.xml

如果本地要测试，可以把log4j2-test.xml放到classpath，而正式环境使用log4j2.xml，则在打包部署的时候不要打包log4j2-test.xml即可。

下面是其缺省配置：

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

下面将对上面的配置文件进行一一讲解。

### 二、示例Java代码 ###

如果使用如下配置，也就是缺省配置：

输出如下：只输出error以上的日志信息

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>17</code><code>:</code><code>13</code><code>:</code><code>01.540</code>&nbsp;<code>[main] ERROR com.foo.Bar - Did it again!</code> <code>17</code><code>:</code><code>13</code><code>:</code><code>01.540</code>&nbsp;<code>[main] ERROR MyApp - Didn't&nbsp;</code><code>do</code>&nbsp;<code>it.</code> </td> 
 </tr> 
 </tbody> 
</table>

如果我们希望除了com.foo.Bar类下输出TRACE以上到控制台外，其他停止TRACE的输出到控制台，只输出ERROR以上的日志。可以如下配置：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>&lt;Loggers&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Logger name=</code><code>"com.foo.Bar"</code>&nbsp;<code>level=</code><code>"TRACE"</code><code>/&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Root level=</code><code>"ERROR"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;AppenderRef ref=</code><code>"STDOUT"</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Root&gt;</code> <code>&lt;/Loggers&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

结果如下：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>14</code><code>:</code><code>14</code><code>:</code><code>17.176</code>&nbsp;<code>[main] TRACE com.foo.Bar - Enter</code> <code>14</code><code>:</code><code>14</code><code>:</code><code>17.182</code>&nbsp;<code>[main] ERROR com.foo.Bar - Did it again!</code> <code>14</code><code>:</code><code>14</code><code>:</code><code>17.182</code>&nbsp;<code>[main] TRACE com.foo.Bar - Exit with(</code><code>false</code><code>)</code> <code>14</code><code>:</code><code>14</code><code>:</code><code>17.182</code>&nbsp;<code>[main] ERROR com.foo.MyApp - Didn't&nbsp;</code><code>do</code>&nbsp;<code>it.</code> </td> 
 </tr> 
 </tbody> 
</table>

因为com.foo.Bar没有自己的Appender，所以会使用ROOT的Appender，如果自己也配置了在控制台打印，就要注意可加性：如下配置，会ERROR以上的会打印两次

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 </td> 
 <td> <code>&lt;?xml version=</code><code>"1.0"</code>&nbsp;<code>encoding=</code><code>"UTF-8"</code><code>?&gt;</code> <code>&lt;Configuration status=</code><code>"WARN"</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Appenders&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Console name=</code><code>"Console"</code>&nbsp;<code>target=</code><code>"SYSTEM_OUT"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Console&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Appenders&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Loggers&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Logger name=</code><code>"com.foo.Bar"</code>&nbsp;<code>level=</code><code>"trace"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;AppenderRef ref=</code><code>"Console"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Logger&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Root level=</code><code>"error"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;AppenderRef ref=</code><code>"Console"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Root&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Loggers&gt;</code> <code>&lt;/Configuration&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

结果如下

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>14</code><code>:</code><code>11</code><code>:</code><code>27.103</code>&nbsp;<code>[main] TRACE com.foo.Bar - Enter</code> <code>14</code><code>:</code><code>11</code><code>:</code><code>27.103</code>&nbsp;<code>[main] TRACE com.foo.Bar - Enter</code> <code>14</code><code>:</code><code>11</code><code>:</code><code>27.106</code>&nbsp;<code>[main] ERROR com.foo.Bar - Did it again!</code> <code>14</code><code>:</code><code>11</code><code>:</code><code>27.106</code>&nbsp;<code>[main] ERROR com.foo.Bar - Did it again!</code> <code>14</code><code>:</code><code>11</code><code>:</code><code>27.107</code>&nbsp;<code>[main] TRACE com.foo.Bar - Exit with(</code><code>false</code><code>)</code> <code>14</code><code>:</code><code>11</code><code>:</code><code>27.107</code>&nbsp;<code>[main] TRACE com.foo.Bar - Exit with(</code><code>false</code><code>)</code> <code>14</code><code>:</code><code>11</code><code>:</code><code>27.107</code>&nbsp;<code>[main] ERROR com.foo.MyApp - Didn't&nbsp;</code><code>do</code>&nbsp;<code>it.</code> </td> 
 </tr> 
 </tbody> 
</table>

如果我们确实有这种需求(不想遵循父类的Appender)，可以加上`additivity="false"`参数。如下配置，com.foo.Bar的trace以上日志将保存到文件中，并且不会打印到控制台。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 </td> 
 <td> <code>&lt;Configuration status=</code><code>"WARN"</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Appenders&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Console name=</code><code>"Console"</code>&nbsp;<code>target=</code><code>"SYSTEM_OUT"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Console&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;RollingFile name=</code><code>"RollingFile"</code>&nbsp;<code>fileName=</code><code>"${sys:user.home}/logs/trace.log"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filePattern=</code><code>"${sys:user.home}/logs/$${date:yyyy-MM}/warn-%d{yyyy-MM-dd}-%i.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/RollingFile&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Appenders&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Loggers&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Logger name=</code><code>"com.foo.Bar"</code>&nbsp;<code>level=</code><code>"trace"</code>&nbsp;<code>additivity=</code><code>"false"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;AppenderRef ref=</code><code>"RollingFile"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Logger&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Root level=</code><code>"error"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;AppenderRef ref=</code><code>"Console"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Root&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Loggers&gt;</code> <code>&lt;/Configuration&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

log4j2支持自动重新配置,如果配置了monitorInterval，那么log4j2每隔一段时间就会检查一遍这个文件是否修改。最小是5s

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 </td> 
 <td> <code>&lt;?xml version=</code><code>"1.0"</code>&nbsp;<code>encoding=</code><code>"UTF-8"</code><code>?&gt;</code> <code>&lt;Configuration monitorInterval=</code><code>"30"</code><code>&gt;</code> <code>...</code> <code>&lt;/Configuration&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

## 三、Appenders ##

### ConsoleAppender ###

将使用 System.out 或 System.err输出到控制台。

可以有如下参数

*  name：Appender的名字
 *  target：SYSTEM\_OUT 或 SYSTEM\_ERR，默认是SYSTEM\_OUT
 *  layout：如何格式化，如果没有默认是%m%n

典型的ConsoleAppender如下

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>&lt;?xml version=</code><code>"1.0"</code>&nbsp;<code>encoding=</code><code>"UTF-8"</code><code>?&gt;</code> <code>&lt;Configuration status=</code><code>"warn"</code>&nbsp;<code>name=</code><code>"MyApp"</code>&nbsp;<code>packages=</code><code>""</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Appenders&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Console name=</code><code>"STDOUT"</code>&nbsp;<code>target=</code><code>"SYSTEM_OUT"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"%m%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Console&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Appenders&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;Loggers&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Root level=</code><code>"error"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;AppenderRef ref=</code><code>"STDOUT"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Root&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Loggers&gt;</code> <code>&lt;/Configuration&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

### RollingFileAppender ###

顾名思义，日志文件回滚，也就是删除最旧的日志文件，默认是3个文件。可以通过DefaultRolloverStrategy设置max参数为多个

![697258-20160822200856636-897062849.png][]

例子如下:

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>&lt;Appenders&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;RollingFile name=</code><code>"RollingFile"</code>&nbsp;<code>fileName=</code><code>"logs/app.log"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filePattern=</code><code>"logs/$${date:yyyy-MM}/app-%d{MM-dd-yyyy}-%i.log.gz"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Pattern&gt;%d %p %c{ </code><code>1</code><code>.} [%t] %m%n&lt;/Pattern&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/PatternLayout&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;TimeBasedTriggeringPolicy /&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;SizeBasedTriggeringPolicy size=</code><code>"250 MB"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;DefaultRolloverStrategy max=</code><code>"20"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/RollingFile&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/Appenders&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

现在说说TimeBasedTriggeringPolicy和SizeBasedTriggeringPolicy的作用。  
第一个是基于时间的rollover，第二个是基于大小的rollover。第二个很容易理解，如果大小大于某个阈值，上面是50MB的时候就会滚动。

TimeBasedTriggeringPolicy中有其中一个参数是interval，表示多久滚动一次。默认是1 hour。modulate=true用来调整时间：比如现在是早上3am，interval是4，那么第一次滚动是在4am，接着是8am，12am...而不是7am

## 四、Layouts ##

这里只描述最常见的PatternLayout！更多看官方文档[Layouts][]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>&lt;RollingFile name=</code><code>"RollingFileError"</code>&nbsp;<code>fileName=</code><code>"${sys:user.home}/logs/error.log"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filePattern=</code><code>"${sys:user.home}/logs/$${date:yyyy-MM}/error-%d{yyyy-MM-dd}-%i.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"ERROR"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;TimeBasedTriggeringPolicy/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;SizeBasedTriggeringPolicy size=</code><code>"50 MB"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;DefaultRolloverStrategy max=</code><code>"20"</code><code>/&gt;</code> <code>&lt;/RollingFile&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

上面的%是什么含义，还有哪些呢？其实最主要的参数还是%d, %p, %l, %m, %n, %X。下面的图是摘取网上的。

![697258-20160822200817573-136548190.png][]

![697258-20160822200828089-22600147.png][]

![697258-20160822200834292-438616619.png][]

%X用来获取MDC记录，这些记录从哪来的？我们可以使用org.apache.logging.log4j.ThreadContext将需要记录的值put进去。（我发现slf的MDC.java的put方法对log4j2不可用，因为底层依赖的是log4j1）

xml中使用%X\{aaa\}取出来：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>&lt;console name=</code><code>"Console"</code>&nbsp;<code>target=</code><code>"SYSTEM_OUT"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"%X{user_id} %X{request_uri} [%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"</code><code>/&gt;</code> <code>&lt;/console&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

对应ThreadContext的文档在[这里][Link 1]

## 五、Filters ##

Filters决定日志事件能否被输出。过滤条件有三个值：ACCEPT(接受), DENY(拒绝) or NEUTRAL(中立).

ACCEP和DENY比较好理解就是接受和拒绝的意思，在使用单个过滤器的时候，一般就是使用这两个值。但是在组合过滤器中，如果用接受ACCEPT的话，日志信息就会直接写入日志文件,后续的过滤器不再进行过滤。所以，在组合过滤器中，接受使用NEUTRAL（中立），被第一个过滤器接受的日志信息，会继续用后面的过滤器进行过滤，只有符合所有过滤器条件的日志信息，才会被最终写入日志文件。

### ThresholdFilter ###

有几个参数：

*  level：将被过滤的级别。
 *  onMatch:默认值是NEUTRAL
 *  onMismatch：默认是DENY

如果LogEvent 中的 Log Level 大于 ThresholdFilter 中配置的 Log Level，那么返回 onMatch 的值， 否则返回 onMismatch 的值，例如 : 如果ThresholdFilter 配置的 Log Level 是 ERROR ， LogEvent 的Log Level 是 DEBUG。 那么 onMismatch 的值将被返回， 因为 ERROR 小于DEBUG。如果是Accept，将自己被接受，而不经过下一个过滤器

下面的例子可以这样理解：如果是INFO级别及其以上，将经过通过第一个过滤，进入第二个，否则是onMismatch：拒绝进入。对于第二个，如果是大于等于WARN(WARN/ERROR/ERROR)，那么将返回onMatch，也就是拒绝，如果是其他情况(也就是INFO)，将是中立情况，因为后面没有其他过滤器，则被接受。最后的结果就只剩下INFO级别的日志。也就符合了RollingFileInfo只记录Info级别的规则。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>&lt;RollingFile name=</code><code>"RollingFileInfo"</code>&nbsp;<code>fileName=</code><code>"${sys:user.home}/logs/info.log"</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>filePattern=</code><code>"${sys:user.home}/logs/$${date:yyyy-MM}/info-%d{yyyy-MM-dd}-%i.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）--&gt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Filters&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"INFO"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;ThresholdFilter level=</code><code>"WARN"</code>&nbsp;<code>onMatch=</code><code>"DENY"</code>&nbsp;<code>onMismatch=</code><code>"NEUTRAL"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Filters&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;PatternLayout pattern=</code><code>"[%d{HH:mm:ss:SSS}] [%p] - %l - %m%n"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;TimeBasedTriggeringPolicy interval=</code><code>"24"</code>&nbsp;<code>modulate=</code><code>"true"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;SizeBasedTriggeringPolicy size=</code><code>"50 MB"</code><code>/&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;/Policies&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;DefaultRolloverStrategy max=</code><code>"20"</code><code>/&gt;</code> <code>&lt;/RollingFile&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

## 六、Lookups ##

提供另外一种方式添加某些特殊的值到日志中。

### Date Lookup ###

与其他lookup不同，它不是通过key去查找值，而是通过SimpleDateFormat验证格式是否有效，然后记录当前时间

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 </td> 
 <td> <code>&lt;RollingFile name=</code><code>"Rolling-${map:type}"</code>&nbsp;<code>fileName=</code><code>"${filename}"</code>&nbsp;<code>filePattern=</code><code>"target/rolling1/test1-$${date:MM-dd-yyyy}.%i.log.gz"</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;PatternLayout&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;pattern&gt;%d %p %c{ </code><code>1</code><code>.} [%t] %m%n&lt;/pattern&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/PatternLayout&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;SizeBasedTriggeringPolicy size=</code><code>"500"</code>&nbsp;<code>/&gt;</code> <code>&lt;/RollingFile&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

### Context Map Lookup: 如记录loginId ###

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>&lt;File name=</code><code>"Application"</code>&nbsp;<code>fileName=</code><code>"application.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;PatternLayout&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;pattern&gt;%d %p %c{ </code><code>1</code><code>.} [%t] $${ctx:loginId} %m%n&lt;/pattern&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/PatternLayout&gt;</code> <code>&lt;/File&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

这个的结果和前面的MDC是一样的，即 %X\{loginId\}

### Environment Lookup：记录系统环境变量 ###

比如可以获取如`/etc/profile`中的变量值

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>&lt;File name=</code><code>"Application"</code>&nbsp;<code>fileName=</code><code>"application.log"</code><code>&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;PatternLayout&gt;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>&lt;pattern&gt;%d %p %c{ </code><code>1</code><code>.} [%t] $${env:USER} %m%n&lt;/pattern&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;/PatternLayout&gt;</code> <code>&lt;/File&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

### System Properties Lookup ###

可以获取Java中的系统属性值。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 </td> 
 <td> <code>&lt;Appenders&gt;</code> <code>&nbsp;&nbsp;</code><code>&lt;File name=</code><code>"ApplicationLog"</code>&nbsp;<code>fileName=</code><code>"${sys:logPath}/app.log"</code><code>/&gt;</code> <code>&lt;/Appenders&gt;</code> </td> 
 </tr> 
 </tbody> 
</table>

和系统属性值有什么区别呢？其实就是System.getProperties();和System.getenv();的区别。下面是一个小例子。

输出（摘取部分）：

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 </td> 
 <td> <code>java.runtime.name=Java(TM) SE Runtime Environment</code> <code>sun.boot.library.path=C:\Program Files\Java\jdk1.</code><code>8</code><code>.0_25\jre\bin</code> <code>java.vm.version=</code><code>25.25</code><code>-b02</code> <code>java.vm.vendor=Oracle Corporation</code> <code>java.vendor.url=http:</code><code>//java.oracle.com/</code> <code>path.separator=;</code> <code>...</code> <code>===================</code> <code>JAVA_HOME=C:\Program Files\Java\jdk1.</code><code>8</code><code>.0_25</code> <code>TEMP=D:\Temp</code> <code>ProgramFiles=C:\Program Files</code> </td> 
 </tr> 
 </tbody> 
</table>

...

可以看到其实Environment是获取环境变量，而System Properties获取的更多是与Java相关的值

[697258-20160822200856636-897062849.png]: /images/20220302/3f26385e653d4846a0d95672e2b2a68d.png
[Layouts]: http://logging.apache.org/log4j/2.x/manual/layouts.html
[697258-20160822200817573-136548190.png]: /images/20220302/b119138964c0465c90349e4c64f5fcbe.png
[697258-20160822200828089-22600147.png]: /images/20220302/8b2c1f688b514acb98be46aba03e75eb.png
[697258-20160822200834292-438616619.png]: /images/20220302/2b983a17665742b9b70779b2a6b89b66.png
[Link 1]: https://logging.apache.org/log4j/2.x/manual/thread-context.html