后端日志规范

日志实现采用springboot 自带的logback 框架，在使用时不可以直接使用logback 的api，使用日志框架 SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

日志级别

ERROR
error级别只记录系统逻辑出错、异常或者重要的错误信息，影响到程序正常运行、当前请求正常运行的异常情况。如：

打开配置文件失败
所有第三方对接的异常(包括第三方返回错误码)
所有影响功能使用的异常，包括:SQLException 、空指针异常以及业务异常之外的所有异常

WARN
告警日志。不应该出现但是不影响程序、当前请求正常运行的异常情况。
但是一旦出现了也需要关注，因此一般该级别的日志达到一定的阈值之后，就得提示给用户或者需要关注的人了。如：

有容错机制的时候出现的错误情况
找不到配置文件，但是系统能自动创建配置文件
即将接近临界值的时候，如 cpu 存储已经超过阈值的 80%，就需要打印 warn 级别的日志

INFO
记录输入输出、程序关键节点等必要信息。平时无需关注，但出问题时可根据INFO日志诊断出问题

Service方法中对于系统/业务状态的变更
调用第三方时的调用参数和调用结果（入参和出参）
提供方，需要记录入参
定时任务的开始执行与结束执行

DEBUG
调试信息，对系统每一步的运行状态进行精确的记录。
TRACE
特别详细的服务调用流程各个节点信息。业务代码中，除非涉及到多级服务的调用，否则不要使用(除非有特殊用意，否则请使用DEBUG级别替代)

日志记录的场景

系统初始化流程
编程语言提示异常
业务流程与预期不符
系统核心角色，组件关键动作
作为服务调用方（打印入参、出参）
作为服务提供方（打印入参）
定时任务运行相关记录

日志规范

增删改操作需要打印参数日志（以便定位一些异常业务问题）；
条件分支需要打印日志：包括条件值以及重要参数；
明确日志打印级别与包含的信息

提供方服务，建议以 INFO 级别记录入参，出参可选
消费队列消息，务必打印消息内容
调用方服务，建议以 INFO 级别记录入参和出参
运行环境问题，如网络错误、建议以 WARN 级别记录错误堆栈
定时任务，务必打印任务开始时间、结束时间。涉及扫描数据的任务，务必打印扫描范围

异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么通过关键字throws/throw 往上抛出，由父级方法处理
谨慎地记录日志

生产环境禁止输出 debug 日志
有选择地输出 info 日志
如果使用 warn 来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志

可以使用 warn 日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从

注意日志输出的级别，error 级别只记录系统逻辑出错、异常等重要的错误信息。
如非必要，请不要在此场景打出 error 级别。(上述已经说明了 error 与 warn 级别日志的区别)

对 trace debug info 级别的日志输出，必须使用条件输出形式或者使用占位符的方式

说明：

text

logger.debug("Processing trade with id: " + id + " symbol: " + symbol);

对于上述代码，如果日志级别是 warn，日志不会打印，但是会执行字符串拼接操作，如果 symbol 是对象，会执行 toString() 方法，浪费了系统资源，执行了上述操作，最终日志却没有打印

正例：（条件）

text

if (logger.isDebugEnabled()) {
    logger.debug("Processing trade with id: " + id + " symbol: " + symbol);
}

正例：（占位符）

text

logger.debug("Processing trade with id: {} symbol : {} ", id, symbol);

不允许记录日志后又抛出异常，因为这样会多次记录日志，只允许记录一次日志

反例：

text

if (virtualIpPortCrash) {
    log.error("接入虚拟IP端口冲突");
    throw new BusinessException("接入虚拟IP端口冲突");
}

不允许出现System print(包括System.out.println和System.error.println)语句作为日志的打印
不允许出现 e.printStackTrace
日志性能的考虑。如果代码为核心代码，执行频率非常高，则输出日志建议增加判断，尤其是低级别的输出

日志使用

日志配置文件

xml

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

    <!-- 环境配置 -->
    <springProperty scope="context" name="plumelog.appName" source="plumelog.appName"/>
    <springProperty scope="context" name="plumelog.redisHost" source="plumelog.redisHost"/>
    <springProperty scope="context" name="plumelog.redisPort" source="plumelog.redisPort"/>
    <springProperty scope="context" name="plumelog.redisAuth" source="plumelog.redisAuth"/>
    <springProperty scope="context" name="plumelog.redisDb" source="plumelog.redisDb"/>
    <springProperty scope="context" name="plumelog.env" source="dev"/>
    <springProperty scope="context" name="PROJECT_NAME" source="plumelog.appName"/>
    <property name="LOG_PATH" value="./logs" />
    <property name="CHARSET" value="utf-8" />
    
    <!--输出到控制台-->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%white(%d{yyyy-MM-dd HH:mm:ss.SSS}) %highlight(%-5level) --- [%magenta(%15.15thread)] [%X{traceId}] %cyan(%-40.40logger{39}) : %msg %n</pattern>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
            <level>debug</level>
        </filter>
    </appender>

    <!-- 输出到文件 -->
    <!-- ERROR LOG -->
    <appender name="ERROR_ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${PROJECT_NAME}-error.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${PROJECT_NAME}-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>50MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <append>true</append>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level %-70c: %msg%n</pattern>
            <charset>${CHARSET}</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>error</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- DEBUG LOG -->
    <appender name="DEBUG_ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${PROJECT_NAME}-debug.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${PROJECT_NAME}-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- Keep debug logs within 7 days -->
            <MaxHistory>7</MaxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <append>true</append>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>[%d{yyyy-MM-dd HH:mm:ss.SSS}] [%-5level] [%thread] %logger#%method (line: %line\) %n%msg%n%n</pattern>
            <charset>${CHARSET}</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>debug</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <!-- INFO LOG -->
    <appender name="INFO_ROLLING_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
        <file>${LOG_PATH}/${PROJECT_NAME}-info.log</file>
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <fileNamePattern>${LOG_PATH}/${PROJECT_NAME}-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
            <!-- Keep debug logs within 30 days -->
            <MaxHistory>30</MaxHistory>
            <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                <maxFileSize>10MB</maxFileSize>
            </timeBasedFileNamingAndTriggeringPolicy>
        </rollingPolicy>
        <append>true</append>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level --- [%15.15thread] %-40.40logger{39}: %msg%n</pattern>
            <charset>${CHARSET}</charset>
        </encoder>
        <filter class="ch.qos.logback.classic.filter.LevelFilter">
            <level>info</level>
            <onMatch>ACCEPT</onMatch>
            <onMismatch>DENY</onMismatch>
        </filter>
    </appender>

    <appender name="plumelog" class="com.plumelog.logback.appender.RedisAppender">
        <appName>${plumelog.appName}</appName>
        <redisHost>${plumelog.redisHost}</redisHost>
        <redisAuth>${plumelog.redisAuth}</redisAuth>
        <redisDb>${plumelog.redisDb}</redisDb>
        <env>${plumelog.env}</env>
    </appender>

    <root level="info">
        <!--输出到控制台-->
        <appender-ref ref="CONSOLE"/>
        <!-- 输出到文件 -->
        <appender-ref ref="ERROR_ROLLING_FILE" />
        <appender-ref ref="DEBUG_ROLLING_FILE" />
        <appender-ref ref="INFO_ROLLING_FILE" />
        <!-- 输出plumelog -->
        <appender-ref ref="plumelog"/>
    </root>

</configuration>

微服务脚手架深度使用lombok 框架，使用lombok 框提供的@Slf4j注解添加到类上添加@Slf4j注解

java

@Slf4j
public class UserServiceImpl implements UserService {
    public void createUser(final User user) {
        log.info("这是info日志");
        log.debug("这是debug日志");
        log.warn("这是warn日志");
        log.error("这是error日志");
    }
}

后端日志规范 ​

日志级别 ​

日志记录的场景 ​

日志规范 ​

日志使用 ​

后端日志规范

日志级别

日志记录的场景

日志规范

日志使用