调用链追踪MDC如何使用?_mdc使用-优快云博客

本文链接：https://blog.youkuaiyun.com/zhzjn/article/details/143312276

MDC

一、MDC简介

MDC（Mapped Diagnostic Context，映射调试上下文）是日志框架（如log4j、logback等）提供的一种功能，允许开发者在日志消息中嵌入额外的上下文信息。这些信息可以在日志处理过程中跨多个日志语句和跨多个线程传递，非常适合用于链路追踪。在微服务架构中，MDC成为了调用链追踪的利器，帮助开发者追踪请求在整个系统中的处理流程。

二、MDC的API说明

MDC提供了一系列API用于操作上下文信息，主要包括以下几个方法：

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

这些API使得开发者能够在代码中灵活地添加、获取和删除MDC中的信息，从而实现对日志上下文的精确控制。

三、MDC在调用链追踪中的应用

在调用链追踪中，MDC的应用主要体现在以下几个方面：

1. 生成并传递traceId：
- • 在请求的入口点（如网关或API接口），通过拦截器生成一个全局唯一的traceId，并将其放入MDC中。
- • 在服务间的调用中，通过HTTP请求的Header传递traceId，接收方服务在接收到请求后，从Header中提取traceId并放入MDC中。
2. 配置日志格式：
- • 在日志框架的配置文件中，配置日志格式以包含MDC中的traceId。这样，在记录日志时，就会自动将traceId嵌入到日志消息中。
3. 跨线程传递：
- • 在多线程处理请求的场景下，需要确保子线程能够继承父线程的MDC内容。这通常需要对线程池进行配置，使其支持InheritableThreadLocal。

四、MDC的优势与注意事项

优势：

1. 轻量级：MDC的实现相对简单，对系统性能的影响较小。
2. 灵活性：MDC允许程序在运行时动态地添加和修改上下文信息，满足不同的追踪需求。
3. 易用性：通过简单的配置和API调用，即可实现调用链的追踪和日志的集中管理。

注意事项：

1. 线程隔离：MDC是与当前线程绑定的，因此在多线程环境下需要特别注意traceId的传递。
2. 安全性：避免在MDC中存储敏感信息，以防泄露。
3. 性能考虑：虽然MDC对系统性能的影响较小，但在高并发场景下仍需关注其对性能的可能影响。

示例讲解

以下是一个使用MDC进行调用链追踪的示例：

1. 生成traceId并放入MDC：

public class TraceInterceptor implements HandlerInterceptor {
    private static final String TRACE_ID = "traceId";

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
        String traceId = request.getHeader(TRACE_ID);
        if (traceId == null) {
            traceId = UUID.randomUUID().toString();
        }
        MDC.put(TRACE_ID, traceId);
        return true;
    }

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

2. 配置日志格式：在logback的配置文件中，添加如下配置以包含MDC中的traceId：

<pattern>%d{yyyy-MM-dd HH:mm:ss} [%X{traceId}] [%thread] %-5level %logger{36} - %msg%n</pattern>

3. 服务间传递traceId：在调用其他服务时，将traceId添加到HTTP请求的Header中，并在接收方服务中从Header中提取traceId放入MDC。

通过以上步骤，即可实现基于MDC的调用链追踪，帮助开发者更好地理解和优化系统的请求处理流程。