TimeBasedRollingPolicy详解

TimeBasedRollingPolicy是rollingPolicy中最常见的轮转策略,它同时实现了RollingPolicy 和 TriggeringPolicy 接口。

属性

1. fileNamePattern(必填)

String类型,该属性定义了轮转时的属性名。它的值应该由文件名加上一个%d的占位符。%d应该包含java.text/SimpleDateFormat中规定的日期格式。如果忽略掉这个日期格式,默认文yyyy-MM-dd。轮转周期通过fileNamePattern推断出来的。可以指定多个 %d,但是只能有一个是主要的,用于推断轮转周期。其它的 %d 占位符必须通过 'aux' 标记为辅助的。还可以通过 aFloder/test.%d{yyyy-MM-dd-HH, UTC}.log 来指定一个时区,如果指定的 timezone 不能被识别或者拼写错误,将会根据TimeZone.getTimeZone(String)方法指定为 GMT。

轮询实例

/wombat/foo.%d

每天轮转(晚上零点)。由于省略了指定 %d 的日期格式,所以默认为?yyyy-MM-dd。

/wombat/%d{yyyy/MM}/foo.txt:

每个月开始的时候轮转。

/wombat/foo.%d{yyyy-ww}.log:

每周的第一天(取决于时区)轮转。

/wombat/foo%d{yyyy-MM-dd_HH}.log:

每小时轮转。

/wombat/foo%d{yyyy-MM-dd_HH-mm}.log:

每分钟轮转。

/wombat/foo%d{yyyy-MM-dd_HH-mm, UTC}.log:

每分钟轮转,时间格式为UTC。

/foo/%d{yyyy-MM, aux}/%d.log:

每天轮转。

2. maxHistory

int类型,可选属性,用来控制最多保留多少数量的归档文件,将会异步删除旧的文件。当旧的归档文件被移除时,当初用来保存这些日志归档文件的文件夹也会在适当的时候被移除。比如,你指定按月轮转,指定 maxHistory = 6,那么 6 个月内的归档文件将会保留在文件夹内,大于 6 个月的将会被删除。

3. totalSizeCap

int类型,可选属性,用来控制所有归档文件总的大小。当达到这个大小后,旧的归档文件将会被异步的删除。使用这个属性时还需要设置 maxHistory 属性。而且,maxHistory 将会被作为第一条件,该属性作为第二条件。

4. cleanHistoryOnStart

boolean类型,如果设置为 true,那么在 appender 启动的时候,归档文件将会被删除。默认的值为 false。
归档文件的删除通常在轮转期间执行。但是,有些应用的存活时间可能等不到轮转触发。对于这种短期应用,可以通过设置该属性为 true,在 appender 启动的时候执行删除操作。

实例

<!-- 滚动文件的方式生成日志日志文件,文件的存储位置通过file标签指定 -->
<!-- 通过encoder指定日志的生成格式,每个appender的日志格式都可以自定义,不用相同 -->
<appender name="file" class="ch.qos.logback.core.rolling.RollingFileAppender">
    <file>/logback/log/test.log</file>
	<encoder>
    	<pattern>【logbck】%blue([requestId:%X{requestId:-syslogId}]) %d{yyyy-MM-dd HH:mm:ss.SSS} %red([%thread]) %5level - %msg%n</pattern>
    </encoder>
    <!-- 
    通过rollingPolicy设置日志滚动的策略,这是使用按照时间滚动
    fileNamePattern属性设置滚动生成文件的格式,这里设置的精确到天,也就是按照天滚动,如果时间设置精确到秒,就按秒来滚动
    maxHistory属性设定最大的文件数,比如按天滚动,这里设置了30天,在第31天日志生成的时候,第一天的日志就会被删掉
    -->
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
		<!--设置按天来滚动,前一天日志打印到23点59分,然后就一直没有请求日志,直到次日的1点才有新的日志进入。
                在0点到1点这个时间段,日志文件是不会滚动生成新的日志文件。因为滚动的动作是需要日志写入动作来触发。-->
    	<fileNamePattern>/logback/log/test-%d{yyyy-MM-dd}.log</fileNamePattern>
        <maxHistory>30</maxHistory>
    </rollingPolicy>
</appender>

版权声明:本文为JAVASCHOOL原创文章,未经本站允许不得转载。