springCloud alibaba：Sleuth--链路追踪

系统管理员 2023-10-11 17:22 23阅读 0赞

#### 文章目录 ####

*  1.什么是链路追踪
 *  2.集成Sleuth
 *   *  2.1 Sleuth介绍
     *  2.2 Sleuth入门
 *  3.Zipkin的集成
 *   *  3.1 ZipKin介绍
     *  3.2 ZipKin服务端安装
     *  3.3 Zipkin客户端集成
     *  3.4 ZipKin数据持久化
     *   *  3.4.1 基于mysql的数据持久化操作
         *  3.4.1 基于elasticsearch的数据持久化操作

## 1.什么是链路追踪 ##

在大型系统的微服务化构建中，一个系统被拆分成了许多模块。这些模块负责不同的功能，组合成系统，最终可以提供丰富的功能。在这种架构中，一次请求往往需要涉及到多个服务。互联网应用构建在不同的软件模块集上，这些软件模块，有可能是由不同的团队开发、可能使用不同的编程语言来实现、有可能布在了几千台服务器，横跨多个不同的数据中心，也就意味着这种架构形式也会存在一些问题：

*  如何快速发现问题？
 *  如何判断故障影响范围？
 *  如何梳理服务依赖以及依赖的合理性？
 *  如何分析链路性能问题以及实时容量规划？

![在这里插入图片描述][22abcc47df924c90a0e4f50484707b12.png_pic_center]

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

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

下面我们重点讲解通过Sleuth +Zinkin来做链路追踪解决方案。

## 2.集成Sleuth ##

### 2.1 Sleuth介绍 ###

SpringCloud Sleuth主要功能就是在分布式系统中提供追踪解决方案。它大量借用了Google Dapper的设计  
再具体使用sleuth之前，我们需要先来了解一下一些基本概念和术语。

*  Trace

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

*  Span

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

*  Annotation

用它记录一段时间内的事件，内部使用的重要注释：

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

![在这里插入图片描述][96aeb379b6b44327a589b70512fdec56.png_pic_center]

### 2.2 Sleuth入门 ###

我们的服务信息如下：  
\[api-gateway,3977125f73391553,3977125f73391553,false\]  
\[service-order,3977125f73391553,57547b5bf71f8242,false\]  
\[service-product,3977125f73391553,449f5b3f3ef8d5c5,false\]  
上面分别代表什么呢？  
\[服务名,traceId,spanId,是否将链路的追踪结果输出到第三方平台\]  
下面我们创建以上三个服务（可以先只创建一个测试着玩，如只创建service-order服务），并且注册到nacos  
不会创建?[点击此处看看][Link 1]  
![在这里插入图片描述][910f5fd13124418c9a6f997323994ded.png_pic_center]

在每个项目里都引入Sleuth依赖，当然如果你配置了父工程的话可以在父工程加入该依赖

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

启动项目，我们以order服务为了，我们加入一个测试接口

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    public class TestController {
        
        private final Logger logger= LoggerFactory.getLogger(TestController.class);
        @GetMapping("test")
        public String test() {
        
            logger.info("测试");
            return "测试";
        }
    }

访问此接口，我们查看 控制台会发现：  
![在这里插入图片描述][34b9f0af4e184c59b73ddca5c511dba2.png_pic_center]

其中 f9bfc301317ba17e 是TraceId， f9bfc301317ba17e 是SpanId，依次调用有一个全局的TraceId，将调用链路串起来。仔细分析每个微服务的日志，不难看出请求的具体过程。  
查看日志文件并不是一个很好的方法，当微服务越来越多日志文件也会越来越多，如何将日志聚合将会是个问题，于是Zipkin应运而生，通过Zipkin可以将日志聚合，并进行可视化展示和全文检索。

## 3.Zipkin的集成 ##

### 3.1 ZipKin介绍 ###

Zipkin 是 Twitter 的一个开源项目，它基于Google Dapper实现，它致力于收集服务的定时数据，以解决微服务架构中的延迟问题，包括数据的收集、存储、查找和展现。  
我们可以使用它来收集各个服务器上请求链路的跟踪数据，并通过它提供的REST API接口来辅助我们查询跟踪数据以实现对分布式系统的监控程序，从而及时地发现系统中出现的延迟升高问题并找出系统性能瓶颈的根源。

除了面向开发的 API 接口之外，它也提供了方便的UI组件来帮助我们直观的搜索跟踪信息和分析请求链路明细。  
比如：可以查询某段时间内各用户请求的处理时间等。

Zipkin 提供了可插拔数据存储方式：In-Memory、MySql、Cassandra 以及 Elasticsearch。  
![在这里插入图片描述][159f0adc60144d06b2710c86ace566cf.png_pic_center]

上图展示了 Zipkin 的基础架构，它主要由 4 个核心组件构成：

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

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

### 3.2 ZipKin服务端安装 ###

下载jar包,[点击此处下载][Link 2]  
我下载的最新版  
![在这里插入图片描述][47a44cd4905b4770907361e8d61f8927.png_pic_center]

运行jar

java -jar zipkin-server-2.23.9-exec.jar

访问网址：http://localhost:9411/zipkin/  
![在这里插入图片描述][6eb118c3fb7742dbb8e391f81ad2fa3e.png_pic_center]

### 3.3 Zipkin客户端集成 ###

*  在每个微服务上添加依赖

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-zipkin</artifactId>
                <version>2.2.8.RELEASE</version>
    </dependency>

*  添加以下配置

# 远程地址
    #zipkin
    spring.zipkin.base-url=http://127.0.0.1:9411/
    # 让nacos把它当成一个url，而不是要当成服务名
    spring.zipkin.discovery-client-enabled=false
    # 设置使用http的方式传输数据
    spring.zipkin.sender.type=web
    #采样的百分比
    spring.sleuth.web.client.enabled=true
    # 采样比例为: 0.1(即10%),设置的值介于0.0到1.0之间，1.0则表示全部采集。
    spring.sleuth.sampler.probability=1.0

我们访问一下之前创建的测试接口，然后刷新一下http://localhost:9411/zipkin/页面  
![在这里插入图片描述][10eb1c2cc8a54d71bb802392fe7a0e65.png_pic_center]

但是呢，我们每一次重启服务都会导致zipkin的数据丢失，这是因为zipkin的数据均是保存在内存中，所以下面我们做一些持久化操作

### 3.4 ZipKin数据持久化 ###

在介绍zipkin时，我已经提到了Zipkin 提供了可插拔数据存储方式：In-Memory、MySql、Cassandra 以及 Elasticsearch。  
下面我重点说一下比较流行的mysql和Elasticsearch这两种方式

#### 3.4.1 基于mysql的数据持久化操作 ####

创建数据库**zipkin**，执行以下sql语句

/*
    Navicat MySQL Data Transfer
    
    Source Server         : local_zx
    Source Server Version : 80018
    Source Host           : localhost:3306
    Source Database       : zipkin
    
    Target Server Type    : MYSQL
    Target Server Version : 80018
    File Encoding         : 65001
    
    Date: 2022-04-30 23:11:14
    */
    
    SET FOREIGN_KEY_CHECKS=0;
    
    -- ----------------------------
    -- Table structure for zipkin_annotations
    -- ----------------------------
    DROP TABLE IF EXISTS `zipkin_annotations`;
    CREATE TABLE `zipkin_annotations` (
      `trace_id_high` bigint(20) NOT NULL DEFAULT '0' COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
      `trace_id` bigint(20) NOT NULL COMMENT 'coincides with zipkin_spans.trace_id',
      `span_id` bigint(20) NOT NULL COMMENT 'coincides with zipkin_spans.id',
      `a_key` varchar(255) NOT NULL COMMENT 'BinaryAnnotation.key or Annotation.value if type == -1',
      `a_value` blob COMMENT 'BinaryAnnotation.value(), which must be smaller than 64KB',
      `a_type` int(11) NOT NULL COMMENT 'BinaryAnnotation.type() or -1 if Annotation',
      `a_timestamp` bigint(20) DEFAULT NULL COMMENT 'Used to implement TTL; Annotation.timestamp or zipkin_spans.timestamp',
      `endpoint_ipv4` int(11) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',
      `endpoint_ipv6` binary(16) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null, or no IPv6 address',
      `endpoint_port` smallint(6) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',
      `endpoint_service_name` varchar(255) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',
      UNIQUE KEY `trace_id_high` (`trace_id_high`,`trace_id`,`span_id`,`a_key`,`a_timestamp`) COMMENT 'Ignore insert on duplicate',
      KEY `trace_id_high_2` (`trace_id_high`,`trace_id`,`span_id`) COMMENT 'for joining with zipkin_spans',
      KEY `trace_id_high_3` (`trace_id_high`,`trace_id`) COMMENT 'for getTraces/ByIds',
      KEY `endpoint_service_name` (`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames',
      KEY `a_type` (`a_type`) COMMENT 'for getTraces',
      KEY `a_key` (`a_key`) COMMENT 'for getTraces'
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;
    
    -- ----------------------------
    -- Table structure for zipkin_dependencies
    -- ----------------------------
    DROP TABLE IF EXISTS `zipkin_dependencies`;
    CREATE TABLE `zipkin_dependencies` (
      `day` date NOT NULL,
      `parent` varchar(255) NOT NULL,
      `child` varchar(255) NOT NULL,
      `call_count` bigint(20) DEFAULT NULL,
      UNIQUE KEY `day` (`day`,`parent`,`child`)
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;
    
    -- ----------------------------
    -- Table structure for zipkin_spans
    -- ----------------------------
    DROP TABLE IF EXISTS `zipkin_spans`;
    CREATE TABLE `zipkin_spans` (
      `trace_id_high` bigint(20) NOT NULL DEFAULT '0' COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
      `trace_id` bigint(20) NOT NULL,
      `id` bigint(20) NOT NULL,
      `name` varchar(255) NOT NULL,
      `parent_id` bigint(20) DEFAULT NULL,
      `debug` bit(1) DEFAULT NULL,
      `start_ts` bigint(20) DEFAULT NULL COMMENT 'Span.timestamp(): epoch micros used for endTs query and to implement TTL',
      `duration` bigint(20) DEFAULT NULL COMMENT 'Span.duration(): micros used for minDuration and maxDuration query',
      `remote_service_name` varchar(255) DEFAULT NULL,
      UNIQUE KEY `trace_id_high` (`trace_id_high`,`trace_id`,`id`) COMMENT 'ignore insert on duplicate',
      KEY `trace_id_high_2` (`trace_id_high`,`trace_id`,`id`) COMMENT 'for joining with zipkin_annotations',
      KEY `trace_id_high_3` (`trace_id_high`,`trace_id`) COMMENT 'for getTracesByIds',
      KEY `name` (`name`) COMMENT 'for getTraces and getSpanNames',
      KEY `start_ts` (`start_ts`) COMMENT 'for getTraces ordering and range'
    ) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

在启动jar包时，指定数据保存的mysql信息

java -jar  zipkin-server-2.23.9-exec.jar --STORAGE_TYPE=mysql --MYSQL_HOST=127.0.0.1 --MYSQL_TCP_PORT=3306 --MYSQL_DB=zipkin --MYSQL_USER=root --MYSQL_PASS=root

我们可以重启服务查看一下追踪的记录是否还存在  
![在这里插入图片描述][1517c8475288468d92ae0bc47b6bd0f9.png_pic_center]

如上图所示，可以看到我的两次访问信息均可以追踪到。

#### 3.4.1 基于elasticsearch的数据持久化操作 ####

*  1.安装elasticsearch  
    [点击此处下载][Link 3]  
    ![在这里插入图片描述][fda8a17227ad4316bb3da5a4a78ea013.png_pic_center]
 *  2.在启动ZipKin Server的时候，指定数据保存的elasticsearch的信息

java -jar  zipkin-server-2.23.9-exec.jar  --STORAGE_TYPE=elasticsearch --ES-HOST=localhost:9200

至此sleuth+zipkin的链路追踪我们就到此结束啦

[22abcc47df924c90a0e4f50484707b12.png_pic_center]: https://img-blog.csdnimg.cn/22abcc47df924c90a0e4f50484707b12.png#pic_center
[96aeb379b6b44327a589b70512fdec56.png_pic_center]: https://img-blog.csdnimg.cn/96aeb379b6b44327a589b70512fdec56.png#pic_center
[Link 1]: https://blog.csdn.net/zhiyikeji/article/details/123266023
[910f5fd13124418c9a6f997323994ded.png_pic_center]: https://img-blog.csdnimg.cn/910f5fd13124418c9a6f997323994ded.png#pic_center
[34b9f0af4e184c59b73ddca5c511dba2.png_pic_center]: https://img-blog.csdnimg.cn/34b9f0af4e184c59b73ddca5c511dba2.png#pic_center
[159f0adc60144d06b2710c86ace566cf.png_pic_center]: https://img-blog.csdnimg.cn/159f0adc60144d06b2710c86ace566cf.png#pic_center
[Link 2]: https://repo1.maven.org/maven2/io/zipkin/zipkin-server/
[47a44cd4905b4770907361e8d61f8927.png_pic_center]: https://img-blog.csdnimg.cn/47a44cd4905b4770907361e8d61f8927.png#pic_center
[6eb118c3fb7742dbb8e391f81ad2fa3e.png_pic_center]: https://img-blog.csdnimg.cn/6eb118c3fb7742dbb8e391f81ad2fa3e.png#pic_center
[10eb1c2cc8a54d71bb802392fe7a0e65.png_pic_center]: https://img-blog.csdnimg.cn/10eb1c2cc8a54d71bb802392fe7a0e65.png#pic_center
[1517c8475288468d92ae0bc47b6bd0f9.png_pic_center]: https://img-blog.csdnimg.cn/1517c8475288468d92ae0bc47b6bd0f9.png#pic_center
[Link 3]: https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-8-4
[fda8a17227ad4316bb3da5a4a78ea013.png_pic_center]: https://img-blog.csdnimg.cn/fda8a17227ad4316bb3da5a4a78ea013.png#pic_center