SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)

古城微笑少年丶 2022-05-19 02:37 235阅读 0赞

这篇文章主要讲述服务追踪组件zipkin，Spring Cloud Sleuth集成了zipkin组件。

### 一、简介 ###

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

![Paste\_Image.png][Paste_Image.png]

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

![Paste\_Image.png][Paste_Image.png 1]

### 三、术语 ###

*  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注解的过程图形化：

![Paste\_Image.png][Paste_Image.png 2]

### 四、构建工程 ###

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

4.1 构建server-zipkin

在spring Cloud为F版本的时候，已经不需要自己构建Zipkin Server了，只需要下载jar即可，下载地址：

[https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/][https_dl.bintray.com_openzipkin_maven_io_zipkin_java_zipkin-server]

也可以在这里下载：

链接: [https://pan.baidu.com/s/1w614Z8gJXHtqLUB6dKWOpQ][https_pan.baidu.com_s_1w614Z8gJXHtqLUB6dKWOpQ] 密码: 26pf

下载完成jar 包之后，需要运行jar，如下：

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

访问浏览器localhost:9494

4.2 创建service-hi

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

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.forezp</groupId>
        <artifactId>service-zipkin</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>service-hi</name>
        <description>Demo project for Spring Boot</description>
    
        <parent>
            <groupId>com.forezp</groupId>
            <artifactId>sc-f-chapter9</artifactId>
            <version>0.0.1-SNAPSHOT</version>
        </parent>
    
    
    
        <dependencies>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-zipkin</artifactId>
            </dependency>
    
    
    
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    </project>

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

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

对外暴露接口：

package com.forezp;
    
    import brave.sampler.Sampler;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    import java.util.logging.Level;
    import java.util.logging.Logger;
    
    @SpringBootApplication
    @RestController
    public class ServiceHiApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ServiceHiApplication.class, args);
        }
    
        private static final Logger LOG = Logger.getLogger(ServiceHiApplication.class.getName());
    
    
        @Autowired
        private RestTemplate restTemplate;
    
        @Bean
        public RestTemplate getRestTemplate(){
            return new RestTemplate();
        }
    
        @RequestMapping("/hi")
        public String callHome(){
            LOG.log(Level.INFO, "calling trace service-hi  ");
            return restTemplate.getForObject("http://localhost:8989/miya", String.class);
        }
        @RequestMapping("/info")
        public String info(){
            LOG.log(Level.INFO, "calling trace service-hi ");
    
            return "i'm service-hi";
    
        }
    
        @Bean
        public Sampler defaultSampler() {
            return Sampler.ALWAYS_SAMPLE;
        }
    
    
    }

4.3 创建service-miya

创建过程痛service-hi，引入相同的依赖，配置下spring.zipkin.base-url。

对外暴露接口：

package com.forezp;
    
    import brave.sampler.Sampler;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.context.annotation.Bean;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    import org.springframework.web.client.RestTemplate;
    
    import java.util.logging.Level;
    import java.util.logging.Logger;
    
    @SpringBootApplication
    @RestController
    public class ServiceMiyaApplication {
    
        public static void main(String[] args) {
            SpringApplication.run(ServiceMiyaApplication.class, args);
        }
    
        private static final Logger LOG = Logger.getLogger(ServiceMiyaApplication.class.getName());
    
    
        @RequestMapping("/hi")
        public String home(){
            LOG.log(Level.INFO, "hi is being called");
            return "hi i'm miya!";
        }
    
        @RequestMapping("/miya")
        public String info(){
            LOG.log(Level.INFO, "info is being called");
            return restTemplate.getForObject("http://localhost:8988/info",String.class);
        }
    
        @Autowired
        private RestTemplate restTemplate;
    
        @Bean
        public RestTemplate getRestTemplate(){
            return new RestTemplate();
        }
    
    
        @Bean
        public Sampler defaultSampler() {
            return Sampler.ALWAYS_SAMPLE;
        }
    }

4.4 启动工程，演示追踪

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

![Paste\_Image.png][Paste_Image.png 3]

访问：[http://localhost:8989/miya][http_localhost_8989_miya]，浏览器出现：

> i’m service-hi

再打开[http://localhost:9411/][http_localhost_9411]的界面，点击Dependencies,可以发现服务的依赖关系：

![Paste\_Image.png][Paste_Image.png 4]

点击find traces,可以看到具体服务相互调用的数据：

![Paste\_Image.png][Paste_Image.png 5]

> [http://blog.csdn.net/forezp/article/details/81041078][http_blog.csdn.net_forezp_article_details_81041078]  
> 本文出自[方志朋的博客][Link 2]

[Link 1]: https://github.com/spring-cloud/spring-cloud-sleuth
[Paste_Image.png]: /images/20220519/ef59639dc5934a32b72dc64768ac6948.png
[Paste_Image.png 1]: /images/20220519/987c6ec459d3452fad6ef9d0dbe074f6.png
[Paste_Image.png 2]: /images/20220519/0f778790905b4228acfbf4e9a5c14a9b.png
[https_dl.bintray.com_openzipkin_maven_io_zipkin_java_zipkin-server]: https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/
[https_pan.baidu.com_s_1w614Z8gJXHtqLUB6dKWOpQ]: https://pan.baidu.com/s/1w614Z8gJXHtqLUB6dKWOpQ
[http_localhost_9411]: http://localhost:9411/
[Paste_Image.png 3]: /images/20220519/54fe4f6f0ee44dd7aa1759f5ba658610.png
[http_localhost_8989_miya]: http://localhost:8989/miya
[Paste_Image.png 4]: /images/20220519/5edf5aa05b2440cda3c4ddd0f23c6d30.png
[Paste_Image.png 5]: /images/20220519/1e007a44e6c944759ae8e85d2f4aa0b3.png
[http_blog.csdn.net_forezp_article_details_81041078]: http://blog.csdn.net/forezp/article/details/81041078
[Link 2]: http://blog.csdn.net/forezp