实际生产中,每天都有大量的日志生成,单个文件(FileAppender)已经不能满足要求,RollingFileAppender继承了FileAppender,并提供了更多的功能:

  • 每天生成一个日志文件
  • 将前一天的日志重命名为包含日期的格式
  • 根据需要,删除过期历史日志

配置

和 logback系列之二:输出日志到文件 类似,改动的地方:

1. logback[-test].xml文件:

Java代码  
  1. <appender name="rollingAppender" class="ch.qos.logback.core.rolling.RollingFileAppender">
  2. <file>/logs/heuristic.log</file>
  3. <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
  4. <fileNamePattern>/logs/heuristic-%d{yyyy-MM-dd}.log</fileNamePattern>
  5. <maxHistory>30</maxHistory>
  6. </rollingPolicy>
  7. <encoder><!-- 必须指定,否则不会往文件输出内容 -->
  8. <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>
  9. </encoder>
  10. <append>false</append>
  11. <prudent>false</prudent>
  12. </appender>
  13. <root level="DEBUG">
  14. <appender-ref ref="rollingAppender" />
  15. </root>

调用测试类的方法,生成heuristic-2013-11-16.log文件。

源码分析

a. 如果指定了file属性,当天的文件名为file属性值(/logs/heuristic.log):

ch.qos.logback.core.rolling.RollingFileAppender类

Java代码  
  1. public void start() {
  2. ...
  3. currentlyActiveFile = new File(getFile()); // 获取日志文件名
  4. }
  5. public String getFile() {
  6. return rollingPolicy.getActiveFileName(); // 从滚动策略获取
  7. }

上面logback[-test].xml的rollingPolicy配置为 
ch.qos.logback.core.rolling.TimeBasedRollingPolicy类

看下实现:

Java代码  
  1. public String getActiveFileName() {
  2. String parentsRawFileProperty = getParentsRawFileProperty();
  3. if (parentsRawFileProperty != null) { // logback.xml指定了file属性
  4. return parentsRawFileProperty; // 使用file值
  5. } else {
  6. return timeBasedFileNamingAndTriggeringPolicy
  7. .getCurrentPeriodsFileNameWithoutCompressionSuffix();
  8. }
  9. }
  10. public String getParentsRawFileProperty() {
  11. return parent.rawFileProperty();
  12. }

ch.qos.logback.core.FileAppender类

Java代码  
  1. final public String rawFileProperty() {
  2. return fileName;
  3. }

b. 必须指定TriggeringPolicy<E>和RollingPolicy,否则不会打印日志:

看下 
ch.qos.logback.core.rolling.RollingFileAppender类 :

Java代码  
  1. public void start() {
  2. if (triggeringPolicy == null) {
  3. addWarn("No TriggeringPolicy was set for the RollingFileAppender named "
  4. + getName());
  5. addWarn("For more information, please visit "+CODES_URL+"#rfa_no_tp");
  6. return;
  7. }
  8. if (rollingPolicy == null) {
  9. addError("No RollingPolicy was set for the RollingFileAppender named "
  10. + getName());
  11. addError("For more information, please visit "+CODES_URL+"rfa_no_rp");
  12. return;
  13. }

TimeBasedRollingPolicy类实现了上面的两个接口,triggeringPolicy和rollingPolicy都指向TimeBasedRollingPolicy的实例对象。

c. 如果file指定,前一天的文件名改为fileNamePattern的值(/logs/heuristic-2013-11-15.log)。

通过设置TimeBasedRollingPolicy的 maxHistory属性 ,可以控制已产生日志的数量。如果maxHistory设置为30,那么超过30天的log文件会被自动删除,这是通过RollingFileAppender的 rollover() 方法来实现的。

该方法会调用 
ch.qos.logback.core.rolling.TimeBasedRollingPolicy类  
的rollover方法:

Java代码  
  1. public void rollover() throws RolloverFailure {
  2. // 当此方法调用时,假定前一天日志文件已经关闭
  3. String elapsedPeriodsFileName = timeBasedFileNamingAndTriggeringPolicy
  4. .getElapsedPeriodsFileName();
  5. String elpasedPeriodStem = FileFilterUtil.afterLastSlash(elapsedPeriodsFileName);
  6. if (compressionMode == CompressionMode.NONE) {
  7. if (getParentsRawFileProperty() != null) {
  8. renameUtil.rename(getParentsRawFileProperty(), elapsedPeriodsFileName); // file指定,重命名为fileNamePattern格式。如果目标文件存在,则重命名失败
  9. } // else { nothing to do if CompressionMode == NONE and parentsRawFileProperty == null }
  10. } else {
  11. if (getParentsRawFileProperty() == null) {
  12. future = asyncCompress(elapsedPeriodsFileName, elapsedPeriodsFileName, elpasedPeriodStem); // file未指定,异步压缩
  13. } else {
  14. future = renamedRawAndAsyncCompress(elapsedPeriodsFileName, elpasedPeriodStem); // file指定,重命名并异步压缩
  15. }
  16. }
  17. if (archiveRemover != null) {
  18. archiveRemover.clean(new Date(timeBasedFileNamingAndTriggeringPolicy.getCurrentTime())); // 删除历史日志
  19. }
  20. }

默认的archiveRemover为 ch.qos.logback.core.rolling.helper.DefaultArchiveRemover抽象类 :

Java代码  
  1. public void clean(Date now) {
  2. long nowInMillis = now.getTime();
  3. int periodsElapsed = computeElapsedPeriodsSinceLastClean(nowInMillis);
  4. lastHeartBeat = nowInMillis;
  5. if (periodsElapsed > 1) {
  6. addInfo("periodsElapsed = " + periodsElapsed);
  7. }
  8. // 从待删除日志的终止日期开始,每次回退一天,删除过期日志
  9. for (int i = 0; i < periodsElapsed; i++) {
  10. cleanByPeriodOffset(now, periodOffsetForDeletionTarget - i);
  11. }
  12. }
  13. public void setMaxHistory(int maxHistory) {
  14. // 待删除日志的终止日期:回退(maxHistory+1)天
  15. this.periodOffsetForDeletionTarget = -maxHistory - 1;
  16. }

cleanByPeriodOffset为抽象方法,这里交由 
ch.qos.logback.core.rolling.helper.TimeBasedArchiveRemover子类 实现:

Java代码  
  1. protected void cleanByPeriodOffset(Date now, int periodOffset) {
  2. Date date2delete = rc.getRelativeDate(now, periodOffset); // 计算需要删除日志的日期
  3. String filename = fileNamePattern.convert(date2delete);
  4. File file2Delete = new File(filename);
  5. if (file2Delete.exists() && file2Delete.isFile()) {
  6. file2Delete.delete(); // 删除文件
  7. addInfo("deleting " + file2Delete);
  8. if (parentClean) {
  9. removeFolderIfEmpty(file2Delete.getParentFile());
  10. }
  11. }
  12. }

d. 如果要启用压缩,需要将fileNamePattern的后缀名设置为压缩格式,如:/logs/heuristic-%d{yyyy-MM-dd}.zip。

看下 ch.qos.logback.core.rolling.RollingPolicyBase类 相关的代码:

Java代码  
  1. protected void determineCompressionMode() {
  2. if (fileNamePatternStr.endsWith(".gz")) {
  3. addInfo("Will use gz compression");
  4. compressionMode = CompressionMode.GZ;
  5. } else if (fileNamePatternStr.endsWith(".zip")) {
  6. addInfo("Will use zip compression");
  7. compressionMode = CompressionMode.ZIP;
  8. } else { // 如果后缀名不是.gz或.zip,不会启用压缩
  9. addInfo("No compression will be used");
  10. compressionMode = CompressionMode.NONE;
  11. }
  12. }

e. RollingFileAppender保证append的值为true,这样当天先写入的日志内容就不会丢失

ch.qos.logback.core.rolling.RollingFileAppender类 的start()方法:

Java代码  
  1. if (!append) { // append为false时
  2. addWarn("Append mode is mandatory for RollingFileAppender");
  3. append = true; // 改成true
  4. }

f. prudent模式不支持file设定;如果启用了压缩,logback将不会记录日志

ch.qos.logback.core.rolling.RollingFileAppender类  
的start()方法:

Java代码  
  1. if (isPrudent()) { // 安全模式,但效率低
  2. if (rawFileProperty() != null) {
  3. addWarn("Setting \"File\" property to null on account of prudent mode");
  4. setFile(null); // 取消file属性设置
  5. }
  6. if (rollingPolicy.getCompressionMode() != CompressionMode.NONE) { // 启用了压缩
  7. addError("Compression is not supported in prudent mode. Aborting");
  8. return; // 返回,不会进行后面的记录日志操作
  9. }
  10. }

logback系列之四:输出日志到不同文件相关推荐

  1. logback之三:输出日志到文件(滚动)

    实际生产中,每天都有大量的日志生成,单个文件(FileAppender)已经不能满足要求,RollingFileAppender继承了FileAppender,并提供了更多的功能: 每天生成一个日志文 ...

  2. 大剑无锋之后台运行程序并输出日志到某文件【面试推荐】

    第一种: # ./pso > pso.file 2>&1 & 解释:将pso直接放在后台运行,并把终端输出存放在当前目录下的pso.file文件中. 当客户端关机后重新登陆 ...

  3. logback系列之二:输出日志到文件

    2019独角兽企业重金招聘Python工程师标准>>> 和 logback系列之一:输出日志到控制台 类似,改动的地方: 1. logback[-test].xml文件: Java代 ...

  4. slf4j + logback 输出日志:mybatis sql语句

    1 引入jar包:maven resposity 中 选择logback classic module <dependency> <groupId>ch.qos.logback ...

  5. log4j和logback的冲突导致日志输出异常

    2019独角兽企业重金招聘Python工程师标准>>> 前一阵在在项目中碰到一个日志问题.工程使用的是log4j,log4j.xml中也配置了工程日志路径和策略,并把日志级别定为wa ...

  6. Spring Boot 使用 Log4j2 Logback 输出日志到 EKL

    文章目录 1.ELK 介绍 2.环境.软件准备 3.ELK 环境搭建 4.Spring Boot 配置示例 4.1.Log4j2 方式配置 4.2.Logback 方式配置 1.ELK 介绍 ELK ...

  7. logback之二:输出日志到控制台

    和logack之一:输出日志到控制台 类似,改动的地方: 1. logback[-test].xml文件: Java代码   <appender name="fileAppender& ...

  8. python 日志输出为json格式文件_Py修行路 python基础 (二十一)logging日志模块 json序列化 正则表达式(re)...

    一.日志模块 两种配置方式:1.config函数 2.logger #1.config函数 不能输出到屏幕 #2.logger对象 (获取别人的信息,需要两个数据流:文件流和屏幕流需要将数据从两个数据 ...

  9. logback出现大量XXX_IS_UNDEFINED日志文件的问题

    前言 在spring boot中采用logback将日志打印到文件时,你是否遇到过文件名为XXX_IS_UNDEFINED的情况,今天带大家一块分析解决这个问题. 一.logback中spring属性 ...

最新文章

  1. centos的nginx支持ssl
  2. Java中抽象类和接口
  3. jquery1.9+获取append后的动态元素
  4. ReactNative 导航栏Navigator的使用及参数navigator的传递
  5. html查看今天星期几,jquery怎么获取星期几
  6. synchronized实现原理之---Moniter的实现原理
  7. Allegro对不规则outline处理
  8. 智能座舱之HUD-发展趋势深度解析
  9. OSPF多实例路由防环检测功能介绍
  10. 使用visio来进行画类图
  11. wps表格怎么按特定的顺序对数据进行排序
  12. 2020040920200418知交零落实是人生常态
  13. 怎么写功能测试报告,分享专业的功能报告模板
  14. 光伏辐照和发电功率数据集
  15. 大数据正在改变我们的生活
  16. ES的插入优化之bulk
  17. Oracle oo4o vs2010 c++
  18. Eclipse 简介和插件开发天气预报
  19. BDP数据可视化 - 散点图
  20. 中介分水岭 机构大数据风生水起

热门文章

  1. 2017 终点亦是起点
  2. matlab 工具箱 径向基,精确径向基(matlab工具箱)
  3. RA病人关节残障与软骨破坏而非骨破坏相关
  4. SSL2668 2017年8月7日提高组T1 根(dfs)
  5. 【Python学习笔记】6:用Gauss-Legendre求积公式近似求积分值
  6. Credly 数字证书
  7. PHP 文档标签添加 间隔符“多空格”处理
  8. 图的度序列:Havel定理
  9. python实现qq登录腾讯视频_QQ腾讯视频爬取和qv_rmt限速算法python版
  10. 金仓数据库KingbaseES客户端编程接口指南-ODBC(6. KingbaseES ODBC 的扩展属性)