SpringCloud教程- 服务链路追踪(Spring Cloud Sleuth)(SpringCloud版本Greenwich.SR4)

文章目录

一、Sleuth简介
二、为何使用Sleuth
三、构建工程

server-zipkin
zipkin-serivce-hi

zipkin-server-hello
四、启动工程演示

一、Sleuth简介

微服务跟踪(sleuth)其实是一个工具,它在整个分布式系统中能跟踪一个用户请求的过程(包括数据采集，数据传输，数据存储，数据分析，数据可视化)，捕获这些跟踪数据，就能构建微服务的整个调用链的视图，这是调试和监控微服务的关键工具。并且兼容支持了 zipkin，你只需要在pom文件中引入相应的依赖即可。

二、为何使用Sleuth

1、微服务的现状，随着业务的发展，单体架构变为微服务架构，并且系统规模也变得越来越大，各微服务间的调用关系也变得越来越复杂。
2、多服务协同工作，在微服务的应用中，一个由客户端发起的请求在后端系统中会经过多个不同的微服务调用来协同产生最后的请求结果。
3、复杂的调用链条容易出错，在复杂的微服务架构系统中，几乎每一个前端请求都会形成一个复杂的分布式服务调用链路，在每条链路中任何一个依赖服务出现延迟超时或者错误都有可能引起整个请求最后的失败

例如:
在微服务系统中，一个来自用户的请求，请求先达到前端A（如前端界面）然后通过远程调用，到达系统中间件B，C（负载均衡,网关等），最后达到后端服务D，E，后端经过一系列的业务逻辑计算最后将数据返回给用户，对于这样一个请求，经历了这么多个服务，怎么样将它的请求过程的数据记录下来呢？这就需要用到服务链路追踪
在这里插入图片描述
官网服务追踪图和基本术语

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

三、构建工程

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

server-zipkin

server-zipkin只需要下载jar就可以，下载地址为：https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/
下载完之后运行

java -jar zipkin-server-2.12.1-exec.jar

zipkin-serivce-hi

引入pom文件

<?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">
    <parent>
        <artifactId>spring-cloud-learn</artifactId>
        <groupId>com.sl.learn.cloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.sl.learn.cloud</groupId>
    <artifactId>zipkin-servce-hi</artifactId>
    <version>1.0-SNAPSHOT</version>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

    </dependencies>

</project>

配置文件application.properties
配置zipkin-server地址spring.zipkin.base-url=http://localhost:9411

server.port=8988
spring.zipkin.base-url=http://localhost:9411
spring.application.name=zipkin-service-hi
eureka.client.serviceUrl.defaultZone=http://localhost:8080/eureka/

启动类ZipkinServiceHiApplication

@SpringBootApplication
@EnableDiscoveryClient
public class ZipkinServiceHiApplication {

    public static void main(String[] args) {
        SpringApplication.run(ZipkinServiceHiApplication.class,args);
    }
}

调用另一个服务zipkin-server-hello的Controller

@RestController
public class ZipkinServiceController {

    private static final Logger logger = LoggerFactory.getLogger(ZipkinServiceController.class);

    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping("/hello")
    public String hello() {
        logger.info( "calling trace zipkin-service-hi  ");
        return restTemplate.getForObject("http://localhost:8980/hello", String.class);
    }

    @RequestMapping("/zipkinHi")
    public String hello1() {

        return "zipkin-hi";
    }
}

调用服务的config

@Configuration
public class RestTemplateConfig {

    @Bean
    public RestTemplate  getRestTemplate() {
         return new RestTemplate();
    }

    @Bean
    public Sampler defaultSampler() {
        return Sampler.ALWAYS_SAMPLE;
    }
}

zipkin-server-hello

zipkin-server-hello这个服务和上一个差不多只是把controller改下

@RestController
public class ZipkinServiceController {

    private static final Logger logger = LoggerFactory.getLogger(ZipkinServiceController.class);

    @Autowired
    private RestTemplate restTemplate;

    @RequestMapping("/hello")
    public String hello() {
        logger.info( "calling trace zipkin-service-hi  ");
        return restTemplate.getForObject("http://localhost:8980/zipkinHello", String.class);
    }

    @RequestMapping("/zipkinHello")
    public String hello1() {

        return "zipkin-hello";
    }
}

zipkin-server-hello工程结构
在这里插入图片描述