Spring Boot中如何实现全链路调用日志跟踪？

博客主页: 南来_北往

系列专栏：Spring Boot实战

引言

在Spring Boot中实现全链路调用日志跟踪，主要依赖于Mapped Diagnostic Context（MDC）功能。MDC是一种用于在多线程条件下记录日志的功能，它可以看作是与当前线程绑定的哈希表，能够往其中添加键值对。这些键值对可被同一线程中执行的代码访问，并且当前线程的子线程会继承其父线程中的MDC内容。为了实现全链路调用日志跟踪，可以采用以下方法：

使用MDC记录跟踪信息：在请求处理最开始时将跟踪信息（如traceId）保存到MDC中。这个traceId会在日志中体现，允许你根据这个ID查询过滤出一次请求的所有上下文日志。
修改日志配置文件：调整日志配置文件中的日志格式，使其能够包含MDC中的traceId信息。例如，在logback配置中，可以使用%X{traceId}来输出traceId的值。
使用拦截器传递traceId：通过实现HandlerInterceptor接口创建一个拦截器，在预处理（preHandle）方法中从请求头获取traceId，如果不存在则生成一个新的traceId，并将其放入MDC。在请求完成后（afterCompletion），从MDC中移除traceId。
封装线程池以支持MDC传递：对于异步操作或使用线程池的场景，需要确保traceId能够传递给子线程。这通常通过对线程池进行封装来实现，以确保每个任务运行前都能将traceId设置到子线程的MDC中。
跨服务传递traceId：当微服务架构中的服务相互调用时，需要确保traceId能够从一个服务传递到另一个服务。这通常通过在服务间调用的HTTP头中传递traceId实现，然后在下游服务中拦截并取出traceId，再放入MDC中继续跟踪。

此外，为确保全链路调用日志跟踪的顺利实施，还需要考虑以下因素：

唯一性：保证每个请求的traceId是唯一的，避免日志混乱。
性能开销：考虑到引入日志跟踪可能带来的性能开销，应合理设计以避免过大的性能损耗。
日志管理：使用ELK(Elasticsearch, Logstash, Kibana)等工具统一收集和分析日志，便于问题定位和追踪。

综上所述，可以实现在Spring Boot应用中的全链路调用日志跟踪，从而方便地诊断和排查分布式系统中的问题。这种能力对于维护和优化大型应用至关重要。

MDC介绍

MDC，即Mapped Diagnostic Context，是一个用于存储每个线程特定诊断信息的映射表。

MDC的主要功能是提供一个与当前线程绑定的哈希表，可以往其中添加键值对。这些键值对可以被同一线程中执行的代码访问，且当前线程的子线程会继承其父线程中的MDC内容。当需要记录日志时，可以从MDC中获取所需的信息，并将其输出到日志中。在多线程应用程序中，特别是Web应用服务器这种典型场景下，一个用户的请求可能由多个线程处理，使得区分不同用户对应的日志变得复杂。MDC通过在处理请求的最开始将特定信息（如用户ID、IP地址等）保存到MDC中，并在日志配置中设置相应的格式，从而确保这些信息能被自动添加到每条日志记录中。

以下是MDC的具体使用方法：

基本API用法：MDC提供几个基本的方法，如MDC.put(key, value)用于将上下文值放入当前线程的映射中，MDC.get(key)用于获取上下文中的值，MDC.remove(key)用于从映射中移除上下文，MDC.clear()则用于清除所有MDC上下文。
结合日志框架使用：MDC常与SLF4J、Log4j和Logback等日志框架结合使用。在这些框架的支持下，MDC可以将指定的上下文信息插入到日志消息中，这有助于更精确地跟踪和过滤日志记录。
多线程环境中的应用：在多线程环境下，MDC的内容可被子线程继承，但需要注意的是，如果子线程对MDC内容进行了修改，这些修改不会影响到父线程的MDC状态。这在使用线程池等技术时特别有用，可以确保每个任务都有独立的日志跟踪信息。

总之，MDC为多线程应用程序提供了一种高效、灵活的日志记录方式，使得日志信息更加丰富和有条理。对于开发者来说，合理利用MDC可以大大简化日志分析工作，提高问题定位和诊断的效率。在设计应用程序时，应充分利用MDC的优势，规划好日志记录的策略，以应对复杂的日志跟踪需求。

API介绍

clear() ：移除所有MDC
get (String key) ：获取当前线程MDC中指定key的值
getContext() ：获取当前线程MDC的MDC
put(String key, Object o) ：往当前线程的MDC中存入指定的键值对
remove(String key) ：删除当前线程MDC中指定的键值对

优点

代码简洁，日志风格统一，不需要在log打印中手动拼写traceId，即LOGGER.info("traceId:{} ", traceId)

MDC使用

1、添加拦截器

public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //如果有上层调用就用上层的ID
        String traceId = request.getHeader(Constants.TRACE_ID);
        if (traceId == null) {
            traceId = TraceIdUtil.getTraceId();
        }

        MDC.put(Constants.TRACE_ID, traceId);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        //调用结束后删除
        MDC.remove(Constants.TRACE_ID);
    }
}

2、修改日志格式

<property name="pattern">[TRACEID:%X{traceId}] %d{HH:mm:ss.SSS} %-5level %class{-1}.%M()/%L - %msg%xEx%n</property>

重点是%X{traceId}，traceId和MDC中的键名称一致

简单使用就这么容易，但是在有些情况下traceId将获取不到

MDC 存在的问题

子线程中打印日志丢失traceId
HTTP调用丢失traceId

丢失traceId的情况，来一个再解决一个，绝不提前优化

解决MDC存在的问题

子线程日志打印丢失traceId

子线程在打印日志的过程中traceId将丢失，解决方式为重写线程池，对于直接new创建线程的情况不考略【实际应用中应该避免这种用法】，重写线程池无非是对任务进行一次封装

线程池封装类：ThreadPoolExecutorMdcWrapper.java

public class ThreadPoolExecutorMdcWrapper extends ThreadPoolExecutor {
    public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,
                                        BlockingQueue<Runnable> workQueue) {
        super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue);
    }

    public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,
                                        BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory) {
        super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, threadFactory);
    }

    public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,
                                        BlockingQueue<Runnable> workQueue, RejectedExecutionHandler handler) {
        super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, handler);
    }

    public ThreadPoolExecutorMdcWrapper(int corePoolSize, int maximumPoolSize, long keepAliveTime, TimeUnit unit,
                                        BlockingQueue<Runnable> workQueue, ThreadFactory threadFactory,
                                        RejectedExecutionHandler handler) {
        super(corePoolSize, maximumPoolSize, keepAliveTime, unit, workQueue, threadFactory, handler);
    }

    @Override
    public void execute(Runnable task) {
        super.execute(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
    }

    @Override
    public <T> Future<T> submit(Runnable task, T result) {
        return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()), result);
    }

    @Override
    public <T> Future<T> submit(Callable<T> task) {
        return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
    }

    @Override
    public Future<?> submit(Runnable task) {
        return super.submit(ThreadMdcUtil.wrap(task, MDC.getCopyOfContextMap()));
    }
}

说明：

继承ThreadPoolExecutor类，重新执行任务的方法
通过ThreadMdcUtil对任务进行一次包装

线程traceId封装工具类：ThreadMdcUtil.java

public class ThreadMdcUtil {
    public static void setTraceIdIfAbsent() {
        if (MDC.get(Constants.TRACE_ID) == null) {
            MDC.put(Constants.TRACE_ID, TraceIdUtil.getTraceId());
        }
    }

    public static <T> Callable<T> wrap(final Callable<T> callable, final Map<String, String> context) {
        return () -> {
            if (context == null) {
                MDC.clear();
            } else {
                MDC.setContextMap(context);
            }
            setTraceIdIfAbsent();
            try {
                return callable.call();
            } finally {
                MDC.clear();
            }
        };
    }

    public static Runnable wrap(final Runnable runnable, final Map<String, String> context) {
        return () -> {
            if (context == null) {
                MDC.clear();
            } else {
                MDC.setContextMap(context);
            }
            setTraceIdIfAbsent();
            try {
                runnable.run();
            } finally {
                MDC.clear();
            }
        };
    }
}

说明【以封装Runnable为例】：

判断当前线程对应MDC的Map是否存在，存在则设置
设置MDC中的traceId值，不存在则新生成，针对不是子线程的情况，如果是子线程，MDC中traceId不为null
执行run方法

代码等同于以下写法，会更直观

public static Runnable wrap(final Runnable runnable, final Map<String, String> context) {
        return new Runnable() {
            @Override
            public void run() {
                if (context == null) {
                    MDC.clear();
                } else {
                    MDC.setContextMap(context);
                }
                setTraceIdIfAbsent();
                try {
                    runnable.run();
                } finally {
                    MDC.clear();
                }
            }
        };
    }

重新返回的是包装后的Runnable，在该任务执行之前【runnable.run()】先将主线程的Map设置到当前线程中【即MDC.setContextMap(context)】，这样子线程和主线程MDC对应的Map就是一样的了

判断当前线程对应MDC的Map是否存在，存在则设置
设置MDC中的traceId值，不存在则新生成，针对不是子线程的情况，如果是子线程，MDC中traceId不为null
执行run方法

HTTP调用丢失traceId

在使用HTTP调用第三方服务接口时traceId将丢失，需要对HTTP调用工具进行改造，在发送时在request header中添加traceId，在下层被调用方添加拦截器获取header中的traceId添加到MDC中

HTTP调用有多种方式，比较常见的有HttpClient、OKHttp、RestTemplate，所以只给出这几种HTTP调用的解决方式

1、HttpClient：

实现HttpClient拦截器：

public class HttpClientTraceIdInterceptor implements HttpRequestInterceptor {
    @Override
    public void process(HttpRequest httpRequest, HttpContext httpContext) throws HttpException, IOException {
        String traceId = MDC.get(Constants.TRACE_ID);
        //当前线程调用中有traceId，则将该traceId进行透传
        if (traceId != null) {
            //添加请求体
            httpRequest.addHeader(Constants.TRACE_ID, traceId);
        }
    }
}

实现HttpRequestInterceptor接口并重写process方法

如果调用线程中含有traceId，则需要将获取到的traceId通过request中的header向下透传下去

为HttpClient添加拦截器：

private static CloseableHttpClient httpClient = HttpClientBuilder.create()
            .addInterceptorFirst(new HttpClientTraceIdInterceptor())
            .build();

通过addInterceptorFirst方法为HttpClient添加拦截器

2、OKHttp：

实现OKHttp拦截器：

public class OkHttpTraceIdInterceptor implements Interceptor {
    @Override
    public Response intercept(Chain chain) throws IOException {
        String traceId = MDC.get(Constants.TRACE_ID);
        Request request = null;
        if (traceId != null) {
            //添加请求体
            request = chain.request().newBuilder().addHeader(Constants.TRACE_ID, traceId).build();
        }
        Response originResponse = chain.proceed(request);

        return originResponse;
    }
}

实现Interceptor拦截器，重写interceptor方法，实现逻辑和HttpClient差不多，如果能够获取到当前线程的traceId则向下透传

为OkHttp添加拦截器：

 private static OkHttpClient client = new OkHttpClient.Builder()
            .addNetworkInterceptor(new OkHttpTraceIdInterceptor())
            .build();

调用addNetworkInterceptor方法添加拦截器

3、RestTemplate：

实现RestTemplate拦截器：

public class RestTemplateTraceIdInterceptor implements ClientHttpRequestInterceptor {
    @Override
    public ClientHttpResponse intercept(HttpRequest httpRequest, byte[] bytes, ClientHttpRequestExecution clientHttpRequestExecution) throws IOException {
        String traceId = MDC.get(Constants.TRACE_ID);
        if (traceId != null) {
            httpRequest.getHeaders().add(Constants.TRACE_ID, traceId);
        }

        return clientHttpRequestExecution.execute(httpRequest, bytes);
    }
}

实现ClientHttpRequestInterceptor接口，并重写intercept方法，其余逻辑都是一样的不重复说明

为RestTemplate添加拦截器：

restTemplate.setInterceptors(Arrays.asList(new RestTemplateTraceIdInterceptor()));

调用setInterceptors方法添加拦截器

4、第三方服务拦截器：

HTTP调用第三方服务接口全流程traceId需要第三方服务配合，第三方服务需要添加拦截器拿到request header中的traceId并添加到MDC中

public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //如果有上层调用就用上层的ID
        String traceId = request.getHeader(Constants.TRACE_ID);
        if (traceId == null) {
            traceId = TraceIdUtils.getTraceId();
        }
        
        MDC.put("traceId", traceId);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        MDC.remove(Constants.TRACE_ID);
    }
}

说明：

先从request header中获取traceId
从request header中获取不到traceId则说明不是第三方调用，直接生成一个新的traceId
将生成的traceId存入MDC中

除了需要添加拦截器之外，还需要在日志格式中添加traceId的打印，如下：

 <property name="pattern">[TRACEID:%X{traceId}] %d{HH:mm:ss.SSS} %-5level %class{-1}.%M()/%L - %msg%xEx%n</property>

注意：需要添加%X{traceId}