Spring Cloud Sleuth 分布式链路追踪入门

您好，我是今夜写代码,今天学习下分布式链路组件Spring Cloud Sleuth。

本文内容

介绍了分布式链路的思想
Sleuth 和 Zipkin 简单集成Demo,并不涉及 Sleuth原理。

为什么要用链路追踪？

微服务架构下，一个复杂的电商应用，完成下单可能依赖商品、库存、结算、风控等一系列服务，并且依赖的服务又依赖一堆服务，其中任何一个环节出错都可能导致服务调用失败。一旦服务调用失败，对于问题排查的成本是非常高的。

究竟哪个环节出错了？请求日志在哪一个服务节点上？在没有调用链路追踪情况下，相信这绝对是一大难题。

早在2010年一篇由谷歌发表的《Dapper, a Large-Scale Distributed Systems Tracing Infrastructure 》横空出世，这篇论文详细介绍了谷歌的分布式系统追踪基础设施 Dapper，当时这篇论文在国内应该是思想超前的，大学还在教JSP、Servlet。如今链路追踪在大型分布式应用中，起到很重要的一席之地。

如何自己实现简单的链路追踪？

我们可以按照下面流程实现一个简单的链路追踪，当然不包含链路上报和检索功能。

以常见的 Dubbo 和 Spring MVC 请求举例，实现将请求Trace Id传递下去，并且满足如下特征

对业务代码无入侵
业务代码可以通过API方式操作Trace Id

Dubbo

Dubbo attachment和过滤器等等不熟悉的同学可以查看之前文章Dubbo学习合集。

我们可以通过Dubbo的attachment 实现Trace Id 透传，实现对业务代码无入侵。同时为了业务代码获取方便，我们将TraceId 放入ThreadLocal中，这样业务代码可以通过ThreadLocal获取，而不必依赖Dubbo 的 RpcContext 。

java 复制代码

  String traceId  = RpcContext.getContext().getAttachment("traceId");
  if(traceId == null){
      traceId = UUID.randomUUID().toString().replace("-","");
      RpcContext.getContext().setAttachment("traceId",traceId);
  }
  TraceUtil.setTraceId(traceId);

java 复制代码

/**
 * @ClassName TraceUtil
 * @Description
 * @Author codetonight 今夜写代码 https://blog.csdn.net/happycao123
 * @Date 2024/12/14 16:06
 */
public class TraceUtil {

    private static final ThreadLocal<String> threadLocal = new ThreadLocal<>();

    public static String getTraceId(){
        return threadLocal.get();
    }

    public static void setTraceId(String traceId){
        threadLocal.set(traceId);
    }

    public static void remove(){
        threadLocal.remove();
    }

}

Spring MVC

Spring MVC 有自己的拦截器，我们也可以直接使用 servlet-api 中Filter 。同样的，我们将Trace Id 放入 ThreadLocal ，这样后面业务就可以通过ThreadLocal 操作Trace Id。

java 复制代码

/**
 * @ClassName TraceIdFilter
 * @Description
 * @Author codetonight 今夜写代码 https://blog.csdn.net/happycao123
 * @Date 2024/12/14 15:52
 */
public class TraceIdFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        String traceId = request.getHeader("traceId");
        if(traceId == null) {
           traceId = UUID.randomUUID().toString().replace("-","");
        }
        TraceUtil.setTraceId(traceId);
        try{
            filterChain.doFilter(servletRequest,servletResponse);
        }finally {
            TraceUtil.remove();
        }
    }
}

上面实现比较粗糙，信息也不够全，还存在异步方法链路无法透传问题，当然更重要的缺乏链路查询的支持。