Springboot实现链路追踪功能

前言

在日常开发中，一个业务的实现往往会调用很多个方法，当我们去看日志的时候，各种接口的日志打印出来，看着就头疼，压根没办法去定位，而链路追踪就能很好的帮助我们去查看接口从头至尾依次调用了哪些方法。

同时我们还可以通过链路追踪的traceId去日志文件中去定位问题，比如：

grep   'c03ed014b9b34252b872009d030904f7'    log.log
或者
# 查看上下5行
grep -5   'c03ed014b9b34252b872009d030904f7'    log.log

如图所示：
在这里插入图片描述

实现代码

本案例实现是通过springboot默认日志logback实现。

第一步：导入Maven依赖

    <!--lombok配置--><dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><version>1.16.10</version></dependency>

第二步：添加整合logback，打印日志，logback-spring.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- 日志级别从低到高分为TRACE < DEBUG < INFO < WARN < ERROR < FATAL，如果设置为WARN，则低于WARN的信息都不会输出 -->
<!-- scan:当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true -->
<!-- scanPeriod:设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟。 -->
<!-- debug:当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false。 -->
<configuration scan="true" scanPeriod="10 seconds"><contextName>logback</contextName><!-- name的值是变量的名称，value的值时变量定义的值。通过定义的值会被插入到logger上下文中。定义变量后，可以使“${}”来使用变量。 --><springProperty scope="context" name="log.path" source="log.path"/><!-- 彩色日志 --><!-- 彩色日志依赖的渲染类 --><conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter"/><conversionRule conversionWord="wex"converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter"/><conversionRule conversionWord="wEx"converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter"/><!-- 彩色日志格式 --><property name="CONSOLE_LOG_PATTERN"value="[traceId:%X{traceId}] ${CONSOLE_LOG_PATTERN:-%clr(%d{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}}"/><property name="PATTERN" value="%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n"/> 	<!--输出到控制台--><appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender"><!--此日志appender是为开发使用，只配置最底级别，控制台输出的日志级别是大于或等于此级别的日志信息--><filter class="ch.qos.logback.classic.filter.ThresholdFilter"><level>debug</level></filter><encoder><Pattern>${CONSOLE_LOG_PATTERN}</Pattern><!-- 设置字符集 --><charset>UTF-8</charset></encoder></appender><!-- 滚动文件输出日志 --><appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender"><file>${log.path}/log.log</file><!-- 日志记录器的滚动策略，按日期，按大小记录 --><rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"><!-- 每天日志归档路径以及格式 --><fileNamePattern>${log.path}/log-%d{yyyy-MM-dd}.%i.log</fileNamePattern><timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP"><maxFileSize>10MB</maxFileSize></timeBasedFileNamingAndTriggeringPolicy><!--日志文件保留天数--><maxHistory>15</maxHistory></rollingPolicy><encoder><pattern>${PATTERN}</pattern></encoder></appender><root level="INFO"><!-- 配置日志输出的方式，可以同时输出到控制台和文件 --><appender-ref ref="CONSOLE"/><appender-ref ref="FILE"/></root>
</configuration>

第三步：application.yml中需要指定logback-spring.xml

logging:config: classpath:logback-config.xml

第四步：自定义日志拦截器 LogInterceptor
作用：每一次接口调用时，从线程维度上添加链路ID–traceId。


import com.alibaba.druid.util.StringUtils;
import com.dinglianshuke.ipfs.service.common.utils.MDCTraceUtil;
import org.springframework.web.servlet.HandlerInterceptor;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
/*** @author o* @description 自定义日志拦截器* @date 2024/4/11**/
public class LogInterceptor implements HandlerInterceptor {@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {// 客户端可以传入链路ID，需要唯一性String traceId = request.getHeader(MDCTraceUtil.TRACE_ID_HEADER);if (!StringUtils.isEmpty(traceId)) {MDCTraceUtil.putTrace(request.getHeader(MDCTraceUtil.TRACE_ID_HEADER));} else {MDCTraceUtil.addTrace();}return true;}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {MDCTraceUtil.removeTrace();}
}

这边将MDC提取出来做成了一个工具类MDCTraceUtil：

import org.slf4j.MDC;
import java.util.UUID;public class MDCTraceUtil {/*** 追踪id的名称*/public static final String KEY_TRACE_ID = "traceId";/*** 日志链路追踪id信息头*/public static final String TRACE_ID_HEADER = "x-traceId-header";/*** 创建traceId并赋值MDC*/public static void addTrace() {String traceId = createTraceId();// MDC(Mapped Diagnostic Context)诊断上下文映射，是@Slf4j提供的一个支持动态打印日志信息的工具。MDC.put(KEY_TRACE_ID, traceId);}/*** 赋值MDC*/public static void putTrace(String traceId) {MDC.put(KEY_TRACE_ID, traceId);}/*** 获取MDC中的traceId值*/public static String getTraceId() {return MDC.get(KEY_TRACE_ID);}/*** 清除MDC的值*/public static void removeTrace() {MDC.remove(KEY_TRACE_ID);}/*** 创建traceId*/public static String createTraceId() {return UUID.randomUUID().toString().replace("-", "");}}

第五步：新增LogWebMvcConfig，添加拦截器

import com.dinglianshuke.ipfs.service.common.interceptor.LogInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;@Configuration
public class LogWebMvcConfig implements WebMvcConfigurer {@Overridepublic void addInterceptors(InterceptorRegistry registry) {// 添加拦截器registry.addInterceptor(mvcInterceptor())// 拦截所有请求的路径.addPathPatterns("/**");}@Beanpublic LogInterceptor mvcInterceptor() {return new LogInterceptor();}}