SpringCloud Sleuth入门介绍这个标题不low吧

分手后的思念是犯贱 2022-10-17 13:53 19阅读 0赞

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01pbG9nZW5pdXM_size_16_color_FFFFFF_t_70_pic_center]

## 前言 ##

Hi,大家好,我是麦洛,今天带大家来了解一下SpringCloud Sleuth,这篇文章主要向大家介绍一下以下内容

![4284180d773da013b0481090ed0f9d0b.png][]

## Sleuth介绍 ##

你或许曾经听过这么一句话,一个新技术的出现是为了解决一个痛点问题。在介绍Sleuth之前,我们需要了解一下在没有Sleuth之前,我们的微服务遇到了什么问题?

### 1.微服务的现状？ ###

前段时间在一个交流群吹水,一个大佬说他们公司总共有上百个微服务。假如这句话真实，那么他们公司微服务调用可能会如下图所示:

![4c39f089c28bfd93e531e6661b88a669.png][]

来自网络的这张图很好的说明了微服务调用之间的复杂性。每一次前端请求往往需要涉及到多个服务。这些服务有可能是由不同的团队开发、可能使用不同的编程语言来实现、有可能布在了几千台服务器，横跨多个不同的数据中心。因此，就需要一些可以帮助理解系统行为、用于分析性能问题的工具，以便发生故障的时候，能够快速定位和解决问题。所以，链路追踪这个思想就被人提了出来，而我们今天要讨论的Sleuth就是借鉴该思想演变来的分布式追踪解决方案。

### 2.微服务跟踪解决了什么问题? ###

微服务跟踪(sleuth)其实是一个工具,它在整个分布式系统中能跟踪一个用户请求的过程(包括数据采集，数据传输，数据存储，数据分析，数据可视化)，捕获这些跟踪数据，就能构建微服务的整个调用链的视图，这是调试和监控微服务的关键工具。  
SpringCloudSleuth有4个特点

<table> 
 <thead> 
  <tr> 
   <th>特点</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>提供链路追踪</td> 
   <td align="left">通过sleuth可以很清楚的看出一个请求经过了哪些服务， 可以方便的理清服务局的调用关系</td> 
  </tr> 
  <tr> 
   <td>性能分析</td> 
   <td align="left">通过sleuth可以很方便的看出每个采集请求的耗时， 分析出哪些服务调用比较耗时，当服务调用的耗时 随着请求量的增大而增大时，也可以对服务的扩容提 供一定的提醒作用</td> 
  </tr> 
  <tr> 
   <td>数据分析 优化链路</td> 
   <td align="left">对于频繁地调用一个服务，或者并行地调用等， 可以针对业务做一些优化措施</td> 
  </tr> 
  <tr> 
   <td>可视化</td> 
   <td align="left">对于程序未捕获的异常，可以在zipkpin界面上看到</td> 
  </tr> 
 </tbody> 
</table>

## Sleuth基本术语 ##

Spring Cloud Sleuth采用的是Google的开源项目Dapper的专业术语。

*  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时间戳便可以得到整个请求所消耗的时间。

## Sleuth入门案例 ##

首先我们搞一个项目,大概如下面样子

![bdbe84a958d4d786afde333925ff7488.png][]

我们引入下面的依赖

<dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-sleuth</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>

我们创建一个测试类:

package com.milo.sleuth.controller;
    
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    @RestController
    @Slf4j
    public class Example { 
    
    
    
        @RequestMapping("/")
        String home() { 
            log.info("Hello world!");
            return "Hello World!";
        }
    
    
    }

启动项目以后,我们访问一下:

![bf084cf3fb292eba959366b6a06bdab4.png][]

这时候,我们来看看日志情况:

![314bc205d7079e7b6437268b88caba31.png][]

我们来看看它们分别代表什么意思

*  第一个就是我们服务名称,对应我们配置文件中的spring.application.name
 *  第二个就是traceId
 *  第三个就是spanId

虽然我们现在通过日志文件也可以识别调用路径,貌似并不是很方便,很直观,接下里我们来了解一下Zipkin

## Zipkin介绍 ##

Zipkin是一个分布式跟踪系统。它有助于收集解决服务体系结构中的延迟问题所需的时序数据。功能包括该数据的收集和查找。

如果您在日志文件中有跟踪ID，则可以直接跳至该跟踪ID。否则，您可以基于诸如服务，操作名称，标签和持续时间之类的属性进行查询。将为您汇总一些有趣的数据，例如服务中花费的时间百分比以及操作是否失败。

![跟踪视图屏幕截图][dc5f80782d5f14c96415853df3db2e55.png]

Zipkin UI还提供了一个依赖关系图，该关系图显示了每个应用程序中跟踪了多少个请求。这对于识别包括错误路径或对不赞成使用的服务的调用在内的汇总行为可能会有所帮助。

![依赖图屏幕截图][fe7fc17db95c2ed0e896897757d24c44.png]

需要对应用程序进行“仪表化”以将跟踪数据报告给Zipkin。这通常意味着配置[跟踪器或仪器库][Link 1]。向Zipkin报告数据的最流行方法是通过HTTP或Kafka，尽管存在许多其他选项，例如Apache ActiveMQ，gRPC和RabbitMQ。提供给UI的数据存储在内存中，或持久存储在受支持的后端（例如Apache Cassandra或Elasticsearch）中。

## Sleuth整合Zipkin ##

Zipkin 分为两端，一个是 Zipkin 服务端，一个是 Zipkin 客户端，客户端也就是微服务的应用，客户端会配置服务端的 URL 地址，一旦发生服务间的调用的时候，会被配置在微服务里面的 Sleuth 的监听器监听，并生成相应的 Trace 和 Span 信息发送给服务端。发送的方式有两种，一种是消息总线的方式如 RabbitMQ 发送，还有一种是 HTTP 报文的方式发送。

### 客户端 ###

首先,在刚刚的依赖文件中,我们加一个新成员

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

接着修改配置文件

# 应用名称
    spring:
      application:
        name: springcloud-sleuth
    # 应用服务 WEB 访问端口
    server:
      port: 9876
    
    
      zipkin:
        base-url: http://localhost:9411/ # 服务端地址
        sender:
          type: web                      # 数据传输方式，web 表示以 HTTP 报文的形式向服务端发送数据
      sleuth:
        sampler:
          probability: 1.0               # 收集数据百分比，默认 0.1（10%）

### 服务端 ###

Zipkin的服务端是一个可执行的jar文件,我们需要去下载

> 下载地址:https://search.maven.org/remote\_content?g=io.zipkin&a=zipkin-server&v=LATEST&c=exec

上面地址默认下载最新版本,大家也可以去下面的网址下载指定版本

![635fdc9e8ec732c32f4bc74adf2fac96.png][]

![551a6ce6d4189551191aeb929f55fe81.png][]

现在我们启动jar包

> java -jar zipkin-server-2.23.2-exec.jar

![d82d0e2d66900e29e02f054074782ca0.png][]

### 测试效果 ###

接下来我们访问一下http://localhost:9411/zipkin/,结果如下:

![6069fc3506ee4638a4ebdbb834ac9df6.png][]

环境搭架好了,现在我们测试一把,看看接入Zipkin之后,我们会看到什么效果?

我们访问http://localhost:9876/之后,点击Zipkin控制台的Run Query查询一下,看到如下效果:

![9d82830fc008e8c64c48f22737d8ac9b.png][]

继续点击show,我们去看看详情

![b823f7570a4cf7b11771ef26d9df1f5f.png][]

果然很强大,执行时间,什么请求方式,请求路径,那个类,那个方法一目了然

鉴于我们刚刚新建的只是一次很简单的调用,不足以模拟微服务场景,接下来我们来看一个复杂一点的场景;

这里为了偷懒,我们就不去创建自己的微服务,使用官方给我们提供的测试案例[brave-example][],如下所示

![0ed4b21bb0c06ac2694c7923288103e2.png][]

我们把代码搞下来,这个项目好像整合了好多技术的测试案例,看不懂,我就研究了下面的这个跑起来测试一下

![a9f13a4acd00d7fe73aed69a291cd414.png][]

我们用idea把这个项目导入进来,大概长这个鬼样子

![b6f2367d2b4975954dc49e12db8e076b.png][]

*  Backend代表后端服务
 *  Frontend代表前端服务

现在,我们首先保证我们Zipkin的服务端是ok的,这时候你首先启动后端服务,然后启动前端服务,其实就是执行以下main方法,接下来我们访问一下http://127.0.0.1:8081/,如下图所示

![9d0a520a69c5779a006cd169e95058f1.png][]

现在我们去zipkin查询一下,发现了一个新大陆,开心

![039ee9fce7273123a5113b8c105df4c5.png][]

就行show一下,看看里面啥情况

![da3e1df1c6248a6d3bbee6f9205a8b56.png][]

![f52debcd1a823bc0e0531391b556ddf4.png][]

## 总结 ##

本篇文章主要介绍了Sleuth的入门知识,并且整合Zipkin来可视化显示调用链路的整体情况,但是目前Zipkin数据存在于内存中,我们可以在接入Elasticsearch等工具来做数据持久化。谢谢大家，今天的分享就到这里

> 源码  
> https://gitee.com/milogenius/milogenius-springcloud  
> 模块:springcloud-sleuth

> 参考文章
> 
> \[1\].[SpringCloud Sleuth入门介绍][SpringCloud Sleuth]\[N\] 邓澎波
> 
> \[2\].[Spring Cloud 系列之 Sleuth 链路追踪（一）][Spring Cloud _ Sleuth]\[N\] [哈喽沃德先生][Link 2]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L01pbG9nZW5pdXM_size_16_color_FFFFFF_t_70_pic_center]: /images/20221014/5de17c077bc24854a9a43a79025d4a76.png
[4284180d773da013b0481090ed0f9d0b.png]: /images/20221014/9c7e096420ba40258c9f409858adf70e.png
[4c39f089c28bfd93e531e6661b88a669.png]: /images/20221014/6dc894eb470f4ae4814f8ed48774d778.png
[bdbe84a958d4d786afde333925ff7488.png]: /images/20221014/b19243b14df2479dbcea6a26d8de2583.png
[bf084cf3fb292eba959366b6a06bdab4.png]: /images/20221014/dc58cafe933c47488e4508b3e78f3e68.png
[314bc205d7079e7b6437268b88caba31.png]: /images/20221014/467c71ffbe9e413d9dc100f0021f6521.png
[dc5f80782d5f14c96415853df3db2e55.png]: /images/20221014/e57ed5f8420546c4aef095b7d521b8ef.png
[fe7fc17db95c2ed0e896897757d24c44.png]: /images/20221014/07f4435d960a4cc28f10838a3020bd3f.png
[Link 1]: https://zipkin.io/pages/tracers_instrumentation
[635fdc9e8ec732c32f4bc74adf2fac96.png]: /images/20221014/573197494cd74fdf9ac2c2c47dc492cf.png
[551a6ce6d4189551191aeb929f55fe81.png]: /images/20221014/46d9532b63a94f1baff98d65803ff8a9.png
[d82d0e2d66900e29e02f054074782ca0.png]: /images/20221014/6500d079fb9747b39cdc7faf467a2c81.png
[6069fc3506ee4638a4ebdbb834ac9df6.png]: /images/20221014/b74f4c5db20d4e1d9b7668ca082817ee.png
[9d82830fc008e8c64c48f22737d8ac9b.png]: /images/20221014/45f4fa3f055e4f5b908b33fd327ff64a.png
[b823f7570a4cf7b11771ef26d9df1f5f.png]: /images/20221014/ccfa575d9b4e4dd2bafae0a120985143.png
[brave-example]: https://github.com/openzipkin/brave-example
[0ed4b21bb0c06ac2694c7923288103e2.png]: /images/20221014/e3063329f1f247598adc3c6e7fabaf3c.png
[a9f13a4acd00d7fe73aed69a291cd414.png]: /images/20221014/ad9d3592146d40d39b8746f6825ea0aa.png
[b6f2367d2b4975954dc49e12db8e076b.png]: /images/20221014/127b168bc83842c28b3cd65fcdbb4467.png
[9d0a520a69c5779a006cd169e95058f1.png]: /images/20221014/d5fb80a479a543c0bd2baddf99cfd94f.png
[039ee9fce7273123a5113b8c105df4c5.png]: /images/20221014/672720fe483d4d4e9ce2cc272031b427.png
[da3e1df1c6248a6d3bbee6f9205a8b56.png]: /images/20221014/93ff1b33430945e68fa040b1bd3298a9.png
[f52debcd1a823bc0e0531391b556ddf4.png]: /images/20221014/407a31b72c8343c6ac898a031e19ade2.png
[SpringCloud Sleuth]: https://www.cnblogs.com/dengpengbo/p/11109254.html
[Spring Cloud _ Sleuth]: https://www.cnblogs.com/mrhelloworld/p/sleuth1.html
[Link 2]: https://home.cnblogs.com/u/mrhelloworld/