基于MDC实现在多个Java Web应用间传递traceID以进行日志链路追踪

跨应用交互流程示意图

在这里我们抛出一个问题，该何如实现跨应用之间的日志长链路追踪呢？我们可以使用 MDC 实现日志长链路追踪，可以帮我们快速定位线上问题。

MDC介绍

MDC，即Mapped Diagnostic Context（映射调试上下文），是一种在日志记录时使用的技术，它用于在无状态的应用中跟踪用户的请求，MDC 可以看成是一个与当前线程绑定的哈希表，可以往其中添加键值对。在Spring Boot应用中，MDC可以结合日志框架（如Logback、Log4j）使用，为日志消息提供额外的上下文信息。这样做可以让你根据特定的上下文信息（如用户ID、事务ID等）过滤和搜索日志条目，从而简化故障诊断和日志审查。

代码实现

首先新建 demo 和 demo2 两个 springboot 的项目作为演示

在 demo 和 demo2 的配置文件中，编写日志输出

• demo 中的application.properties配置文件

spring.application.name=demo
server.port=8080
logging.pattern.level:'%5p [${spring.application.name},%mdc{traceId:-},%mdc{ts:-}]'

• demo2 中的application.properties配置文件

spring.application.name=demo2
server.port=8081
logging.pattern.level:'%5p [${spring.application.name},%mdc{traceId:-},%mdc{ts:-}]'

• 日志的MDC信息有源于过滤器（demo 和demo2 都一样）

import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.StringUtils;
import org.slf4j.MDC;

import javax.servlet.*;
import javax.servlet.http.HttpServletRequest;
import java.io.IOException;
import java.util.Date;
import java.util.UUID;


@Slf4j
public class MdcFilter implements Filter {

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {

        try {
            HttpServletRequest httpServletRequest = (HttpServletRequest) request;
            String traceId = httpServletRequest.getHeader("traceId");
            if (StringUtils.isBlank(traceId)) {
                traceId = UUID.randomUUID().toString();//traceId，你需要在用户请求进入系统的第一点（如API网关或第一个接收到用户请求的服务）生成一个唯一的`traceID`。
            }
            MDC.put("traceId", traceId);
            MDC.put("ts", String.valueOf(new Date().getTime()));

            log.info(httpServletRequest.getRequestURL() + " call received");
            chain.doFilter(request, response);
        } finally {
            MDC.clear();//一旦请求处理完毕，确认在每次请求的最后清除MDC中的traceID，以避免内存泄露或错误的traceID传递。
        }
    }
}

• 在应用入口中对所有的请求进行拦截（demo 和demo2 都一样）

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class DemoApplication {

    @Bean
    public FilterRegistrationBean<MdcFilter> loggingFilter() {
        FilterRegistrationBean<MdcFilter> registrationBean = new FilterRegistrationBean();
        registrationBean.setFilter(new MdcFilter());
        registrationBean.addUrlPatterns("/*");//对所有请求进行拦截
        return registrationBean;
    }

    public static void main(String[] args) throws NoSuchFieldException, IllegalAccessException {
        ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args);
    }

}

• demo Controller 接口

import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;

@RestController
@Slf4j
public class Test2Controller {
    @GetMapping("/testMdc")
    public String testMdc() {
        log.info("The traceId is {}", MDC.get("traceId"));
        ResponseEntity response = sendRequest("http://localhost:8081/testMdc", String.class);
        return response.getBody().toString();
    }

    private ResponseEntity sendRequest(String url, Class clz) {
        RestTemplate restTemplate = new RestTemplate();
        HttpHeaders headers = new HttpHeaders();
        if (MDC.get("traceId") != null) {
            headers.set("traceId",MDC.get("traceId"));//发送请求的一侧，将traceID放入HTTP头，调用另一个服务前，传递traceID
        }
        HttpEntity<Void> requestEntity = new HttpEntity<>(headers);
        ResponseEntity response = restTemplate.exchange(url, HttpMethod.GET, requestEntity, clz);
        return response;
    }
}

• demo2 Controller 接口

import lombok.extern.slf4j.Slf4j;
import org.slf4j.MDC;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Slf4j
public class Test2Controller {
    @GetMapping("/testMdc")
    public String testMdc() {
        log.info("The traceId is {}", MDC.get("traceId"));
        return "ok";
    }
}

日志效果

总结

• 确保在请求处理完之后清除MDC的数据，这通常在finally块中实现，否则线程上的MDC数据可能会在下一个请求中被错误地重复使用，因为服务器很可能是使用线程池的。
• 如果你的应用使用了异步处理，注意传递MDC数据到异步执行的线程中。
• 这个例子展示了如何在两个服务之间手动传递traceID。在实际应用中，你可能会使用Spring Cloud Sleuth或其他分布式追踪系统来自动化这个过程。这些系统通常提供了库和工具来自动生成和传递traceID，并与日志系统集成，从而减少了手动设置和传递traceID的工作。