全链路追踪体验—最简陋TraceId的生成

对于后端开发来说，排查问题是常有的事情。而排查问题时最常用的就是看日志，看一次调用中经过了哪些系统，是那个系统出问题了。这就需要业务日志中关联调用链的TraceId信息，从而在应用出现问题时，能够通过调用链的TraceId快速关联到业务日志，及时定位分析、解决问题。

之前从事的公司都有这种链路中间件，现在阿里集团的eagleeye 鹰眼系统也是的，接入使用就行了，但是原理完全不清楚。不了解TraceId怎么生成的，怎么在系统之间传递。所以今天先来实现一个最简单的TraceId

解决方案

1. 自己生成 traceId 并 put 到 MDC 里面

MDC

MDC（Mapped Diagnostic Context）是一个映射，用于存储运行上下文的特定线程的上下文数据。因此，如果使用log4j进行日志记录，则每个线程都可以拥有自己的MDC，该MDC对整个线程是全局的。属于该线程的任何代码都可以轻松访问线程的MDC中存在的值。请求时，将TraceId放在header里，服务方从header里读取出来，并在日志上打印即可

如何将TraceId放到MDC中

1.日志文件logback-spring.xml配置

打印彩色日志，需要在日志格式中加上[%X{TRACE_ID}]，变量名TRACE_ID是自己定义的

    logback
    
    

    
    
    
    
    
    
    

    
    
        
        
            info
        
        
            ${CONSOLE_LOG_PATTERN}
            UTF-8
        
    

    
        
    

2.新增拦截器

拦截所有请求，从header里取出traceId然后放到MDC中，这样该工程所有位置都能读取到。如果header里没有，则自己生成一个，生成规则可参考阿里云帮助文档: TraceId 和 SpanId 生成规则

@Component
public class LogInterceptor implements HandlerInterceptor {

    private String TRACE_ID = "TRACE_ID";

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        //如果有上层调用就用上层的ID
        String traceId = request.getHeader(TRACE_ID);
        if (traceId == null) {
            traceId = UUID.randomUUID().toString();
        }

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

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
        // Do nothing because of no business
    }

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

3.注册拦截器

将上一步的日志拦截器注册，并拦截所有路径的HTTP请求，让其生效

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Resource
    private LogInterceptor logInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(logInterceptor)
                .addPathPatterns("/**");
    }
}

4.测试效果

到这一步就可以试试日志打印TraceId的效果了，随便写一个接口，并打印日志。如下图已经成功打印出Traceid了

其他方案

上面演示的是最简陋的方式，公司内部一般都会再造一遍轮子，让各个应用接入使用的。后面再写几个开源的TraceId生成框架，更深入的去了解全链路治理