Log4j2日志滚动策略TimeBasedTriggeringPolicy的魔鬼槽点

￡神魔★判官ぃ 2022-12-27 09:25 134阅读 0赞

`TimeBasedTriggeringPolicy`参数说明：

<table> 
 <thead> 
  <tr> 
   <th>参数名称</th> 
   <th>类型</th> 
   <th>描述</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>interval</td> 
   <td>integer</td> 
   <td>根据日期格式中最具体的时间单位来决定应该多久发生一次rollover。例如，在日期模式中小时为具体的时间单位，那么每4小时会发生4次rollover，默认值为1</td> 
  </tr> 
  <tr> 
   <td>modulate</td> 
   <td>boolean</td> 
   <td>表示是否调整时间间隔以使在时间间隔边界发生下一个rollover。例如：假设小时为具体的时间单元，当前时间为上午3点，时间间隔为4，第一次发送rollover是在上午4点，接下来是上午8点，接着是中午，接着是下午4点等发生。</td> 
  </tr> 
 </tbody> 
</table>

由上图我们展开两个测试用例：

*  case 1：如何实现天粒度切分日志？  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center]
 *  case 2: 如何实现小时粒度（基于秒）切分日志？  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center 1]

所以，log4j2中`TimeBasedTriggeringPolicy`切分文件策略，是基于filePattern中的`%d{yyyy-MM-dd-HH-mm-ss}`来决定到底采用哪种时间单位（天、小时、分钟、秒等）。

那上面两种方式有没有错误呢？？？逻辑上没问题，但是case 2却没有达到我们想要的，我们其实是想要达到凌晨0点切分时间的（而不是推延24小时）。

我们已经指定了 `modulus`（modulus就是modulate）为true，应该以0点自动校准进行文件切分时间规划的，然而，当我们设置了86400秒（也就是24小时）一切分的时候，却没有达到0点切分的目的，而是项目启动的当前时间推算24小时，这是为什么呢？

我们再来看下Log4j2基于时间切分逻辑底层`org.apache.logging.log4j.core.appender.rolling.PatternProcessor`判断逻辑(部分截图)：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center 2]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center 3]  
我们再进入`increment`函数查看下实现：  
![在这里插入图片描述][20201210133020678.png_pic_center]

哦~原来如此，当我们指定了`modulus`时，它是根据我们的filePattern最后一位为基准0进行推延计算的。

也就是说，我们可以得出来如下的表格：

<table> 
 <thead> 
  <tr> 
   <th>filePattern</th> 
   <th>increment</th> 
   <th>prevFileTime（采用非时间戳方式表示）</th> 
   <th>nextFileTime（采用非时间戳方式表示）</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>yyyy-MM-dd-HH-mm-ss</td> 
   <td>7200</td> 
   <td>2020-12-10-12-56-35</td> 
   <td>2020-12-10-14-56-00</td> 
  </tr> 
  <tr> 
   <td>yyyy-MM-dd-HH-mm</td> 
   <td>120</td> 
   <td>2020-12-10-12-56-35</td> 
   <td>2020-12-10-14-00-00</td> 
  </tr> 
  <tr> 
   <td>yyyy-MM-dd-HH</td> 
   <td>2</td> 
   <td>2020-12-10-12-56-35</td> 
   <td>2020-12-10-14-00-00</td> 
  </tr> 
  <tr> 
   <td>yyyy-MM-dd</td> 
   <td>1</td> 
   <td>2020-12-10-12-56-35</td> 
   <td>2020-12-11-00-00-00</td> 
  </tr> 
  <tr> 
   <td>yyyy-MM</td> 
   <td>1</td> 
   <td>2020-12-10-12-56-35</td> 
   <td>2021-01-01-00-00-00</td> 
  </tr> 
  <tr> 
   <td>yyyy</td> 
   <td>1</td> 
   <td>2020-12-10-12-56-35</td> 
   <td>2021-01-01-00-00-00</td> 
  </tr> 
 </tbody> 
</table>

所以，这种略有些逆人性的实现逻辑，真的很容易踩坑。

但是说到底还是对log4j2切分策略不够熟悉，导致使用上有所偏差。

等后面有空，再对log4j2的disruptor使用也进行详细总结~

### 拓展 ###

\[1\]. [Logback如何按天切分日志][Logback]  
\[2\]. [Log4j2的Policy触发策略与Strategy滚动策略配置详解][Log4j2_Policy_Strategy]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/9e61c6defc764f1bbc01525e4e52849a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/563d3028810941788990508da46626bf.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221120/c72bb068217c4e02b4c169d939f74e0b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzE3Nzc2Mjg3_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221120/f4d357df102243bbada4f3ad9204b7b5.png
[20201210133020678.png_pic_center]: /images/20221120/44d1f8c02b3c4133b5dbf5d98ef534ff.png
[Logback]: https://www.cnblogs.com/javastack/p/9082868.html
[Log4j2_Policy_Strategy]: https://thinkwon.blog.csdn.net/article/details/101628222?utm_medium=distribute.pc_relevant.none-task-blog-OPENSEARCH-3.not_use_machine_learn_pai&depth_1-utm_source=distribute.pc_relevant.none-task-blog-OPENSEARCH-3.not_use_machine_learn_pai