springboot项目按天分割日志实践

引言

在大型分布式系统中，日志作为系统运行状态的重要记录，其管理与分析对于故障排查、性能监控和业务洞察具有至关重要的作用。为了保证日志数据的有效组织与存储，按天分割日志成为一种常见的日志管理策略。本文将详细介绍如何在Spring Boot项目中利用Logback实现日志按天滚动，并探讨相关配置技巧与最佳实践。

一、Spring Boot日志体系概述

Spring Boot默认集成了SLF4J作为日志门面，并推荐使用Logback作为其底层日志实现。Logback以其高性能、灵活配置与丰富功能备受开发者青睐，尤其在日志切割、过滤、输出等方面表现出色。要实现按天分割日志，我们将主要围绕Logback的配置文件logback-spring.xml或logback.xml展开。

二、按天分割日志原理与配置

日志滚动策略：Logback通过RollingFileAppender支持日志文件的滚动（rollover）。当满足特定条件时，如文件大小达到上限或到达某个时间点，旧的日志文件会被关闭，新的日志文件被创建以继续记录日志。我们要实现按天分割，就需要设置滚动策略为基于时间。
配置示例：以下是一个典型的Logback配置片段，展示了如何设置按天滚动的日志文件：

1.添加application.properties配置

log.path=logs
log.level=info
log.name=app

2.配置Logback.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
scan：当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true。
scanPeriod：设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒当scan为true时，此属性生效。默认的时间间隔为1分钟。
debug：当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。
-->
<configuration scan="false" scanPeriod="60 seconds" debug="false"><!-- 彩色日志 --><!-- 彩色日志依赖的渲染类 --><conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" /><conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" /><conversionRule conversionWord="wEx"converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" /><!-- 彩色日志格式 --><property name="CONSOLE_LOG_PATTERN"value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%thread]){faint} %clr(%-40.40logger{39}){cyan} %clr([%L]) %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" /><!-- 定义日志文件的存储地址，勿在logback配置文件中使用相对路径.通过springProperty可以在properties文件设置相关path,level,name信息application.properties中定义的变量，在logback的xml文件中无法直接读取，必须要增加springProperty属性中转一下，source属性里放的值是application.properties中定义的--><springProperty name="log.path" source="log.path" /><springProperty name="log.level" source="log.level" /><springProperty name="log.name" source="log.name" /><!-- 定义日志文件名格式化,定义到哪个维度则按哪个维度切割日志，只支持每周，每天，每个小时，每分钟等创建一个文件 yyyy-MM-dd-HH-mm 分钟维度 --><property name="log.timeFormat" value="yyyy-MM-dd" /><!-- 定义日志文件的输出格式。%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度，%logger{50} 表示logger名字最长50个字符，否则按照句点分割。%msg：日志消息，%n是换行符 --><property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n" /><!-- 定义日志文件保留天数，单位和log.timeFormat定义的最小维度保持一致，上面定义到天，则单位默认为天 --><property name="log.maxHistory" value="30" /><!-- 控制台输出 --><appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><pattern>${log.pattern}</pattern></encoder></appender><!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件，并按照每天生成日志文件 --><appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}/${log.name}.log</file><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>${log.level}</level></filter><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!--    滚动时产生的文件的存放位置及文件名称 %d{yyyy-MM-dd}：按天进行日志滚动%i：当文件大小超过maxFileSize时，按照i进行文件滚动 为了保证不重复--><FileNamePattern>${log.path}/${log.name}.%d{${log.timeFormat}}.log</FileNamePattern><MaxHistory>${log.maxHistory}</MaxHistory></rollingPolicy><encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder"><pattern>${log.pattern}</pattern></encoder></appender><!-- 日志输出级别，root与logger是父子关系，没有特别定义则默认为root，任何一个类只会和一个logger对应，要么是定义的logger，要么是root，判断的关键在于找到这个logger，然后判断这个logger的appender和level。 --><root level="${log.level}"><appender-ref ref="STDOUT" /><appender-ref ref="FILE" /></root>
</configuration>

上述配置中：

<file>标签指定了基础日志文件名。
<rollingPolicy>标签设置了滚动策略：
- <fileNamePattern>决定了滚动后新日志文件的命名规则，其中 %d{yyyy-MM-dd} 表示按天替换，生成的日志文件名将形如 app.2024-04-22.log。
- <maxHistory>限制了保留的历史日志文件数量，此处设置为保留最近30天的日志。
<encoder>标签定义了日志输出格式，可根据需要调整。
<root>标签将FILE appender应用于全局日志记录，级别为info及以上。

三、高级配置与优化

按级别分离日志：除了按天分割，有时还需要将不同级别的日志（如INFO、ERROR）输出到不同的文件。可以通过定义多个RollingFileAppender，分别配置不同的filter和fileNamePattern来实现。
压缩与清理：为了节省磁盘空间，可以启用日志文件压缩。在TimeBasedRollingPolicy中添加<timeBasedFileNamingAndTriggeringPolicy>标签，并设置<compressionMode>为gzip。此外，可以使用第三方工具（如logrotate）定期清理过期的日志文件。
异步写入：对于高并发场景，可以启用AsyncAppender以异步方式写入日志，减少同步写入对主线程的影响。配置时，将AsyncAppender作为中间层，引用实际的RollingFileAppender。