一、技术原理1.1 背景
微服务架构是一个分布式架构，它按业务划分服务单元，一个分布式系统往往有很多个服务单元。由于服务单元数量众多，业务的复杂性，如果出现了错误和异常，很难去定位。主要体现在，一个请求可能需要调用很多个服务，而内部服务的调用复杂性，决定了问题难以定位。所以微服务架构中，必须实现分布式链路追踪，去跟进一个请求到底有哪些服务参与，参与的顺序又是怎样的，从而达到每个请求的步骤清晰可见，出了问题，很快定位。
举个例子，在微服务系统中，一个来自用户的请求，请求先达到前端A（如前端界面），然后通过远程调用，达到系统的中间件B、C（如负载均衡、网关等），最后达到后端服务D、E，后端经过一系列的业务逻辑计算最后将数据返回给用户。对于这样一个请求，经历了这么多个服务，怎么样将它的请求过程的数据记录下来呢？这就需要用到服务链路追踪。
Google开源的 Dapper链路追踪组件，并在2010年发表了论文《Dapper, a Large-Scale Distributed Systems Tracing Infrastructure》，这篇文章是业内实现链路追踪的标杆和理论基础，具有非常大的参考价值。
目前，链路追踪组件有Google的Dapper，Twitter 的Zipkin，以及阿里的Eagleeye （鹰眼）等，它们都是非常优秀的链路追踪开源组件。
1.2 名词术语微服务链路追踪系统实现时，需设置一些关键节点记录信息，链路追踪相关名词如下：
Span：基本工作单元，发送一个远程调度任务 就会产生一个Span，Span是一个64位ID唯一标识的，Trace是用另一个64位ID唯一标识的，Span还有其他数据信息，比如摘要、时间戳事件、Span的ID、以及进度ID。
Trace：一系列Span组成的一个树状结构。请求一个微服务系统的API接口，这个API接口，需要调用多个微服务，调用每个微服务都会产生一个新的Span，所有由这个请求产生的Span组成了这个Trace。
Annotation：用来及时记录一个事件的，一些核心注解用来定义一个请求的开始和结束 。这些注解包括以下：
cs - Client Sent -客户端发送一个请求，这个注解描述了这个Span的开始
sr - Server Received -服务端获得请求并准备开始处理它，如果将其sr减去cs时间戳便可得到网络传输的时间。
ss - Server Sent （服务端发送响应）–该注解表明请求处理的完成(当请求返回客户端)，如果ss的时间戳减去sr时间戳，就可以得到服务器请求的时间。
cr - Client Received （客户端接收响应）-此时Span的结束，如果cr的时间戳减去cs时间戳便可以得到整个请求所消耗的时间。
1.3 调用链分析一个服务调用过程如下图所示：
 二、技术实现调用方每一次向系统服务发起请求时，会生成这一次调用产生的相关调用链日志，生成一个全局的traceId，生成不同节点的span信息。其中当首个服务生成全局编码后，放入到header中，基于http传递给下级服务(其他模式类似)。下级服务可通过设置Filter过滤器（其他方案也可以），接收链路日志编码，并记录调用的日志信息。在将全局编码继续传递给下级服务。最终本次业务调用完成后，记录调用日志并清空本次调用链产生的全局编码。简易流程如下图所示：
 2.1 单服务流程说明
服务A调用链日志信息参考：
// trace日志 { "message":"trace log", "context":{ "trace_id":"e0d5c5ba-f497-4407-b8ca-f657a88452fc517513", "request_uri":"/customize-trace-A/trace/jdk/async", "request_method":"GET", "refer_service_name":null, "service_name":"customize-trace-A", "refer_service_host":"127.0.0.1", "request_time":1608896030.689531, "response_time":1608896030.692276, "time_used":3.479, "service_addr":"192.168.45.42", "service_port":8095, "request_id":"9adfcf3c-d606-418f-abc7-6600bff6adf0533098" }, "datetime":"2020-12-25 19:33:50.690014" } // span节点 { "trace_id":"e0d5c5ba-f497-4407-b8ca-f657a88452fc517513", "request_id":"9adfcf3c-d606-418f-abc7-6600bff6adf0533098", "span":{ "span_id":"eb12eaf8-df3d-4dd2-923a-685360a4fd79588942", "parent_id":null, "duration":3426, "annotations":[ { "timestamp":1608896030686322, "action":"sr" }, { "timestamp":1608896030689748, "action":"ss" } ] } , "datetime":"2020-12-25 19:34:50.690014" } 2.2 多服务流程说明多个服务与单个服务对比，是在不同的微服务里面分别记录对应的Trace信息，Span信息。同一个调用请求，所有微服务记录的TraceId一致，父服务的SpanId为子服务的ParentSpanId。
举例两个服务间的调用流程如下：
2.3 中间件记录Span信息中间件是否需要记录Span信息
上述举例并未记录服务的Service方法执行一段时间后，何时通过中间件发起调用其他服务的Span信息。现实业务中，服务调用经常存在这种情况，服务A中某一个方法，先调用了服务B，获取到服务B的返回结果后，后续还又调用了服务C，服务D。此刻若不记录中间件的Span信息，在分析部分调用链超时情况时，会难以定位分析。只能获取到接受方的接收时间，不知道某一个服务调用时具体的发起时间（如服务D最终接收请求时的时间与最初进入服务A记录的请求时间相差一分钟，但这并不能说服务A调用服务D的接口就耗时一分钟）。
因此，中间件模块记录Span信息也至关重要。比如一个http请求的中间件，可重写他的Client实现类，记录开始发起请求和请求完成（类似于Filter）这一段时间的Span信息。
2.4 TraceId的管理
每一个请求过来时，产生一个独立的子线程，在这个子线程内部设置对应的traceId,可基于ThreadLocal存储调用链相关信息，达到子线程信息隔离的目的。
了解调用链信息基本原理后，自定义编码实现一套基于traceId的调用链追踪技术方案，需解决如下问题：
三、技术细节分析3.1 生成调用链相关编码traceId:全局调用链日志id编码，在多个服务调用的一条调用链日志中，为同一个日志编码
spanId:spanId节点的唯一编码
requestId:本次请求生成的唯一id编码，在多个服务调用的一条调用链日志中，为不同的日志编码
每一次发起业务调用完成后，需清空本次产生的编码。同时，不同线程的调用链日志应互不影响。故调用链信息可基于MDC技术实现，查看MDC的实现原理，本质还是基于ThreadLocal实现。本例直接基于ThreadLocal实现，部分伪代码如下：
public class LoggerUtil{ /** * 生成traceId ，requestId，spanId 类似，设置不同的方法名即可 */ static String traceId() { return UUID.randomUUID().toString() + new Random().nextInt(1000000); } } public final class ThreadHolderUtil { /** * 任意类型数据集合 */ private static final ThreadLocal<Map<Object, Object>> VALUE_MAP = ThreadLocal.withInitial(HashMap::new); /** * 设置key值 * * @param key key * @param value 值 */ public static void setValue(Object key, Object value) { Optional.ofNullable(VALUE_MAP.get()).ifPresent(valueMap -> valueMap.put(key, value)); } /** * 清除指定Key * * @param key 指定key */ public static void clearValue(Object key) { Optional.ofNullable(VALUE_MAP.get()).ifPresent(valueMap -> valueMap.remove(key)); } /** * 清除整个map */ public static void clearValueMap() { VALUE_MAP.remove(); } }
3.2 调用链编码传递调用链编码传递主要是一个请求涉及到多个微服务时，一般是从网关（或首个请求的微服务）生成调用链编码后，该编码在不同微服务中的流转过程。本文主要介绍Feign和线程池中traceId的链路传递
参考文档：基于TraceId链路追踪
Feign传递编码-重写RequestInterceptor
网上介绍方案大多是通过重写实现RequestInterceptor接口实现的。参考代码如下：
/** * 调用服务追踪信息feign拦截器 * */ public class FeignTraceInterceptor implements RequestInterceptor { private static final Logger LOGGER = LoggerUtil.getTraceLogger(); @Override public void apply(RequestTemplate template) { String projectName = LoggerUtil.PROJECT_NAME; if (!StringUtils.isEmpty(projectName)) { template.header(REFER_SERVICE_NAME, projectName); } if (!StringUtils.isEmpty(HOST_IP)) { template.header(REFER_REQUEST_HOST, HOST_IP); } String traceId = TraceUtil.getTraceId(); if (StringUtils.isEmpty(traceId)) { traceId = LoggerUtil.traceId(); } template.header(GATEWAY_TRACE, traceId); String spanId = TraceContext.parentSpanId(); template.header(PARENT_ID_HEADER, spanId); } } @ConditionalOnClass(Feign.class) public static class FeignTraceAutoConfiguration { @Bean public FeignTraceInterceptor feignTraceInterceptor() { return new FeignTraceInterceptor(); } } 该方案是把调用链编码通过header传递给下级服务了，但并没有记录Feign处的Span信息。参考模型如下图所示：
 Feign传递编码-重新实现内部调用的 Http Client
扩展方案是需要记录每一次调用Feign时，记录Feign处的Span信息。Feign最终可通过在http发起请求时，调整内部的Http Client扩展实现，达到记录Span信息的目的。（整体方案偏复杂，要考虑负载均衡时，池化请求等模式时，都可以记录信息）
Feign添加自定义注解
目的是为了记录Feign在执行方法前后的调用链信息，可采用加入注解，在Feign类上面标记，记录方法执行前后时的情况。调用链信息还是通过重写RequestInterceptor实现传递给下级服务。
采用Feign调用其他服务，记录Fegin的Span信息，可通过方案：（Feign传递编码重写RequestInterceptor， Feign请求添加注解，组合实现。）
编写一个注解，并记录调用方法前后的时间信息，参考伪代码：
@Aspect @Component public class FeignSpanAspect { @Pointcut("@annotation(com.trace.base.tool.annotation.FeignSpan)") public void pointcut() { } @Around("pointcut()") public void around(ProceedingJoinPoint joinPoint) { try { // 先生成spanId String spanId = TraceContext.parentSpanId(); ThreadHolderUtil.setValue("feign-spanId", spanId); // cs Annotation cs = TraceContext.cs(); List<Annotation> annotations = new ArrayList<>(2); annotations.add(cs); // 避免执行超时,所以先设置span cs信息 Span span = new Span.Builder() .parentId(ThreadHolderUtil.getValue(PARENT_SPAN_ID_KEY, String.class)) .spanId(spanId) .annotations(annotations) .build(); List<Span> subSpanList = ThreadHolderUtil.getValue(SUB_SPAN_LIST_KEY, List.class); if (subSpanList != null) { subSpanList.add(span); } joinPoint.proceed(); // cr Annotation cr = TraceContext.cr(); // 增加cr annotations.add(cr); span.setDuration(cr.getTimestamp() - cs.getTimestamp()); } catch (Throwable throwable) { throwable.printStackTrace(); } } } 线程池传递编码
主线程中记录的调用链信息通过线程池执行时，子线程会获取不到主线程的调用链信息（子线程获取traceId为null）。因此，需要在子线程执行时，主线程向子线程传递调用链相关编码信息。参考文档：
多线程相关知识：多线程-JUC线程池
Spring 回调方法装饰器：多线程调用如何传递上下文
JDK原生扩展Callable，Runnable:traceId跟踪请求全流程日志
3.3 微服务过滤器接收调用链编码上游服务向下游服务发起调用请求时，下游服务接收到请求时，加入一个基础过滤器（设置过滤器order值小于其他业务的order值，保证优先执行），获取上游服务请求信息中的调用链信息，获取出来后，记录请求Trace日志信息，并通过ThreadLocal模式，记录调用链信息。参考实现部分伪代码如下：
@Override public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException { HttpServletRequest servletRequest = (HttpServletRequest) request; String uri = servletRequest.getRequestURI(); // 服务健康检查日志不统计,根目录和HEAD请求忽略 final String slash = "/"; if (Arrays.stream(ignorePath).anyMatch(uri::startsWith) || slash.equals(uri) || HttpMethod.HEAD.name().equalsIgnoreCase(servletRequest.getMethod())) { chain.doFilter(request, response); } else { try { int port = request.getLocalPort(); TraceLog traceLog = new TraceLog(); traceLog.setRequestTime(getNowUs()); //服务名称 traceLog.setServiceName(LoggerUtil.PROJECT_NAME); // 开始时间戳(微秒) long start = LocalDateTimeUtil.getCurrentMicroSecond(); // traceId String traceId = servletRequest.getHeader(GATEWAY_TRACE); // 没有就新生成一个 if (StringUtils.isEmpty(traceId)) { traceId = LoggerUtil.traceId(); } // 尝试获取上游传递的parent_id String parentId = servletRequest.getHeader(TraceContext.PARENT_ID_HEADER); // 首先设置span id,作为后续子span的父span id String spanId = TraceContext.parentSpanId(); ThreadHolderUtil.setValue(PARENT_SPAN_ID_KEY, spanId); // 需要提前初始化子span列表,否则父子线程无法持有一个数据引用 ThreadHolderUtil.setValue(SUB_SPAN_LIST_KEY, new ArrayList<>()); // sr Annotation sr = TraceContext.sr(); String requestId = LoggerUtil.requestId(); // 设置trace,用于ResponseBody能够获取 Trace trace = new Trace(traceId, requestId); ThreadHolderUtil.setValue(TRACE_KEY, trace); traceLog.setTraceId(traceId); // 远程调用服务名称 traceLog.setReferServiceName(servletRequest.getHeader(REFER_SERVICE_NAME)); traceLog.setRequestUri(servletRequest.getRequestURI()); String method = servletRequest.getMethod(); traceLog.setRequestMethod(method); traceLog.setServicePort(port); // 原始response对象 chain.doFilter(request, response); // 结束时间戳(微秒) long end = LocalDateTimeUtil.getCurrentMicroSecond(); // ss Annotation ss = TraceContext.ss(); // duration long duration = ss.getTimestamp() - sr.getTimestamp(); // span日志 SpanLog spanLog = new SpanLog(); // 父span Span span = new Span.Builder() .parentId(parentId) .spanId(spanId) .duration(duration) .annotations(Arrays.asList(sr, ss)) .build(); spanLog.setTraceId(traceId); spanLog.setRequestId(requestId); spanLog.setSpan(span); List<Span> subSpanList = ThreadHolderUtil.getValue(SUB_SPAN_LIST_KEY, List.class); spanLog.setSubSpans(subSpanList); // todo 存储span信息 // todo 存储trace信息 } finally { // 最后清除VALUE_MAP // 执行完成后，清空产生的日志信息 ThreadHolderUtil.clearValueMap(); } } } 3.4 Span生成与管理通过技术原理分析，生成Span的场景为每一个微服务请求开始至请求完成时，记录一个Span节点信息。若服务执行过程中，通过中间件调用了其他微服务时，每一次中间件调用时，再记录一个Span节点信息（调用多少次，记录多少个）。
3.5 调用链日志存储发起一次调用后，会生成Trace请求信息，Span节点信息，针对这些日志信息，可以通过写入到Log4g2日志中。或者写入到其他数据库等系统中做日志信息存储，便于后续分析问题。
举例一个场景：
发起请求，先调用服务A，服务A通过Feign调用一次服务B，整体记录日志参考如下：
服务A对应traceLog
{ "message":"trace log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_uri":"/customize-trace-A/trace/feign/name", "request_method":"GET", "refer_service_name":null, "service_name":"customize-trace-A", "refer_service_host":"127.0.0.1", "request_time":1612344583.027557, "response_time":1612344589.716305, "time_used":4774.917, "service_addr":"192.168.45.42", "service_port":8095, "request_id":"01d91c6f-1745-414c-a556-06d2e2630995119672" }, "level":200, "level_name":"INFO", "channel":"REQUEST", "datetime":"2021-02-03 17:29:50.405499" } 服务A对应spanLog
全局traceId: 2bf002c7-c140-4304-9c42-98ec0e359e1a314225。
{ "message":"span log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_id":"01d91c6f-1745-414c-a556-06d2e2630995119672", "span":{ "span_id":"e495b1e3-72e3-4dfc-92ad-8526c1c05e68901528", "parent_id":null, "duration":4772900, "annotations":[ { "timestamp":1612344583030172, "action":"sr" }, { "timestamp":1612344587803072, "action":"ss" } ] }, "request_uri":null, "request_method":null, "sub_spans":[ { "span_id":"6a112df7-762d-4467-aab5-8d4ea8d30e34265554", "parent_id":"e495b1e3-72e3-4dfc-92ad-8526c1c05e68901528", "duration":4064421, "annotations":[ { "timestamp":1612344583090733, "action":"cs" }, { "timestamp":1612344587155154, "action":"cr" } ] } ] }, "level":200, "level_name":"INFO", "channel":"SPAN", "datetime":"2021-02-03 17:29:49.705213" } 服务B对应traceLog
{ "message":"trace log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_uri":"/customize-trace-B/trace/name", "request_method":"GET", "refer_service_name":"customize-trace-A", "service_name":"customize-trace-B", "refer_service_host":"127.0.0.1", "request_time":1612344586.914167, "response_time":1612344587.162829, "time_used":218.196, "service_addr":"192.168.45.42", "service_port":8096, "request_id":"c3141791-b5c4-49e3-ad4a-08c40782f687651638" }, "level":200, "level_name":"INFO", "channel":"REQUEST", "datetime":"2021-02-03 17:29:47.161630" } 服务B对应spanLog
{ "message":"span log", "context":{ "trace_id":"2bf002c7-c140-4304-9c42-98ec0e359e1a314225", "request_id":"c3141791-b5c4-49e3-ad4a-08c40782f687651638", "span":{ "span_id":"d4a7f2d5-d49d-4f88-95ee-4f73c18ff9d5967084", "parent_id":"6a112df7-762d-4467-aab5-8d4ea8d30e34265554", "duration":207818, "annotations":[ { "timestamp":1612344586929937, "action":"sr" }, { "timestamp":1612344587137755, "action":"ss" } ] }, "request_uri":null, "request_method":null, "sub_spans":[ ] }, "level":200, "level_name":"INFO", "channel":"SPAN", "datetime":"2021-02-03 17:29:47.139560" } 四、自实现方案优缺点
五、案例源码参考完整实现代码：https://github.com/wuya11/TraceDemo 运行截图参考：
|
|
|
