详解Log4j2中的RollingFileAppender

目录

一、什么是RollingFile

二、TriggeringPolicy

SizeBasedTriggeringPolicy

TimeBasedTriggeringPolicy

CompositeTriggeringPolicy

三、DefaultRolloverStrategy

四、DeleteAction

五、程序测试demo

六、参考资料


一、什么是RollingFile

RollingFileAppender是Log4j2中的一种能够实现日志文件滚动更新(rollover)的Appender。

rollover的意思是当满足一定条件(如文件达到了指定的大小,达到了指定的时间)后,就重命名原日志文件进行归档,并生成新的日志文件用于log写入。如果还设置了一定时间内允许归档的日志文件的最大数量,将对过旧的日志文件进行删除操作。

RollingFile实现日志文件滚动更新,依赖于TriggeringPolicy和RolloverStrategy。

其中,TriggeringPolicy为触发策略,其决定了何时触发日志文件的rollover,即When。

RolloverStrategy为滚动更新策略,其决定了当触发了日志文件的rollover时,如何进行文件的rollover,即How。

Log4j2提供了默认的rollover策略DefaultRolloverStrategy。

下面通过一个log4j2.xml文件配置简单了解RollingFile的配置。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="warn">

  <Appenders>

    <RollingFile name="RollingFile" fileName="logs/app.log"

                 filePattern="logs/app-%d{yyyy-MM-dd HH}.log">

      <PatternLayout>

        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>

      </PatternLayout>

      <Policies>

        <TimeBasedTriggeringPolicy interval="1"/>

        <SizeBasedTriggeringPolicy size="250MB"/>

      </Policies>

    </RollingFile>

  </Appenders>

  <Loggers>

    <Root level="error">

      <AppenderRef ref="RollingFile"/>

    </Root>

  </Loggers>

</Configuration>

上述配置文件中配置了一个RollingFile,日志写入logs/app.log文件中,每经过1小时或者当文件大小到达250M时,按照app-2017-08-01 12.log的格式对app.log进行重命名并归档,并生成新的文件用于写入log。

其中,fileName指定日志文件的位置和文件名称(如果文件或文件所在的目录不存在,会创建文件。)

filePattern指定触发rollover时,文件的重命名规则。filePattern中可以指定类似于SimpleDateFormat中的date/time pattern,如yyyy-MM-dd HH,或者%i指定一个整数计数器。

TimeBasedTriggeringPolicy指定了基于时间的触发策略。
SizeBasedTriggeringPolicy指定了基于文件大小的触发策略。

二、TriggeringPolicy

RollingFile的触发rollover的策略有CronTriggeringPolicy(Cron表达式触发)、OnStartupTriggeringPolicy(JVM启动时触发)、SizeBasedTriggeringPolicy(基于文件大小)、TimeBasedTriggeringPolicy(基于时间)、CompositeTriggeringPolicy(多个触发策略的混合,如同时基于文件大小和时间)。

其中,SizeBasedTriggeringPolicy(基于日志文件大小)、TimeBasedTriggeringPolicy(基于时间)或同时基于文件大小和时间的混合触发策略最常用。

SizeBasedTriggeringPolicy

SizeBasedTriggeringPolicy规定了当日志文件达到了指定的size时,触发rollover操作。size参数可以用KB、MB、GB等做后缀来指定具体的字节数,如20MB。

<SizeBasedTriggeringPolicy size="250MB"/>

TimeBasedTriggeringPolicy

TimeBasedTriggeringPolicy规定了当日志文件名中的date/time pattern不再符合filePattern中的date/time pattern时,触发rollover操作。

比如,filePattern指定文件重命名规则为app-%d{yyyy-MM-dd HH}.log,文件名为app-2017-08-25 11.log,当时间达到2017年8月25日中午12点(2017-08-25 12),将触发rollover操作。

参数名

类型

描述

interval integer

此参数需要与filePattern结合使用,规定了触发rollover的频率,默认值为1。假设interval为4,若filePattern的date/time pattern的最小时间粒度为小时(如yyyy-MM-dd HH),则每4小时触发一次rollover;若filePattern的date/time pattern的最小时间粒度为分钟(如yyyy-MM-dd HH-mm),则每4分钟触发一次rollover。

modulate boolean

指明是否对interval进行调节,默认为false。若modulate为true,会以0为开始对interval进行偏移计算。例如,最小时间粒度为小时,当前为3:00,interval为4,则以后触发rollover的时间依次为4:00,8:00,12:00,16:00,...。

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

<?xml version="1.0" encoding="UTF-8"?>

<Configuration status="warn" name="MyApp" packages="">

  <Appenders>

    <RollingFile name="RollingFile" fileName="logs/app.log"

                 filePattern="logs/app-%d{yyyy-MM-dd HH}-%i.log">

      <PatternLayout>

        <Pattern>%d %p %c{1.} [%t] %m%n</Pattern>

      </PatternLayout>

      <Policies>

        <TimeBasedTriggeringPolicy />

        <SizeBasedTriggeringPolicy size="250 MB"/>

      </Policies>

    </RollingFile>

  </Appenders>

  <Loggers>

    <Root level="error">

      <AppenderRef ref="RollingFile"/>

    </Root>

  </Loggers>

</Configuration>

上述配置文件中,filePattern中yyyy-MM-dd HH最小时间粒度为小时,TimeBasedTriggeringPolicy中interval使用默认值1,将每1小时触发一次rollover。

若将filePattern改为filePattern=“logs/app-%d{yyyy-MM-dd HH-mm}-%i.log”,yyyy-MM-dd HH-mm最小时间粒度为分钟,将每1分钟触发一次rollover。

CompositeTriggeringPolicy

将多个TriggeringPolicy放到Policies中表示使用复合策略

<Policies>

    <TimeBasedTriggeringPolicy />

    <SizeBasedTriggeringPolicy size="250 MB"/>

</Policies>

如上,同时使用了TimeBasedTriggeringPolicy、SizeBasedTriggeringPolicy,有一个条件满足,就会触发rollover。

三、DefaultRolloverStrategy

DefaultRolloverStrategy指定了当触发rollover时的默认策略。

DefaultRolloverStrategy是Log4j2提供的默认的rollover策略

  • 2
    点赞
  • 14
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
log4j 是一个用于日志记录的 Java 库。它提供了灵活的配置选项,可以根据不同的需求来记录日志消息。下面是 log4j 的配置详解: 1. Logger 层次结构:log4j 使用 logger 层次结构来管理日志消息。根据需要,可以创建多个 logger,并设置不同的级别和输出目标。logger 继承了其父 logger 的所有设置。 2. 日志级别:log4j 支持多种日志级别,包括 TRACE、DEBUG、INFO、WARN、ERROR 和 FATAL。可以根据需要设置不同的级别。例如,如果将日志级别设置为 WARN,那么仅记录 WARN、ERROR 和 FATAL 级别的消息。 3. AppenderAppender 用于指定日志消息的输出目标。log4j 提供了多种 Appender,包括 ConsoleAppender(将日志消息输出到控制台)、FileAppender(将日志消息输出到文件)、RollingFileAppender(将日志消息输出到滚动的文件)等。 4. 格式化器(Layout):格式化器用于定义日志消息的输出格式。log4j 提供了多种格式化器,例如 PatternLayout(按照指定的模式输出日志消息)、SimpleLayout(简单的输出格式)等。 5. 配置文件:log4j 的配置信息通常通过一个 XML 或属性文件进行配置。在配置文件,可以设置 loggerappender、layout 等相关属性。 下面是一个简单的 log4j 配置示例: ```xml <?xml version="1.0" encoding="UTF-8"?> <log4j:configuration xmlns:log4j="http://jakarta.apache.org/log4j/"> <appender name="consoleAppender" class="org.apache.log4j.ConsoleAppender"> <layout class="org.apache.log4j.PatternLayout"> <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss} %-5p %c{1}:%L - %m%n"/> </layout> </appender> <logger name="com.example"> <level value="DEBUG"/> <appender-ref ref="consoleAppender"/> </logger> </log4j:configuration> ```

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值