springboot日志归档

logback-spring.xml配置示例(主要是文件归档)

<?xml version="1.0" encoding="utf-8"?>
<!--
根节点<configuration>,包含下面三个属性:
scan: 当此属性设置为true时,配置文件如果发生改变,将会被重新加载,默认值为true。
scanPeriod: 设置监测配置文件是否有修改的时间间隔,如果没有给出时间单位,默认单位是毫秒。当scan为true时,此属性生效。默认的时间间隔为1分钟。
debug: 当此属性设置为true时,将打印出logback内部日志信息,实时查看logback运行状态。默认值为false。
-->
<configuration xmlns="http://ch.qos.logback/xml/ns/logback"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="http://ch.qos.logback/xml/ns/logback
                https://raw.githubusercontent.com/enricopulatzo/logback-XSD/master/src/main/xsd/logback.xsd">
    <!-- 从 application.yaml 中获取应用名称 -->
    <springProperty name="appName" source="spring.application.name" defaultValue="defaultAppName" />

    <property name="log-pattern" value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } [%10.10t] %-40.40logger{39} : %m%n"/>

    <!-- 定义控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log-pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 定义保存文件滚动策略 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./log/${appName}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>./log/%d{yyyy-MM-dd}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>30</maxHistory>
            <totalSizeCap>100GB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${log-pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>


    <!-- 将控制台输出和保存文件两个 appender 绑定到 root logger -->
    <root level="info">
        <appender-ref ref="CONSOLE"/>
        <appender-ref ref="FILE"/>
    </root>
</configuration>

每个日志文件的最大大小为 10MB,最大历史文件数量为 30 个,总存储空间上限为 100GB。每天会生成一个新的子目录,子目录的命名格式为 yyyy-MM-dd

注:
springboot默认的日志输出格式如下,其中包含了彩色字体渲染,上面的logback-spring.xml使用了springboot的默认格式,但是去掉了彩色渲染

%clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}

2023.08.08更新
使用异步Appender包装

<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns="http://ch.qos.logback/xml/ns/logback"
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xsi:schemaLocation="http://ch.qos.logback/xml/ns/logback
                https://raw.githubusercontent.com/enricopulatzo/logback-XSD/master/src/main/xsd/logback.xsd">
    <!-- 根节点配置 -->
    <springProperty name="appName" source="spring.application.name" defaultValue="defaultAppName" />
    <property name="log-pattern" value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } [%10.10t] %-40.40logger{39} : %m%n" />

    <!-- 定义异步Appender -->
    <appender name="ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="FILE" />
        <!--
        指定异步队列的大小,即可以容纳的最大未处理的日志消息数量。当队列满时,新的日志消息将被阻塞或丢弃,取决于discardingThreshold的配置。在这里,队列大小设置为512
        -->
        <queueSize>512</queueSize>

        <!--
        指定当队列已满时的丢弃阈值。当队列中未处理的日志消息数量达到丢弃阈值时,新的日志消息将被丢弃。discardingThreshold的值可以是正整数或者-1,表示不丢弃任何日志消息。在这里,丢弃阈值设置为0,即当队列已满时,不会丢弃任何日志消息。
        -->
        <discardingThreshold>0</discardingThreshold>
    </appender>

    <!-- 定义控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log-pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 定义保存文件滚动策略 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./log/${appName}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>./log/%d{yyyy-MM-dd}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>1MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>20</maxHistory>
            <totalSizeCap>10MB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${log-pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 将异步Appender和控制台输出Appender绑定到root logger -->
    <root level="info">
        <appender-ref ref="ASYNC" />
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

参考
logback异步日志AsyncAppender配置_loophome的博客-CSDN博客

=======================

2024.1.3更新
可以直接引入spring的defaults.xml,使用其定义的变量,如控制台输出格式 ${CONSOLE_LOG_PATTERN}

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

<configuration scan="true" scanPeriod="60 seconds" debug="false">

    <include resource="org/springframework/boot/logging/logback/defaults.xml" />

    <springProperty scope="context" name="application.name" source="spring.application.name"/>

    <!--输出到控制台-->
    <appender name="console" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
            <!-- 设置字符集 -->
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <root level="info">
        <appender-ref ref="console"/>
    </root>

</configuration>

3.15更新
warn级别以上的日志单独保存到另外文件
需要使用新的AsyncAppender

<?xml version="1.0" encoding="utf-8"?>
<configuration scan="true" scanPeriod="60 seconds" debug="false">>
    <!-- 根节点配置 -->
    <springProperty name="appName" source="spring.application.name" defaultValue="defaultAppName" />

    <include resource="org/springframework/boot/logging/logback/defaults.xml" />
    <property name="log-pattern" value="%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd HH:mm:ss.SSS}} ${LOG_LEVEL_PATTERN:-%5p} ${PID:- } [%10.10t] %-40.40logger{39} : %m%n" />

    <!-- 定义控制台输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 定义保存文件滚动策略 -->
    <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./log/${appName}.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>./log/%d{yyyy-MM-dd}/${appName}-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>15</maxHistory>
            <totalSizeCap>1000MB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${log-pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
    </appender>

    <!-- 定义保存文件滚动策略 -->
    <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>./log/error/${appName}-error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>./log/error/%d{yyyy-MM-dd}/${appName}-error-%d{yyyy-MM-dd}-%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>100MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
            <maxHistory>15</maxHistory>
            <totalSizeCap>1000MB</totalSizeCap>
        </rollingPolicy>
        <encoder>
            <pattern>${log-pattern}</pattern>
            <charset>UTF-8</charset>
        </encoder>
        <!-- warn error级别 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>WARN</level>
        </filter>
    </appender>

    <!-- 定义异步Appender -->
    <appender name="FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="FILE" />
        <appender-ref ref="ERROR_FILE" />
        <!--
        指定异步队列的大小,即可以容纳的最大未处理的日志消息数量。当队列满时,新的日志消息将被阻塞或丢弃,取决于discardingThreshold的配置。在这里,队列大小设置为512
        -->
        <queueSize>512</queueSize>

        <!--
        指定当队列已满时的丢弃阈值。当队列中未处理的日志消息数量达到丢弃阈值时,新的日志消息将被丢弃。discardingThreshold的值可以是正整数或者-1,表示不丢弃任何日志消息。在这里,丢弃阈值设置为0,即当队列已满时,不会丢弃任何日志消息。
        -->
        <discardingThreshold>0</discardingThreshold>
    </appender>

    <!-- 定义异步Appender -->
    <appender name="ERROR_FILE_ASYNC" class="ch.qos.logback.classic.AsyncAppender">
        <appender-ref ref="ERROR_FILE" />
        <!--
        指定异步队列的大小,即可以容纳的最大未处理的日志消息数量。当队列满时,新的日志消息将被阻塞或丢弃,取决于discardingThreshold的配置。在这里,队列大小设置为512
        -->
        <queueSize>512</queueSize>

        <!--
        指定当队列已满时的丢弃阈值。当队列中未处理的日志消息数量达到丢弃阈值时,新的日志消息将被丢弃。discardingThreshold的值可以是正整数或者-1,表示不丢弃任何日志消息。在这里,丢弃阈值设置为0,即当队列已满时,不会丢弃任何日志消息。
        -->
        <discardingThreshold>0</discardingThreshold>
    </appender>

    <!-- 将异步Appender和控制台输出Appender绑定到root logger -->
    <root level="info">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE_ASYNC" />
        <appender-ref ref="ERROR_FILE_ASYNC" />
    </root>
</configuration>
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容