Spring boot分布式链路追踪

• • • 前言
    • • 演示项目核心依赖
      • 一、系统配置文件 日志文件路径配置
      • 二、日志文件 logback.xml 其中重要的标志是“requestId”字眼
      • 三、配置全局拦截器 RequestIdTraceInterceptor.java 拦截交互请求带有 “requestId” 字眼的值
      • 四、实际使用
      • 五、效果展示 MDC.put下方所有在内的完整日志链路都会出现 如【2f61b36c-2eaa-4701-aafe-648eb43e0c40】字眼，在查询时直接搜索即可

前言

在分布式开发中，经常会遇到程序出现问题定位困难，处理起来耗时耗力，做无用功
下面就来给出一种方案来解决这一问题

演示项目核心依赖

一、系统配置文件 日志文件路径配置

 #日志配置
logging:config: classpath:log/logback.xml

二、日志文件 logback.xml 其中重要的标志是“requestId”字眼

${CONSOLE_LOG_PATTERN}utf8${log.path}/%d{yyyy-MM, aux}/debug.%d{yyyy-MM-dd}.%i.log10MB1GB30%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{requestId}] [%thread] %-5level %logger{50} - %msg%nUTF-80256

三、配置全局拦截器 RequestIdTraceInterceptor.java 拦截交互请求带有 “requestId” 字眼的值

package com.xxx.interceptor;import cn.hutool.core.util.IdUtil;
import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;/*** 链路追踪*/
@Slf4j
@Component
public class RequestIdTraceInterceptor implements HandlerInterceptor {public static final String REQUEST_ID_KEY = "requestId";@Overridepublic boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {MDC.put(REQUEST_ID_KEY, getRequestId(request));return true;}@Overridepublic void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {//把requestId添加到响应头，以便其它应用使用response.addHeader(REQUEST_ID_KEY, MDC.get(REQUEST_ID_KEY));//请求完成，从MDC中移除requestIdMDC.remove(REQUEST_ID_KEY);}public static String getRequestId(HttpServletRequest request) {String requestId;String parameterRequestId = request.getParameter(REQUEST_ID_KEY);String headerRequestId = request.getHeader(REQUEST_ID_KEY);// 根据请求参数或请求头判断是否有“request-id”，有则使用，无则创建if (parameterRequestId == null && headerRequestId == null) {log.debug("no request-id in request parameter or header");requestId = IdUtil.simpleUUID();} else {requestId = parameterRequestId != null ? parameterRequestId : headerRequestId;}return requestId;}
}

四、实际使用

        String requestId= UuidUtils.generateUuid();//hutool带的线程池方法 可不用ThreadUtil.execAsync(() -> {//添加唯一字眼MDC.put(RequestIdTraceInterceptor.REQUEST_ID_KEY, requestId);try {//业务代码} catch (Exception e) {log.info("异常={}", e);}//请求完成，从MDC中移除requestIdMDC.remove(RequestIdTraceInterceptor.REQUEST_ID_KEY);});

五、效果展示 MDC.put下方所有在内的完整日志链路都会出现 如【2f61b36c-2eaa-4701-aafe-648eb43e0c40】字眼，在查询时直接搜索即可

2022-12-12 11:02:56.915 [2f61b36c-2eaa-4701-aafe-648eb43e0c40] [pool-2-thread-1] INFO  xxx - 上报异常={}