【SpringCloud】Spring Cloud Sleuth + Zipkin 服務調用鏈路追蹤（二十五）

服務調用鏈路追蹤

　　微服務架構是一個分布式架構，它按業務划分服務單元，一個分布式系統往往有很多個服務單元。由於服務單元數量眾多，業務的復雜性，如果出現了錯誤和異常，很難去定位。主要體現在，一個請求可能需要調用很多個服務，而內部服務的調用復雜性，決定了問題難以定位。所以微服務架構中，必須實現分布式鏈路追蹤，去跟進一個請求到底有哪些服務參與，參與的順序又是怎樣的，從而達到每個請求的步驟清晰可見，出了問題，很快定位。

　　舉個例子，在微服務系統中，一個來自用戶的請求，請求先達到前端A（如前端界面），然后通過遠程調用，達到系統的中間件B、C（如負載均衡、網關等），最后達到后端服務D、E，后端經過一系列的業務邏輯計算最后將數據返回給用戶。對於這樣一個請求，經歷了這么多個服務，怎么樣將它的請求過程的數據記錄下來呢？這就需要用到服務鏈路追蹤。

　　Google開源的 Dapper鏈路追蹤組件，並在2010年發表了論文《Dapper, a Large-Scale Distributed Systems Tracing Infrastructure》，這篇文章是業內實現鏈路追蹤的標桿和理論基礎，具有非常大的參考價值。　　

　　常見的業界開源解決方案

　　1、Dapper（谷歌）

　　2、Zikpin，與Spring Cloud Sleuth結合的比較好

　　3、Eagleeye（阿里）

　　4、pinpoint

　　5、skywalking

　　本文主要講述如何在Spring Cloud Sleuth中集成Zipkin。在Spring Cloud Sleuth中集成Zipkin非常的簡單，只需要引入相應的依賴和做相關的配置即可。

Spring Cloud Sleuth簡介

　　Spring Cloud Sleuth為Spring Cloud實現了分布式跟蹤解決方案。

　　官網：https://cloud.spring.io/spring-cloud-static/spring-cloud-sleuth/2.2.2.RELEASE/reference/html/#introduction

　　術語

　　Span：基本工作單元。例如，發送RPC是一個新的跨度，就像發送響應到RPC一樣。跨度由跨度的唯一64位ID和跨度所屬的跟蹤的另一個64位ID標識。跨區還具有其他數據，例如描述，帶有時間戳的事件，鍵值注釋（標簽），引起跨度的跨區ID和進程ID（通常為IP地址）。

　　跨度可以啟動和停止，並且可以跟蹤其時序信息。創建跨度后，您必須在將來的某個時間點將其停止。

　　Trace：一組spans，形成樹狀結構。例如，如果您運行分布式大數據存儲，則跟蹤可能由PUT請求形成。

　　Annotation：用來及時記錄一個事件的，一些核心注解用來定義一個請求的開始和結束 。這些注解包括以下：

• • cs：客戶端已發送。客戶提出了要求。此注釋指示跨度的開始。
  • sr：接收到服務器：服務器端收到了請求並開始處理它。從此時間戳中減去cs時間戳可顯示網絡延遲。
  • ss：服務器已發送。在請求處理完成時進行注釋（當響應被發送回客戶端時）。從此時間戳中減去sr時間戳將顯示服務器端處理請求所需的時間。
  • cr：收到客戶。表示跨度結束。客戶端已成功收到服務器端的響應。從此時間戳中減去cs時間戳將顯示客戶端從服務器接收響應所需的整個時間。

　　圖顯示了Span和Trace在系統中的外觀以及Zipkin批注：

 　　

　　　　音符的每種顏色都表示一個跨度（從A到G共有七個spans- ）。請考慮以下注意事項：

　　　　Trace Id = X
　　　　Span Id = D
　　　　Client Sent

　　　　該說明指出，當前跨距跟蹤編號設定為X和Span標識設置為d。同樣，發生了Client Sent事件。

　　　　下圖顯示了spans的父子關系：

　　　　

Zipkin簡介

　　Zipkin是一個分布式跟蹤系統。它有助於收集解決服務體系結構中的延遲問題所需的時序數據。功能包括該數據的收集和查找。

　　官網：https://zipkin.io/

鏈路追蹤案例

　　架構圖

　　

　　Zipkin服務端搭建

　　　　1、下載Zipkin服務端jar包，可以去網關下載，也可以去地址：https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/

　　　　2、使用命令啟動Zipkin服務端，命令：java -jar zipkin-server-2.12.9-exec.jar

　　　　　　

　　　　3、使用瀏覽器訪問地址：http://127.0.0.1:9411，9411是Zipkin的默認端口

　　　　　　

　　Sleuth服務提供者項目搭建

　　　　Eureka注冊中心搭建參考：【SpringCloud】快速入門（一）

　　　　1、新建一個模塊（springcloud-provider-sleuth-payment8010）作為Sleuth服務提供者

　　　　2、修改pom文件，引入依賴zipkin + sleuth，以及eureka

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

<!-- eureka client -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

　　　　查看spring-cloud-starter-zipkin依賴，可以看到它包含了spring-cloud-starter-sleuth以及spring-cloud-starter-sleuth-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">
    <parent>
        <artifactId>test-springcloud</artifactId>
        <groupId>com.test</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springcloud-provider-sleuth-payment8010</artifactId>

    <dependencies>

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

        <!-- eureka client -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>

        <!-- spring boot -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

</project>

　　　　3、編輯application.yml配置文件

# 端口
server:
  port: 8010

spring:
  application:
    name: cloud-sleuth-provider
  zipkin:
    # zipkin url地址
    base-url: http://localhost:9411
  sleuth:
    sampler:
      # 采樣率值介於 0 到 1 之間， 1 則表示全部采集
      # 默認值：0.1，即10％
      probability: 1

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka

　　　　4、編寫啟動類

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

　　　　5、編寫Controller

@RestController
public class PaymentController {

    @GetMapping("/payment/zipkin")
    public String paymentZipkin(){
        return "Hi, this is payment zipkin server";
    }
}

　　　　6、測試

　　　　　　1）啟動Eureka注冊中心，啟動Sleuth服務提供者

　　　　　　2）訪問地址：http://127.0.0.1:8010/payment/zipkin，正常獲取內容

　　　　　　

　　Sleuth服務消費者項目搭建

　　　　1、新建一個模塊（springcloud-consumer-sleuth-order7995）作為Sleuth服務消費者

　　　　2、修改pom文件，引入依賴zipkin + sleuth，以及eureka，內容同上

　　　　3、編輯application.yml配置文件

# 端口
server:
  port: 7995

spring:
  application:
    name: cloud-order
  zipkin:
    base-url: http://localhost:9411
  sleuth:
    sampler:
      # 采樣率值介於 0 到 1 之間， 1 則表示全部采集
      probability: 1
  
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka

　　　　4、編寫啟動類

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

　　　　5、編寫配置類

@Configuration
public class AppConfig {

    /**
     * 注入restTemplate，請用請求rest接口
     * @return
     */
    @Bean
    // 標注此注解后，RestTemplate就具有了客戶端負載均衡能力
    // 負載均衡技術依賴於的是Ribbon組件~
    // RestTemplate都塞入一個loadBalancerInterceptor 讓其具備有負載均衡的能力
    @LoadBalanced
    public RestTemplate restTemplate(){
        return new RestTemplate();
    }
}

　　　　6、編寫controller，調用服務

@RestController
public class OrderController {

    @Autowired
    private RestTemplate restTemplate;

    @GetMapping("/consumer/payment/zipkin")
    public String paymentZipkin(){
        String result = restTemplate.getForObject("http://CLOUD-SLEUTH-PROVIDER" + "/payment/zipkin", String.class);
        return result;
    }

}

　　　　7、測試

　　　　　　1）啟動Eureka注冊中心，啟動Sleuth服務提供者、消費者，Zipkin服務端

　　　　　　2）訪問地址：http://127.0.0.1:7995/consumer/payment/zipkin，正常獲取內容

　　　　　　　　

　　　　　　3）查看Zipkin的Web界面，地址：http://127.0.0.1:9411/zipkin，點擊查詢按鈕

　　　　　　　　顯示如下，可以看到里面的請求記錄，包括：ROOT（微服務名，請求方式，請求路徑）、TRACE ID、開始時間、持續時間

　　　　　　　　

　　　　　　4）查看最近一次請求CLOUD-ORDER的詳情數據

　　　　　　　　

　　　　　　5）打開依賴頁面，進行搜索，可以看打時間段內，服務之間的依賴關系