Spring Cloud Sleuth 链路追踪

Ynthm Wang 收录于微服务

2022-08-03 约 1860 字预计阅读 4 分钟

分布式链路追踪(Distributed Tracing)，就是将一次分布式请求还原成调用链路，进行日志记录，性能监控并将一次分布式请求的调用情况集中展示。比如各个服务节点上的耗时、请求具体到达哪台机器上、每个服务节点的请求状态等等。

常见的链路追踪技术有下面这些:

Spring Cloud Sleuth 提供的分布式系统中链路追踪解决方案。
zipkin 由Twitter公司开源，开放源代码分布式的跟踪系统，用于收集服务的定时数据，以解决微服务架构中的延迟问题，包括:数据的收集、存储、查找和展现。该产品结合spring-cloud-sleuth 使用较为简单，集成很方便，但是功能较简单。
skywalking SkyWalking 是本土开源的基于字节码注入的调用链分析，以及应用监控分析工具。特点是支持多种插件，UI功能较强，接入端无代码侵入。目前已加入Apache孵化器。
cat 由大众点评开源，基于Java开发的实时应用监控平台，包括实时应用监控，业务监控。集成方案是通过代码埋点的方式来实现监控，比如: 拦截器，过滤器等。对代码的侵入性很大，集成成本较高。风险较大。
pinpoint :Pinpoint 是韩国人开源的基于字节码注入的调用链分析，以及应用监控分析工具。特点是支持多种插件，UI功能强大，接入端无代码侵入。

Spring Cloud Alibaba 技术栈中并没有提供自己的链路追踪技术的，可以采用Sleuth +Zinkin来做链路追踪解决方案

Sleuth 入门

SpringCloud Sleuth主要功能就是在分布式系统中提供追踪解决方案。它大量借用了Google Dapper的设计，先来了解一下Sleuth中的术语和相关概念。

Spring Cloud Sleuth 为Spring Cloud 的分布式跟踪解决方案提供 API 。它与OpenZipkin Brave集成

Spring Cloud Sleuth 能够跟踪您的请求和消息，以便您可以将该通信与相应的日志条目相关联。您还可以将跟踪信息导出到外部系统以可视化延迟。Spring Cloud Sleuth 直接支持OpenZipkin兼容系统。

术语

Spring Cloud Sleuth 借用了 Dapper 的术语。

Trace 由一组Trace Id相同的Span串联形成一个树状结构。为了实现请求跟踪，当请求到达分布式系统的入口端点时，只需要服务跟踪框架为该请求创建一个唯一的标识(即TraceId)，同时在分布式系统内部流转的时候，框架始终保持传递该唯一值，直到整个请求的返回。那么我们就可以使用该唯一标识将所有的请求串联起来，形成一条完整的请求链路。

Span 代表了一组基本的工作单元。为了统计各处理单元的延迟，当请求到达各个服务组件的时候，也通过一个唯一标识(SpanId)来标记它的开始、具体过程和结束。通过SpanId的开始和结束时间戳，就能统计该span的调用时间，除此之外，我们还可以获取如事件的名称。请求信息等元数据。

Annotation/Event 用它记录一段时间内的事件，内部使用的重要注释:

cs(Client Send)客户端发出请求，开始一个请求的生命
sr(Server Received)服务端接受到请求开始进行处理， sr-cs = 网络延迟(服务调用的时间)
ss(Server Send)服务端处理完毕准备发送到客户端，ss - sr = 服务器上的请求处理时间
cr(Client Reveived)客户端接受到服务端的响应，请求结束。 cr - sr = 请求的总时间

/images/spring-cloud/tracing/trace-id.jpg — Span and Trace

1
2
3
4


 <dependency> 
  <groupId>org.springframework.cloud</groupId> 
  <artifactId>spring-cloud-starter-sleuth</artifactId> 
 </dependency>

引入依赖，可以在控制台观察到sleuth的日志输出。

Zipkin 集成

通过Zipkin可以将日志聚合，并进行可视化展示和全文检索。

Zipkin 是 Twitter 的一个开源项目，它基于Google Dapper实现，它致力于收集服务的定时数据，以解决微服务架构中的延迟问题，包括数据的收集、存储、查找和展现。

Zipkin 提供了可插拔数据存储方式:In-Memory、MySql、Cassandra 以及 Elasticsearch。

核心组件构成:

Collector:收集器组件，它主要用于处理从外部系统发送过来的跟踪信息，将这些信息转换为 Zipkin内部处理的 Span 格式，以支持后续的存储、分析、展示等功能。
Storage:存储组件，它主要对处理收集器接收到的跟踪信息，默认会将这些信息存储在内存中，我们也可以修改此存储策略，通过使用其他存储组件将跟踪信息存储到数据库中。
RESTful API:API 组件，它主要用来提供外部访问接口。比如给客户端展示跟踪信息，或是外接系统访问以实现监控等。
Web UI:UI 组件，基于API组件实现的上层应用。通过UI组件用户可以方便而有直观地查询和分析跟踪信息。

Zipkin分为两端，一个是 Zipkin服务端，一个是 Zipkin客户端，客户端也就是微服务的应用。客户端会配置服务端的 URL 地址，一旦发生服务间的调用的时候，会被配置在微服务里面的 Sleuth 的监听器监听，并生成相应的 Trace 和 Span 信息发送给服务端。

服务端启动

1

docker run -d -p 9411:9411 openzipkin/zipkin

服务端可以配置持久化

Zipkin UI at http://your_host:9411/zipkin/

Zipkin 客户端集成

1
2
3
4
5
6


<!-- https://mvnrepository.com/artifact/org.springframework.cloud/spring-cloud-sleuth-zipkin -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-sleuth-zipkin</artifactId>
    <version>3.1.3</version>
</dependency>

目录

Spring Cloud Sleuth 链路追踪

Sleuth 入门

术语

Zipkin 集成

服务端启动

Zipkin 客户端集成

附录