Logback 日志添加请求唯一追踪 ID

我是陈皮，一个在互联网 Coding 的 ITer，个人微信公众号「陈皮的JavaLib」关注第一时间阅读最新技术文章。

问题描述

日志是排查问题的重要依据，但有时日志太多也不容易定位报错信息，不明确哪条日志信息对应哪次请求。如果能给每一个请求的执行链上的所有打印日志加上唯一的追踪标识 ID，那么排查就方便多了。

对于每一个请求，分配一个唯一 ID，打印日志时加上此 ID，并且当请求报错时，将这个 ID 返回给前端，前端发现报错直接把 ID 给后台人员进行定位分析。

开发环境

• SpringBoot - 2.1.10.RELEASE
• JDK 1.8

创建过滤器

创建请求过滤器，对每一个进来的请求设置唯一 ID，并且在请求执行完后删除此 ID。

package com.chenpi.config;

import java.io.IOException;
import java.util.UUID;

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.ServletException;
import javax.servlet.ServletRequest;
import javax.servlet.ServletResponse;

import org.slf4j.MDC;

/**
 * @author 陈皮
 * @version 1.0
 * @description 过滤器，每次请求设置日志唯一追踪ID
 * @date 2022/4/10
 */
public class LogMDCFilter implements Filter {

  private static final String UNIQUE_ID_NAME = "traceId";

  @Override
  public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse,
      FilterChain filterChain) throws IOException, ServletException {
    MDC.put(UNIQUE_ID_NAME, UUID.randomUUID().toString().replace("-", ""));
    try {
      filterChain.doFilter(servletRequest, servletResponse);
    } finally {
      MDC.remove(UNIQUE_ID_NAME);
    }
  }
}

注册过滤器

package com.chenpi.config;

import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import com.yzj.ehr.common.filter.LogMDCFilter;

/**
 * @author 陈皮
 * @version 1.0
 * @description 注册日志过滤器
 * @date 2022/4/10
 */
@Configuration
public class FilterConfig {

  @Bean
  public FilterRegistrationBean<LogMDCFilter> logFilterRegistration() {
    FilterRegistrationBean<LogMDCFilter> registration = new FilterRegistrationBean<>();
    // 注入过滤器
    registration.setFilter(new LogMDCFilter());
    // 拦截规则
    registration.addUrlPatterns("/*");
    // 过滤器名称
    registration.setName("logMDCFilter");
    // 过滤器顺序
    registration.setOrder(0);
    return registration;
  }
}

接口返回类

package com.yzj.pojo.vo;

import lombok.Getter;
import lombok.Setter;

/**
 * @author 陈皮
 * @version 1.0
 * @description 接口返回统一格式
 * @date 2022/4/10
 */
@Getter
@Setter
public class GeneralResult<T> {

  private boolean success;
  private String errorCode;
  private String message;
  private T data;
  private String traceId;

  // 省略相关方法
}

日志配置

在 logback.xml 日志配置文件中，使用%X{traceId}来引用程序中设置的日志唯一追踪 ID 的值。

<?xml version="1.0" encoding="UTF-8"?>
<configuration scan="true" scanPeriod="60 seconds"
               debug="false">
  
  <property name="filters"
            value="full,$Proxy,javax.crypto.Cipher,com.sun.,sun.reflect.,java.lang.reflect.,java.io.,java.net.,org.eclipse.jetty.,org.apache.cxf.,org.springframework.beans.,org.springframework.context.,org.apache.commons.httpclient.,org.apache.commons.pool.,org.apache.http.,io.netty.,org.junit.,org.apache.maven.,org.springframework.amqp.rabbit."/>
  <property name="layout" value="[%d{yyyy-MM-dd HH:mm:ss.SSS}] %-5level [%thread] [traceId-%X{traceId}] %logger{50}%n
                                 - %msg%n"/>
  <property name="maxHistory" value="30"/>
  <property name="maxFileSize" value="50MB"/>
  
  <appender name="console"
            class="ch.qos.logback.core.ConsoleAppender">
    <encoder>
      <pattern>${layout}</pattern>
    </encoder>
  </appender>
  
  <appender name="logFile"
            class="ch.qos.logback.core.rolling.RollingFileAppender">
    <File>./logs/server.log</File>
    <rollingPolicy
                   class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
      <FileNamePattern>./logs/server%d{yyyy-MM-dd}_%i.log
      </FileNamePattern>
      <MaxHistory>${maxHistory}</MaxHistory>
      <timeBasedFileNamingAndTriggeringPolicy
                                              class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
        <maxFileSize>${maxFileSize}</maxFileSize>
      </timeBasedFileNamingAndTriggeringPolicy>
    </rollingPolicy>
    <encoder
             class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
      <charset>UTF-8</charset>
      <pattern>${layout}</pattern>
    </encoder>
  </appender>
  
  <appender name="toLogFileAsync"
            class="ch.qos.logback.classic.AsyncAppender">
    <discardingThreshold>0</discardingThreshold>
    <appender-ref ref="logFile"/>
  </appender>
  
  <root level="INFO">
    <appender-ref ref="toLogFileAsync"/>
    <appender-ref ref="console"/>
  </root>
</configuration>

测试结果

这样，前端请求接口，如果请求报错，会返回带有 traceId 的值，如下所示：

GET http://localhost:8080/user/find/001

HTTP/1.1 200 
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sun, 10 Apr 2022 15:47:22 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "success": false,
  "errorCode": "1001",
  "message": "用户不存在!",
  "data": null,
  "traceId": "37bb36fa7aa046e597e419b33c173633"
}

在服务端，可以看到程序抛出的错误日志也带有日志唯一追踪 ID，如下所示：

[2022-04-10 23:47:22.244] ERROR [http-nio-8080-exec-1] [traceId-37bb36fa7aa046e597e419b33c173633] com.chenpi.exception.GlobalExceptionHandler
                 - requestURI:/user/find/001,errorCode:1001,errorMsg:用户不存在!
com.chenpi.exception.BizException: 用户不存在!
    at com.chenpi.controller.UserController.find(UserController.java:49)

本次分享到此结束啦~~

如果觉得文章对你有帮助，点赞、收藏、关注、评论，您的支持就是我创作最大的动力！