zipkin

zipkin

关注
发信
关注(28)粉丝(399)

史上最简单的SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)

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

注意情况：

该案例使用的spring-boot版本1.5.x，没使用2.0.x，

另外本文图3可知，sleuth的调用由service A-->B-->C-->D-->C-->B-->A,

是由service A开始，由service A结束。这样才能产生链路。

如本案例，service-hi的 '/hi' ，访问到 service-miya的'/miya'，再访问到service-hi的 '/hiEnd'

一、简介

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

二、服务追踪分析

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

图1：

史上最简单的SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)-LMLPHP

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

图2

史上最简单的SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)-LMLPHP

三、术语

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

图3

史上最简单的SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)-LMLPHP

四、构建工程

基本知识讲解完毕，下面我们来实战，本文的案例主要有三个工程组成:

一个server-zipkin,它的主要作用使用ZipkinServer 的功能，收集调用数据，并展示；

一个service-hi,对外暴露hi接口；

一个service-miya,对外暴露miya接口；

这两个service可以相互调用；并且只有调用了，server-zipkin才会收集数据的，这就是为什么叫服务追踪了。

4.1 构建server-zipkin

建一个spring-boot工程取名为server-zipkin，在其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">

    <modelVersion>4.0.0</modelVersion>

    <groupId>com.forezp</groupId>

    <artifactId>server-zipkin</artifactId>

    <version>0.0.1-SNAPSHOT</version>

    <packaging>jar</packaging>

    <name>server-zipkin</name>

    <description>Demo project for Spring Boot</description>

    <parent>

        <groupId>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-parent</artifactId>

        <version>1.5.2.RELEASE</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <properties>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

        <java.version>1.8</java.version>

    </properties>

    <dependencies>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter</artifactId>

        </dependency>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-web</artifactId>

        </dependency>

        <dependency>

            <groupId>io.zipkin.java</groupId>

            <artifactId>zipkin-server</artifactId>

        </dependency>

        <dependency>

            <groupId>io.zipkin.java</groupId>

            <artifactId>zipkin-autoconfigure-ui</artifactId>

        </dependency>

    </dependencies>

    <dependencyManagement>

        <dependencies>

            <dependency>

                <groupId>org.springframework.cloud</groupId>

                <artifactId>spring-cloud-dependencies</artifactId>

                <version>Camden.SR6</version>

                <type>pom</type>

                <scope>import</scope>

            </dependency>

        </dependencies>

    </dependencyManagement>

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

</project>

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

@SpringBootApplication

@EnableZipkinServer

public class ServerZipkinApplication {

    public static void main(String[] args) {

        SpringApplication.run(ServerZipkinApplication.class, args);

    }

}

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

server.port=9411

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>org.springframework.boot</groupId>

        <artifactId>spring-boot-starter-parent</artifactId>

        <version>1.5.2.RELEASE</version>

        <relativePath/> <!-- lookup parent from repository -->

    </parent>

    <properties>

        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>

        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>

        <java.version>1.8</java.version>

    </properties>

    <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>

        <dependency>

            <groupId>org.springframework.boot</groupId>

            <artifactId>spring-boot-starter-test</artifactId>

            <scope>test</scope>

        </dependency>

    </dependencies>

    <dependencyManagement>

        <dependencies>

            <dependency>

                <groupId>org.springframework.cloud</groupId>

                <artifactId>spring-cloud-dependencies</artifactId>

                <version>Dalston.RC1</version>

                <type>pom</type>

                <scope>import</scope>

            </dependency>

        </dependencies>

    </dependencyManagement>

    <build>

        <plugins>

            <plugin>

                <groupId>org.springframework.boot</groupId>

                <artifactId>spring-boot-maven-plugin</artifactId>

            </plugin>

        </plugins>

    </build>

    <repositories>

        <repository>

            <id>spring-milestones</id>

            <name>Spring Milestones</name>

            <url>https://repo.spring.io/milestone</url>

            <snapshots>

                <enabled>false</enabled>

            </snapshots>

        </repository>

    </repositories>

</project>

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

server.port=9000

spring.zipkin.base-url=http://localhost:9411

spring.application.name=service-hi

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

对外暴露接口：

@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(){return restTemplate.getForObject("http://localhost:9001/miya", String.class);

    }

    @RequestMapping("/hiEnd")

    public String info(){return "i'm service-hi hiEnd()";

    }

    @Bean

    public AlwaysSampler defaultSampler(){

        return new AlwaysSampler();

    }

}

4.3 创建service-miya

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

对外暴露接口：

@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("/miya")

    public String info(){

        return restTemplate.getForObject("http://localhost:9000/hiEnd",String.class);

    }

    @Autowired

    private RestTemplate restTemplate;

    @Bean

    public RestTemplate getRestTemplate(){

        return new RestTemplate();

    }

}

application.properties文件如下

server.port=9001

spring.zipkin.base-url=http://localhost:9411

spring.application.name=service-miya

而其pom文件内容，和service-hi的pom文件相同。

4.4 启动工程，演示追踪

依次启动上面的三个工程，打开浏览器

访问：http://localhost:9411/，会出现界面。

访问：http://localhost:9000/hi，界面出现数据。

史上最简单的SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)-LMLPHP

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

史上最简单的SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)-LMLPHP

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

点击一个trace查看详情，可看到调用的耗时情况

史上最简单的SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)-LMLPHP

本文源码下载： 
https://github.com/forezp/SpringCloudLearning/tree/master/chapter9

04-14 12:19
Powered by LMLPHP ©2024 zipkin 0.074928