SpringCloud（7）服務鏈路追蹤Sleuth

阿新 • • 發佈：2019-01-14

1.簡介

Spring Cloud Sleuth 主要功能就是在分散式系統中提供追蹤解決方案，並且相容支援了 zipkin，你只需要在pom檔案中引入相應的依賴即可。本文主要講述服務追蹤元件zipkin，Spring Cloud Sleuth集成了zipkin元件。

2.術語

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時間戳便可得到整個請求所消耗的時間.

3.專案架構

本文案例主要由四個工程組成：

eureka-server：作為服務註冊中心。
zipkin-server：作為鏈路追蹤服務中心，負責儲存鏈路資料。
service-hi：對外暴露hi介面，同時作為產生鏈路資料，負責產生鏈路資料。
service-zuul：路由閘道器，負責請求轉發，同時作為鏈路追蹤客戶端，產生鏈路資料，並上傳至 zipkin-server 。

在8761埠開啟eureka-server註冊服務中心，參考前面的文章即可，這裡不再演示建立。

4.構建zipkin-server

新建一個spring-boot工程取名為 zipkin-server，其 pom.xml 完整依賴.

<?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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.example</groupId>
    <artifactId>zipkin-server</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <name>zipkin-server</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Dalston.RELEASE</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</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>

        <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>${spring-cloud.version}</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的功能.

@EnableZipkinServer
@EnableEurekaClient
@SpringBootApplication
public class ZipkinServerApplication {

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

}

在配置檔案application.yml指定服務埠為9411，並向Eureka註冊中心註冊.

eureka:
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
server:
  port: 9411
spring:
  application:
    name: zipkin-server

5.構建service-hi

新建一個SpringBoot工程，取名 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>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.example</groupId>
    <artifactId>service-hi</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>eureka-client</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Dalston.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</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>

        <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>${spring-cloud.version}</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>

在其配置檔案application.yml通過配置“spring.zipkin.base-url”指定zipkin server的地址.

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/
server:
  port: 8763
spring:
  application:
    name: service-hi
  zipkin:
    base-url: http://localhost:9411
  sleuth:
    sampler:
      percentage: 1.0

到這裡已經整合ZipKin客戶端完畢，最後對外暴露一個API介面方便測試.

@SpringBootApplication
@EnableEurekaClient
@RestController
public class ServiceHiApplication {

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

    @Value("${server.port}")
    String port;
    @RequestMapping("/hi")
    public String home(@RequestParam String name) {
        return "hi "+name+",i am from port:" +port;
    }

}

6.構建service-zuul

新建一個Spring Boot工程，取名為 service-zuul，引入依賴 spring-cloud-starter-zipkin，完整 pom.xml 依賴如下.

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

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>1.5.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <groupId>com.example</groupId>
    <artifactId>service-zuul</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <name>service-zuul</name>
    <description>Demo project for Spring Boot</description>

    <properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Dalston.SR1</spring-cloud.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-eureka</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zuul</artifactId>
        </dependency>
        <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>${spring-cloud.version}</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>

配置工程 application.yml 檔案，主要配置ZipKin Server的地址.

server:
  port: 8769
spring:
  application:
    name: service-zuul
  client:
    service-url:
      defaultZone: http://localhost:8761/eureka/
  sleuth:
    sampler:
      percentage: 1.0
  zipkin:
    base-url: http://localhost:9411/
zuul:
  routes:
    api-hi:
      path: /api-hi/**
      serviceId: service-hi

到這裡，你也許已經發現，引入ZipKin服務只需要導包、配置兩步即可。

在工程的啟動類註解開啟Zuul.

@EnableZuulProxy //開啟路由閘道器
@EnableEurekaClient
@SpringBootApplication
public class ServiceZuulApplication {

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

7.啟動工程,演示追蹤

完整專案搭建完畢，總結一下，第一搭建 zipkin server 作為鏈路服務中心，第二步就是給各個工程引入 zipkin 依賴，配置zipkin server地址即可。

下面依次啟動 eureka-server、service-zipkin、service-hi 和 service-zuul。開啟瀏覽器，訪問 http://localhost:8769/api-hi/hi?name=mark，顯示

hi mark,i am from port:8763

然後訪問 http://localhost:9411，即訪問 ZipKin 的展示介面.

這個介面用於展示 ZipKin Server收集的鏈路資料，可以根據服務名、開始時間、結束時間、請求消耗的時間等條件來查詢。單擊“Find Tracks”按鈕，可以檢視請求的呼叫時間、消耗時間，以及請求的鏈路情況。

單擊頂部的“Dependencies”按鈕，可以檢視服務的依賴關係。

參考方誌朋《深入理解Spring Cloud與微服務構建》

SpringCloud（7）服務鏈路追蹤Sleuth

1.簡介

2.術語

3.專案架構

4.構建zipkin-server

5.構建service-hi

6.構建service-zuul

7.啟動工程,演示追蹤

SpringCloud（7）服務鏈路追蹤Sleuth

SpringCloud微服務雲架構構建B2B2C電子商務平臺之-（九）服務鏈路追蹤(Spring Cloud Sleuth)

Spring Cloud微服務架構（十三）服務鏈路追蹤(Spring Cloud Sleuth)

spring cloud 2.0 入門系列一（10）分散式鏈路追蹤-Zipkin

《springcloud — Finchley.RELEASE版》第八篇服務鏈路追蹤Sleuth

springCloud（F版）（5）——Sleuth服務鏈路追蹤zipkin元件

SpringCloud學習記錄——Sleuth服務鏈路追蹤（Zipkin實現）

Spring Cloud Sleuth服務鏈路追蹤（mysql儲存鏈路資料）（Finchley版本）

spring cloud微服務快速教程之（十一） Sleuth(zipkin) 服務鏈路追蹤

業余草 SpringCloud教程 | 第九篇: 服務鏈路追蹤(Spring Cloud Sleuth)(Finchley版本)

Spring Boot + Spring Cloud 實現許可權管理系統後端篇（二十二）：鏈路追蹤（Sleuth、Zipkin）

史上最簡單的SpringCloud教程 | 第九篇: 服務鏈路追蹤(Spring Cloud Sleuth)(Finchley版本)

微服務架構--SpringCloud（7）

SpringCloud 學習筆記------服務鏈路追蹤(Spring Cloud Sleuth)

SpringCloud教程十一：Sleuth+Mysql服務鏈路追蹤

史上最簡單的SpringCloud教程 | 第九篇: 服務鏈路追蹤(Spring Cloud Sleuth)

springCloud（7）：Ribbon實現客戶端側負載均衡-消費者整合Ribbon

spring cloud 服務鏈路追蹤

SpringCloud2.0版本入門 | 服務鏈路追蹤(Spring Cloud Sleuth)簡單入門

企業級 SpringCloud（二）服務消費者（rest+ribbon）

SpringCloud（7）服務鏈路追蹤Sleuth

1.簡介

2.術語

3.專案架構

4.構建zipkin-server

5.構建service-hi

6.構建service-zuul

7.啟動工程,演示追蹤

相關推薦