【SpringCloud】第九篇: 服务链路追踪(Spring Cloud Sleuth)

青旅半醒 2021-11-23 08:32 365阅读 0赞

### 前言: ###

> 必需学会SpringBoot基础知识

### 简介: ###

> spring cloud 为开发人员提供了快速构建分布式系统的一些工具，包括配置管理、服务发现、断路器、路由、微代理、事件总线、全局锁、决策竞选、分布式会话等等。它运行环境简单，可以在开发人员的电脑上跑。

### 工具: ###

> JDK8

> apache-maven-3.5.2

> IntelliJ IDEA 2018.1 x64

一、简介

> Add sleuth to the classpath of a Spring Boot application (see below for Maven and Gradle examples), and you will see the correlation data being collected in logs, as long as you are logging requests.
> 
> —— [摘自官网][Link 1]

Spring Cloud Sleuth 主要功能就是在分布式系统中提供追踪解决方案，并且兼容支持了 zipkin，你只需要在pom文件中引入相应的依赖即可。

二、服务追踪分析

微服务架构上通过业务来划分服务的，通过REST调用，对外暴露的一个接口，可能需要很多个服务协同才能完成这个接口功能，如果链路上任何一个服务出现问题或者网络超时，都会形成导致接口调用失败。随着业务的不断扩张，服务之间互相调用会越来越复杂。

[![SpringCloud\_配置中心9-1][SpringCloud_9-1]][SpringCloud_9-1_SpringCloud_9-1]

随着服务的越来越多，对调用链的分析会越来越复杂。它们之间的调用关系也许如下：

[![SpringCloud\_配置中心9-2][SpringCloud_9-2]][SpringCloud_9-2_SpringCloud_9-2]

三、术语

*  Span：基本工作单元，例如，在一个新建的span中发送一个RPC等同于发送一个回应请求给RPC，span通过一个64位ID唯一标识，trace以另一个64位ID表示，span还有其他数据信息，比如摘要、时间戳事件、关键值注释(tags)、span的ID、以及进度ID(通常是IP地址)  
    span在不断的启动和停止，同时记录了时间信息，当你创建了一个span，你必须在未来的某个时刻停止它。
 *  Trace：一系列spans组成的一个树状结构，例如，如果你正在跑一个分布式大数据工程，你可能需要创建一个trace。
 *  Annotation：用来及时记录一个事件的存在，一些核心annotations用来定义一个请求的开始和结束
    
     *  cs - Client Sent -客户端发起一个请求，这个annotion描述了这个span的开始
     *  sr - Server Received -服务端获得请求并准备开始处理它，如果将其sr减去cs时间戳便可得到网络延迟
     *  ss - Server Sent -注解表明请求处理的完成(当请求返回客户端)，如果ss减去sr时间戳便可得到服务端需要的处理请求时间
     *  cr - Client Received -表明span的结束，客户端成功接收到服务端的回复，如果cr减去cs时间戳便可得到客户端从服务端获取回复的所有所需时间  
        将Span和Trace在一个系统中使用Zipkin注解的过程图形化：

将Span和Trace在一个系统中使用Zipkin注解的过程图形化：

[![SpringCloud\_配置中心9-3][SpringCloud_9-3]][SpringCloud_9-3_SpringCloud_9-3]

四、构建工程

基本知识讲解完毕，下面我们来实战，本文的案例主要有三个工程组成:一个eureka-server-zipkin,它的主要作用使用ZipkinServer 的功能，收集调用数据，并展示；一个eureka-server-zipkin-client,对外暴露hi接口；一个eureka-server-zipkin-eddie,对外暴露eddie接口；这两个service可以相互调用；并且只有调用了，eureka-server-zipkin才会收集数据的，这就是为什么叫服务追踪了。

理论差不多, 就不继续探讨, 都是那句老话: 师傅带入门, 本领看自己

4.1 创建 eureka-server-zipkin

pom引入依赖：

[\+  ][ ]

在其程序入口类, 加上注解@EnableZipkinServer，开启ZipkinServer的功能：

<table> 
 <tbody> 
 <tr> 
 <td> 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 </td> 
 <td> <code>package</code>&nbsp;<code>com.lwc;</code> &nbsp; <code>import</code>&nbsp;<code>org.springframework.boot.SpringApplication;</code> <code>import</code>&nbsp;<code>org.springframework.boot.autoconfigure.SpringBootApplication;</code> <code>import</code>&nbsp;<code>zipkin.server.EnableZipkinServer;</code> &nbsp; &nbsp; <code>/**</code> <code>&nbsp;</code><code>* @author Eddie</code> <code>&nbsp;</code><code>*/</code> <code>@EnableZipkinServer</code> <code>@SpringBootApplication</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>EurekaServerZipkinApplication { </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>static</code>&nbsp;<code>void</code>&nbsp;<code>main(String[] args) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>SpringApplication.run(EurekaServerZipkinApplication.</code><code>class</code><code>, args);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

在配置文件application.yml指定服务端口为：

>     server:
>       port: 9411

4.2 创建 eureka-server-zipkin-client

在其pom引入起步依赖spring-cloud-starter-zipkin，代码如下：

[\+  ][ ]

在其配置文件application.yml指定zipkin server的地址，头通过配置“spring.zipkin.base-url”指定：

<table> 
 <tbody> 
 <tr> 
 <td> 01 02 03 04 05 06 07 </td> 
 <td> <code>server:</code> <code>&nbsp;&nbsp;</code><code>port: </code><code>8988</code> <code>spring:</code> <code>&nbsp;&nbsp;</code><code>zipkin:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>base-url: http:</code><code>//localhost:9411</code> <code>&nbsp;&nbsp;</code><code>application:</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>name: eureka-server-zipkin-client</code> </td> 
 </tr> 
 </tbody> 
</table>

通过引入spring-cloud-starter-zipkin依赖和设置spring.zipkin.base-url就可以了。

对外暴露接口：

<table> 
 <tbody> 
 <tr> 
 <td> 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 </td> 
 <td> <code>package</code>&nbsp;<code>com.lwc.controller;</code> &nbsp; <code>import</code>&nbsp;<code>lombok.extern.slf4j.Slf4j;</code> <code>import</code>&nbsp;<code>org.springframework.beans.factory.annotation.Autowired;</code> <code>import</code>&nbsp;<code>org.springframework.web.bind.annotation.GetMapping;</code> <code>import</code>&nbsp;<code>org.springframework.web.bind.annotation.RestController;</code> <code>import</code>&nbsp;<code>org.springframework.web.client.RestTemplate;</code> &nbsp; <code>/**</code> <code>&nbsp;</code><code>* @author eddie.lee</code> <code>&nbsp;</code><code>* @Package com.lwc.controller</code> <code>&nbsp;</code><code>* @ClassName ZipkinController</code> <code>&nbsp;</code><code>* @description</code> <code>&nbsp;</code><code>* @date created in 2018-04-09 13:55</code> <code>&nbsp;</code><code>* @modified by</code> <code>&nbsp;</code><code>*/</code> <code>@Slf4j</code> <code>@RestController</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>ZipkinController { </code> &nbsp; &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Autowired</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>RestTemplate restTemplate;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@GetMapping</code><code>(</code><code>"/hi"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String callHome() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>" callHome() ==&gt; calling trace eureka-server-zipkin-client"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>restTemplate.getForObject(</code><code>"http://localhost:8989/eddie"</code><code>, String.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@GetMapping</code><code>(</code><code>"/info2"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String info2() { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>" info2() ==&gt; calling trace eureka-server-zipkin-client"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>"this is eureka-server-zipkin-client"</code><code>;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

4.3 创建 eureka-server-zipkin-eddie

创建过程 eureka-server-zipkin-client，引入相同的依赖，配置下spring.zipkin.base-url。

对外暴露接口：

<table> 
 <tbody> 
 <tr> 
 <td> 01 02 03 04 05 06 07 08 09 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 </td> 
 <td> <code>package</code>&nbsp;<code>com.lwc.controller;</code> &nbsp; <code>import</code>&nbsp;<code>lombok.extern.slf4j.Slf4j;</code> <code>import</code>&nbsp;<code>org.springframework.beans.factory.annotation.Autowired;</code> <code>import</code>&nbsp;<code>org.springframework.web.bind.annotation.GetMapping;</code> <code>import</code>&nbsp;<code>org.springframework.web.bind.annotation.RestController;</code> <code>import</code>&nbsp;<code>org.springframework.web.client.RestTemplate;</code> &nbsp; <code>/**</code> <code>&nbsp;</code><code>* @author eddie.lee</code> <code>&nbsp;</code><code>* @Package com.lwc.controller</code> <code>&nbsp;</code><code>* @ClassName EddieController</code> <code>&nbsp;</code><code>* @description</code> <code>&nbsp;</code><code>* @date created in 2018-04-09 15:56</code> <code>&nbsp;</code><code>* @modified by</code> <code>&nbsp;</code><code>*/</code> <code>@Slf4j</code> <code>@RestController</code> <code>public</code>&nbsp;<code>class</code>&nbsp;<code>EddieController { </code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Autowired</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>private</code>&nbsp;<code>RestTemplate restTemplate;</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@GetMapping</code><code>(</code><code>"/hi"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String home(){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"==&gt; hi is being called"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>"hi i'm eddie.lee!"</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@GetMapping</code><code>(</code><code>"/eddie"</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>public</code>&nbsp;<code>String info(){ </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>log.info(</code><code>"==&gt; info is being called"</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code>&nbsp;<code>restTemplate.getForObject(</code><code>"http://localhost:8988/info2"</code><code>,String.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

4.4 启动工程，演示追踪

依次启动上面的三个工程，打开浏览器访问：http://localhost:9411/，会出现以下界面：

[![image][]][image 1]

访问：http://localhost:8989/eddie，浏览器出现：

> this is eureka-server-zipkin-client

再打开http://localhost:9411/的界面，点击 *依赖分析* ,可以发现服务的依赖关系：

[![image][image 2]][image_image 2]

点击 *查找*  可以看到具体服务相互调用的数据：

[![image][image 3]][image_image 3]

PS: 在网上很多出现依赖找不到, 或者是WEB UI查看不到依赖分析等情况, 请按本文章对应代码参考, 欢迎评论;

[Link 1]: https://github.com/spring-cloud/spring-cloud-sleuth
[SpringCloud_9-1]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTEyODYwNC8yMDE4MDQvMTEyODYwNC0yMDE4MDQxMDA5NDIyNDk4OS02NDM3NDY4NDAucG5n
[SpringCloud_9-1_SpringCloud_9-1]: /images/20211122/9a8577e0792845bf9dd267cdc8a14fff.png
[SpringCloud_9-2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTEyODYwNC8yMDE4MDQvMTEyODYwNC0yMDE4MDQxMDA5NDIzMjIwOC0xODI5NzY2ODkwLnBuZw
[SpringCloud_9-2_SpringCloud_9-2]: /images/20211122/ac5d87c0c188443d831ebe8cf54248da.png
[SpringCloud_9-3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTEyODYwNC8yMDE4MDQvMTEyODYwNC0yMDE4MDQxMDA5NDIzNzYyMS0xODcxODc2NDkyLnBuZw
[SpringCloud_9-3_SpringCloud_9-3]: /images/20211122/386aabb56b7a4f688fb230a0084ecefd.png
[ ]: https://www.cnblogs.com/EddieBlog/p/8776586.html?tdsourcetag=s_pcqq_aiomsg#
[image]: /images/20211122/a2d4b6acac134116816da029918c2561.png
[image 1]: https://images2018.cnblogs.com/blog/1128604/201804/1128604-20180410094238498-442081421.png
[image 2]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTEyODYwNC8yMDE4MDQvMTEyODYwNC0yMDE4MDQxMDEwMzMwNDUxOC0xNTMyMTM2MTc1LnBuZw
[image_image 2]: /images/20211122/20dbed1c0ee346a6b8c7814d52beb54b.png
[image 3]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9pbWFnZXMyMDE4LmNuYmxvZ3MuY29tL2Jsb2cvMTEyODYwNC8yMDE4MDQvMTEyODYwNC0yMDE4MDQxMDEwMzMwNTg5MS04NTI4MTcwMjcucG5n
[image_image 3]: /images/20211122/a7df0202c5c04883ae6c8453d0e43f4d.png