logback 日志异步配置

对于日志输出我们使用的是 logback，日志写入的方式采用的是比较常用的同步写入文件（即 RollingFileAppender），logback-spring.xml 配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志保存路径为/logs  -->
    <substitutionProperty name="log.base" value="logs"/>

    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS}[%-5level]%logger{80}:%5line-%msg%n"/>

    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <appender name="logfile"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${log.base}/%d{yyyy-MM-dd}.log</FileNamePattern>
            <MaxHistory>10</MaxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>
    
    <root>
        <level value="INFO"/><!-- TRACE、DEBUG、INFO、WARN和ERROR -->
        <appender-ref ref="stdout"/>
        <appender-ref ref="logfile" />
    </root>
</configuration>

这种同步写入的方式势必会影响业务的执行效率。幸运的是，logback 提供了异步的方式来解决这个问题，logback-spring.xml 配置如下：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <!-- 日志保存路径为/logs  -->
    <substitutionProperty name="log.base" value="logs"/>

    <property name="log.pattern" value="%d{yyyy-MM-dd HH:mm:ss.SSS}[%-5level]%logger{80}:%5line-%msg%n"/>

    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <appender name="logfile"
              class="ch.qos.logback.core.rolling.RollingFileAppender">
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <FileNamePattern>${log.base}/%d{yyyy-MM-dd}.log</FileNamePattern>
            <MaxHistory>10</MaxHistory>
        </rollingPolicy>
        <encoder>
            <pattern>${log.pattern}</pattern>
        </encoder>
    </appender>

    <appender name="async" class="ch.qos.logback.classic.AsyncAppender">
        <discardingThreshold>0</discardingThreshold>
        <queueSize>512</queueSize>
        <!-- 指定异步写入名称为 logfile 的 appender，这里最多只能添加一个 appender-ref -->
        <appender-ref ref="logfile" />
    </appender>

    <root>
        <level value="INFO"/><!-- TRACE、DEBUG、INFO、WARN和ERROR -->
        <appender-ref ref="stdout"/>
        <appender-ref ref="async" />
    </root>
</configuration>

我们通过添加一个名称为 async 的 appender（即 AsyncAppender），同时指定异步写入名称为 logfile 的 appender 来实现日志被异步的写入到指定文件中。

参数说明：

参数	默认值	说明
discardingThreshold	20	如果设置discardingThreshold＝0，表示 queue 满了，不丢弃，block 线程。默认情况下，当阻塞队列剩余 20% 的容量时，它将丢弃级别跟踪、调试和信息事件，只保留级别警告和错误事件。要保留所有事件，请将 discardingThreshold 设置为0
queueSize	256	假设 IO 影响 30s，日志和 qps 比例是1:1，单容器压测值 1500 qps 则可以推算出 queueSize 的值，queueSize 的设置公式：30 ＊ 1500=45000
neverBlock	false	如果为 false（默认值），则追加程序将阻止追加到完整队列，而不是丢失消息。设置为 true 时，附加程序只会丢弃消息，不会阻止您的应用程序

最后，通过一张图来说明一下异步写日志的原理：