SpringCloud组件之sleuth和zipKin的使用

Posted 2020-12-18 WK_BlogYard

SpringCloud组件之sleuth和ZipKin的使用

声明：本文根据鲁班学院商鞅老师课程文档整理得来

帮助：本文涉及到的详细代码请参考：https://github.com/LoveWK/mySpringCloud.git

sleuth的介绍：

　　spring Cloud Sleuth为 spring Cloud提供了分布式跟踪的解决方案，它大量借用了Google Dapper、 Twitter Zipkin和 Apache HTrace的设计，先来了解一下 Sleuth的术语， Sleuth借用了 Dapper的术语。

　　span（跨度）：基本工作单元。 span用一个64位的id唯一标识。除ID外，span还包含其他数据，例如描述、时间戳事件、键值对的注解（标签）， spanID、span父 ID等。 span被启动和停止时，记录了时间信息。初始化 span被称为"rootspan"，该 span的 id和 trace的 ID相等。

　　trace（跟踪）：一组共享"rootspan"的 span组成的树状结构称为 traceo trac也用一个64位的 ID唯一标识， trace中的所有 span都共享该 trace的 ID

　　annotation（标注）： annotation用来记录事件的存在，其中，核心annotation用来定义请求的开始和结束。

　　CS（ Client sent客户端发送）：客户端发起一个请求，该 annotation描述了span的开 始。 

　　SR（ server Received服务器端接收）：服务器端获得请求并准备处理它。如果用 SR减去 CS时间戳，就能得到网络延迟。c) 

　　SS（ server sent服务器端发送）：该 annotation表明完成请求处理（当响应发回客户端时）。如果用 SS减去 SR时间戳，就能得到服务器端处理请求所需的时间。

　　CR（ Client Received客户端接收）： span结束的标识。客户端成功接收到服务器端的响应。如果 CR减去 CS时间戳，就能得到从客户端发送请求到服务器响应的所需的时间

　　Spring Cloud Sleuth可以追踪10种类型的组件：async、Hystrix，messaging，websocket，rxjava，scheduling，web（Spring MVC Controller，Servlet），webclient（Spring RestTemplate）、Feign、Zuul

　　下面我们通过一张图来看一下一个简单的微服务调用链：

　　

　　这张图是spring cloud 官方给出的示例图

　　图片详细讲了我们上文所说的概念在调用链中 处于什么状态以及改变

sleuth整合Zipkin实现分布式链路跟踪：

　　Zipkin简介:

　　　　Zipkin是 Twitter开源的分布式跟踪系统，基于 Dapper的论文设计而来。它的主要功能是收集系统的时序数据，从而追踪微服务架构的系统延时等问题。 Zipkin还提供了一个非常友好的界面，来帮助分析追踪数据。

　　为什么要使用Zipkin

　　　　因为sleuth对于分布式链路的跟踪仅仅是一些数据的记录， 这些数据我们人为来读取和处理难免会太麻烦了，所以我们一般吧这种数据上交给Zipkin Server 来统一处理.

　　怎么使用ZipKin?

　　　　首先编写一个Zipkin Server

　　　  我们创建一个新的module，引入相关依赖。

<dependencies>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
            <version>2.8.4</version>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
            <version>2.8.4</version>
        </dependency>
    </dependencies>

　　

 　　然后写启动类，并在启动类上加上@EnableZipkinServer注解

　　

 　　填写配置信息

management:
  metrics:
    web:
      server:
        autoTimeRequests: false
server:
  port: 9000

　　

 　　注意：

　　　　 在zipkin2.7.x以后便不支持自定义服务器需要使用官方的版本或者Docker 但是如果还是要使用的话就得加上这个配置。

　　完成上面的步骤之后，我们启动项目，然后访问/zipkin/

　　

 　　到这里，我们的ZipKin server就搭建完成了。

　　这是用来查询分布式链路数据的页面， 这里列出了查询条件， 从第一行开始从左到右分别是：

 　　　　微服务名称（就是你配置文件里面的application name） ，

　　　　span（即上文所解释的）名称 ，

　　　　时间段 ，

　　　　自定义查询条件，

　　　　一次调用链的持续时间，

　　　　一页数量，

　　　　排序规则

sleuth微服务整合Zipkin

　　首先在我们的微服务中加入相关依赖，我们需要依赖sleuth 和 sleuth与zipkin的整合依赖:

<!--sleuth 和 sleuth与zipkin的整合依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>

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

　　

　　然后在我们的微服务中加入以下配置：

spring:
    zipkin:
      base-url: http://localhost:9000  #指定Zipkin server地址
    sleuth:
      sampler:
        probability: 1.0  #request采样的数量 默认是0.1 也即是10%  顾名思义 采取10%的请求数据  因为在分布式系统中，数据量可能会非常大，因此采样非常重要。我们示例数据少最好配置为1全采样

　　

 　　power微服务一样的配置即可：

　　

 　　然后启动微服务并模拟一次调用链 我这里是用user 微服务调用了power微服务 （注意，每个微服务都需要和zipkin整合）

　　调用完成之后 我们去zipkin server 页面去看看:

　　首先通过user微服务调用power微服务：

　　

 　　然后我们去zipkin server 页面去看看:

　　

 　　点击查看详细信息：

　　

zipkin server 数据持久化问题

　　刚刚我们介绍了如何把分布式链路调用信息上传到 zipkin server 但是 有一个问题：当zipkin重启后我们的分布式链路数据全部清空了。

　　因为zipkin server 默认数据是存储在内存当中， 所以当你服务重启之后内存自然而然也就清空了。

使用Elasticsearch 做数据持久化

　　我们这里借用ES来做数据持久化， 当然 还可以用ELK来做， 我们这里演示ES

　　Elasticsearch 下载地址：https://www.elastic.co/cn/downloads/elasticsearch

　　下载完是个压缩包 解压出来 打开bin目录 找到elasticsearch.bat文件启动

　　

 　　等他启动一会儿然后在页面上输入localhost:9200看见如下信息说明Elasticsearch 启动好了：

　　

 　　

zipkin 与 Elasticsearch整合：

　　首先 我们在我们的zipkin server里面引入依赖

　　<dependency>
          <groupId>io.zipkin.java</groupId>
          <artifactId>zipkin-autoconfigure-storage-elasticsearch-http</artifactId>
          <version>2.3.1</version>
    </dependency>

　　

 　　然后在yml加入配置：

zipkin:
  storage:
    type: elasticsearch
    elasticsearch:
      cluster: elasticsearch
      hosts: http://localhost:9200
      index: zipkin

　　

 　　至此 zipkin的数据便和Elasticsearch整合起来了，现在再启动zipkin server 并且存储几条数据， 就算重启， 数据还会在上面。

微服务总结

　　

 

 　　由上图可以发现， spring cloud 把各个组件相互配合起来， 整合成一套成熟的微服务架构体系

　　其中， 由eureka做服务注册与发现，很好的把各个服务链接起来

　　ribbon+fegin提供了微服务的调用和负载均衡解决方案

　　hystrix 负责监控微服务之间的调用情况，以及降级和熔断保护

　　Hystrix dashboard监控Hystrix的熔断情况以及监控信息以图形化界面展示

　　spring cloud config 提供了统一的配置中心服务

　　所有外来的请求由zuul统一进行路由和转发，起到了API网关的作用

　　Sleuth+Zipkin把我们微服务的追踪数据记录下来并展示方便我们进行后续分析