SpringBoot 异步输出 Logback 日志

1、介绍

1.1 Logback

　　Logback是由log4j创始人设计的另外一个开源日志组件，它分为下面下个模块：

1. logback-core：其它两个模块的基础模块
2. logback-classic：它是log4j的一个改良版本，同时它完整实现了slf4j API使你能够很方便地更换成其它日志系统如log4j或JDK14 Logging
3. logback-access：访问模块与Servlet容器集成提供经过Http来访问日志的功能

1.2 日志级别

包括：TRACE、DEBUG、INFO、WARN 和 ERROR。

1.2.1 TRACE

特别详细的系统运行完成信息，业务代码中，不要使用。(除非有特殊用意，不然请使用DEBUG级别替代)

1.2.2 DEBUG

1. 能够填写全部的想知道的相关信息(但不表明能够随便写，debug信息要有意义,最好有相关参数)；
2. 生产环境须要关闭DEBUG信息
3. 若是在生产状况下须要开启DEBUG,须要使用开关进行管理，不能一直开启。

1.2.3 INFO

• 系统运行信息

  1. Service方法中对于系统/业务状态的变动；
  2. 主要逻辑中的分步骤。

• 外部接口部分

  1. 客户端请求参数(REST/WS)；
  2. 调用第三方时的调用参数和调用结果。

• 说明

1. 并非全部的service都进行出入口打点记录,单1、简单service是没有意义的；
2. 对于复杂的业务逻辑，须要进行日志打点，以及埋点记录，好比电商系统中的下订单逻辑，以及OrderAction操做(业务状态变动)；
3. 对于整个系统的提供出的接口(REST/WS)，使用INFO记录入参；
4. 若是全部的service为SOA架构，那么能够当作是一个外部接口提供方，那么必须记录入参；
5. 调用其余第三方服务时，全部的出参和入参是必需要记录的(由于你很难追溯第三方模块发生的问题)。

1.2.4 WARN

• 不该该出现可是不影响程序、当前请求正常运行的异常状况:

  1. 有容错机制的时候出现的错误状况；
  2. 找不到配置文件，可是系统能自动建立配置文件；
• 即将接近临界值的时候，例如：缓存池占用达到警告线；

• 业务异常的记录,好比:当接口抛出业务异常时，应该记录此异常。

1.2.5 ERROR

影响到程序正常运行、当前请求正常运行的异常状况:

1. 打开配置文件失败；
2. 全部第三方对接的异常(包括第三方返回错误码)；
3. 全部影响功能使用的异常，包括:SQLException和除了业务异常以外的全部异常(RuntimeException和Exception)。

不该该出现的状况:
若是进行了抛出异常操做，请不要记录ERROR日志，由最终处理方进行处理：

反例(不要这么作):

try{
    ....
}catch(Exception ex){
  String errorMessage=String.format("Error while reading information of user [%s]",userName);
  logger.error(errorMessage,ex);
  throw new UserServiceException(errorMessage,ex);
}

1.3 SpringBoot 中 logback

1. SpringBoot工程自带logback和slf4j的依赖，因此重点放在编写配置文件上，须要引入什么依赖，日志依赖冲突通通都不须要咱们管了;
2. logback框架会默认加载classpath下命名为logback-spring或logback的配置文件。
3. 将全部日志都存储在一个文件中文件大小也随着应用的运行愈来愈大而且很差排查问题，正确的作法应该是将ERROR日志和其余日志分开，而且不一样级别的日志根据时间段进行记录存储。

2、logback 配置

2.1 配置文件logback-spring.xml示例

<?xml version="1.0" encoding="utf-8"?>
<configuration>
    <!-- 属性文件:在配置文件中找到对应的配置项 -->
    <springProperty scope="context" name="logPath" source="logging.path"/>

    <!-- 输出到控制台 -->
    <appender name="CONSOLE-LOG" class="ch.qos.logback.core.ConsoleAppender">
        <layout class="ch.qos.logback.classic.PatternLayout">
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
        </layout>
    </appender>

    <!-- 获取比info级别高(包括info级别)但除error级别的日志 -->
    <appender name="INFO-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定过滤策略 -->
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>ERROR</level>
            <onMatch>DENY</onMatch>
            <onMismatch>ACCEPT</onMismatch>
        </filter>
        <encoder>
            <!-- 指定日志输出格式 -->
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
        </encoder>

        <!-- 指定收集策略：滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!-- 指定生成日志保存地址 -->
            <fileNamePattern>${logPath}/info.%d.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <appender name="ERROR-LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <!-- 指定过滤策略 -->
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>ERROR</level>
        </filter>
        <encoder>
            <!-- 指定日志输出格式 -->
            <pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.sss}] [%C] [%t] [%L] [%-5p] %m%n</pattern>
        </encoder>
        <!-- 指定收集策略：滚动策略-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--指定生成日志保存地址 -->
            <fileNamePattern>${logPath}/error.%d.log</fileNamePattern>
            <maxHistory>30</maxHistory>
        </rollingPolicy>
    </appender>

    <!-- 异步输出 -->
    <appender name="ASYNC-INFO" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 不丢失日志.默认的,若是队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>256</queueSize>
        <!-- 添加附加的appender,最多只能添加一个 -->
        <appender-ref ref="INFO-LOG"/>
    </appender>

    <appender name="ASYNC-ERROR" class="ch.qos.logback.classic.AsyncAppender">
        <!-- 不丢失日志.默认的,若是队列的80%已满,则会丢弃TRACT、DEBUG、INFO级别的日志 -->
        <discardingThreshold>0</discardingThreshold>
        <!-- 更改默认的队列的深度,该值会影响性能.默认值为256 -->
        <queueSize>256</queueSize>
        <!-- 添加附加的appender,最多只能添加一个 -->
        <appender-ref ref="ERROR-LOG"/>
    </appender>

    <!-- 指定最基础的日志输出级别 -->
    <root level="info">
        <appender-ref ref="CONSOLE-LOG" />
        <appender-ref ref="INFO-LOG" />
        <appender-ref ref="ERROR-LOG" />
    </root>

</configuration>

项目配置文件中配置日志输出地址

logging:
  path: ./logs

2.2 标签说明

• <root>标签：指定最基础的日志输出级别；
  • <appender-ref>标签，添加append
• <appender>标签：指定日志的收集策略
  1. name属性指定appender命名
  2. class属性指定输出策略，一般有两种，控制台输出和文件输出，文件输出就是将日志进行一个持久化。ConsoleAppender将日志输出到控制台。
• <filter>标签：指定过滤策略
  • <level>：指定过滤的类型。

• <encoder>标签：使用该标签下的<pattern>标签指定日志输出格式。

• <rollingPolicy>标签：指定收集策略，好比基于时间进行收集

  • 标签指定生成日志保存地址，实现了按天分类以及日志的目标了。

3、 源码

Github 示例源码