概述

这篇文章主要讲解服务追踪组件 ZipKin

Spring Cloud Sleuth

sleuth:英 [slu:θ] 美 [sluθ] n.足迹，警犬，侦探vi.做侦探

ZipKin 简介

ZipKin 是一个开放源代码的分布式跟踪系统，由 Twitter 公司开源，它致力于收集服务的定时数据，以解决微服务架构中的延迟问题，包括数据的收集、存储、查找和展现。它的理论模型来自于 Google Dapper 论文。
每个服务向 ZipKin 报告计时数据，ZipKin 会根据调用关系通过 ZipKin UI 生成依赖关系图，显示了多少跟踪请求通过每个服务，该系统让开发者可通过一个 Web 前端轻松的收集和分析数据，例如用户每次请求服务的处理时间等，可方便的监测系统中存在的瓶颈。

服务追踪说明

Spring Cloud Sleuth 是 Spring Cloud 的一个组件，它的主要功能是在分布式系统中提供服务链路追踪的解决方案。 常见的链路追踪组件有 Google 的 Dapper、 Twitter 的 Zipkin ， 以及阿里的 Eagleeye（鹰眼）等，它们都是非常优秀的链路追踪开源组件。这里主要讲述如何在 Spring Cloud Sleuth 中集成 Zipkin。

微服务架构是一个分布式架构，它按业务划分服务单元，一个分布式系统往往有很多个服务单元。由于服务单元数量众多，业务的复杂性，如果出现了错误和异常，很难去定位。主要体现在，一个请求可能需要调用很多个服务，而内部服务的调用复杂性，决定了问题难以定位。所以微服务架构中，必须实现分布式链路追踪，去跟进一个请求到底有哪些服务参与，参与的顺序又是怎样的，从而达到每个请求的步骤清晰可见，出了问题，很快定位。

10. SpringCloud 链路追踪 - 图1

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

10. SpringCloud 链路追踪 - 图2

术语解释

  • Span：基本工作单元，例如，在一个新建的 Span 中发送一个 RPC 等同于发送一个回应请求给 RPC，Span 通过一个 64 位 ID 唯一标识，Trace 以另一个 64 位 ID 表示。
  • Trace：一系列 Spans 组成的一个树状结构，例如，如果你正在运行一个分布式大数据工程，你可能需要创建一个 Trace。
  • Annotation：用来即使记录一个事件的存在，一些核心 Annotations 用来定义一个请求的开始和结束
    • cs：Client Sent，客户端发起一个请求，这个 Annotation 描述了这个 Span 的开始
    • sr：Server Received，服务端获得请求并准备开始处理它，如果将其 sr 减去 cs 时间戳便可得到网络延迟
    • ss：Server Sent 表明请求处理的完成(当请求返回客户端)，如果 ss 减去 sr 时间戳便可得到服务端需要的处理请求时间
    • cr：Client Received 表明 Span 的结束，客户端成功接收到服务端的回复，如果 cr 减去 cs 时间戳便可得到客户端从服务端获取回复的所有所需时间

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

白话解释

traceId：标记一次请求的跟踪，相关的Spans都有相同的traceId；
id：span id；
name：span的名称，一般是接口方法的名称；
parentId：可选的id，当前Span的父Span id，通过parentId来保证Span之间的依赖关系，如果没有parentId，表示当前Span为根Span；
timestamp：Span创建时的时间戳，使用的单位是微秒（而不是毫秒），所有时间戳都有错误，包括主机之间的时钟偏差以及时间服务重新设置时钟的可能性，出于这个原因，Span应尽可能记录其duration；
duration：持续时间使用的单位是微秒（而不是毫秒）；
annotations：注释用于及时记录事件；有一组核心注释用于定义RPC请求的开始和结束；

手动创建 ZipKin 服务端

创建一个工程名为 cloud-zipkin 的项目，pom.xml 文件如下：

  2.     <dependencies>
  3.         <!-- Spring Boot Begin -->
  4.         <dependency>
  5.             <groupId>org.springframework.boot</groupId>
  6.             <artifactId>spring-boot-starter-web</artifactId>
  7.         </dependency>
  8.         <dependency>
  9.             <groupId>org.springframework.boot</groupId>
  10.             <artifactId>spring-boot-starter-tomcat</artifactId>
  11.         </dependency>
  12.         <dependency>
  13.             <groupId>org.springframework.boot</groupId>
  14.             <artifactId>spring-boot-starter-actuator</artifactId>
  15.         </dependency>
  16.         <dependency>
  17.             <groupId>org.springframework.boot</groupId>
  18.             <artifactId>spring-boot-starter-test</artifactId>
  19.             <scope>test</scope>
  20.         </dependency>
  21.         <!-- Spring Boot End -->
  23.         <!-- Spring Cloud Begin -->
  24.         <dependency>
  25.             <groupId>io.zipkin.java</groupId>
  26.             <artifactId>zipkin</artifactId>
  27.         </dependency>
  28.         <dependency>
  29.             <groupId>io.zipkin.java</groupId>
  30.             <artifactId>zipkin-server</artifactId>
  31.         </dependency>
  32.         <dependency>
  33.             <groupId>io.zipkin.java</groupId>
  34.             <artifactId>zipkin-autoconfigure-ui</artifactId>
  35.         </dependency>
  36.         <dependency>
  37.             <groupId>org.springframework.cloud</groupId>
  38.             <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
  39.         </dependency>
  40.         <!-- Spring Cloud End -->
  41.     </dependencies>

主要增加了 3 个依赖，io.zipkin.java:zipkin、io.zipkin.java:zipkin-server、io.zipkin.java:zipkin-autoconfigure-ui

<dependency>
    <groupId>io.zipkin.java</groupId>
    <artifactId>zipkin</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>

注意版本号为：2.10.1，这里没写版本号是因为我已将版本号托管到 dependencies 项目中

Application

通过 @EnableZipkinServer 注解开启 Zipkin Server 功能


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import zipkin.server.internal.EnableZipkinServer;

@SpringBootApplication
@EnableEurekaClient
@EnableZipkinServer
public class ZipKinApplication {
    public static void main(String[] args) {
        SpringApplication.run(ZipKinApplication.class, args);
    }
}

application.yml

设置端口号为：9411，该端口号为 Zipkin Server 的默认端口号

spring:
  application:
    name: hello-spring-cloud-zipkin

server:
  port: 9411

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

management:
  metrics:
    web:
      server:
        auto-time-requests: false

追踪服务

在 所有需要被追踪的项目（就当前教程而言，除了 dependencies 项目外都需要被追踪，包括 Eureka Server） 中增加 spring-cloud-starter-zipkin 依赖

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

在这些项目的 application.yml 配置文件中增加 Zipkin Server 的地址即可

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

测试追踪

启动全部项目，打开浏览器访问：http://localhost:9411/ 会出现以下界面：

刷新之前项目中的全部测试接口（刷多几次）
点击 Find a trace，可以看到具体服务相互调用的数据
10. SpringCloud 链路追踪 - 图3
点击 Dependencies，可以发现服务的依赖关系
10. SpringCloud 链路追踪 - 图4
至此就代表 ZipKin 配置成功

使用现成ZipKin

在spring Cloud为F版本的时候，已经不需要自己构建Zipkin Server了，只需要下载jar即可，下载地址：
　　Zipkin: 　https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/

　下载完成jar 包之后，可以将jar放入工程中，然后右键运行，也可以到jar包目录下，运行如下命令：
　　　　java -jar jar包名称

 java -jar zipkin-server-*.*.*-exec.jar

　
图片.png
运行成功之后，访问 http://localhost:9411，出现如下页面表示启动成功
图片.png
在所有的模块中加入 下面依赖 也就是需要跟踪的模块

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

在跟踪的模块中的 配置文件中加入如下配置：

#指定链路追踪的地址 
spring.zipkin.base-url=http://localhost:9411 
#表示以 100% 的概率将链路的数据上传给 Zipkin Server ， 在默认情况下 ， 该值为0.1
spring.sleuth.sampler.probability=1.0