Spring Cloud Hoxton.SR4 Spring Boot 2.3.0.RELEASE
GitHub:shpunishment/spring-cloud-learning/spring-cloud-sleuth-test
1. 简介
Spring Cloud Sleuth 是分布式跟踪解决方案,是在分布式系统中跟踪服务间调用的工具,它可以直观地展示出一次请求的调用过程。
随着我们的系统越来越庞大,各个服务间的调用关系也变得越来越复杂。当客户端发起一个请求时,这个请求经过多个服务后,最终返回了结果,经过的每一个服务都有可能发生延迟或错误,从而导致请求失败。通过请求链路跟踪工具,可以帮助我们理清请求调用的服务链路,并解决问题。
2. 基本概念
Span
基本工作单元。比如,发送一次RPC请求就是一个新的Span。Span通过一个64位的ID标识,还包含描述、事件时间戳、标签、调用它的Span的ID、处理器ID(一般为IP地址)。
第一个Span是root span,它的ID值和trace的ID值一样。
Trace
一系列Span组成的树状结构,就是一个调用请求。
Annotation
标注,用来描述事件的实时状态。事件有如下状态:
- cs:Client Sent。客户端发起请求,表示一个Span的开始。
- sr:Server Received。服务房接收到请求并开始处理,它减去cs的时间就是网络延迟时间。
- ss:Server Sent。表示服务房请求处理完成,将响应数据返回给客户端。它减去sr的时间就是服务方处理时间。
- cr:Client Received。表示客户端收到服务方的返回值,是当前Span结束的信号。它减去cs的时间就是一次请求的完整处理时间。
3. 使用
先用IDEA创建一个Spring Boot的项目,可以随意引用一个Spring Cloud的组件,之后也会删掉。
创建完,删掉除了pom.xml以外的其他文件,再修改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 https://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>2.3.0.RELEASE</version>
</parent>
<groupId>com.shpun</groupId>
<artifactId>spring-cloud-sleuth-test</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>spring-cloud-sleuth-test</name>
<description>spring cloud sleuth test</description>
<!--修改打包方式为pom-->
<packaging>pom</packaging>
<properties>
<java.version>1.8</java.version>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<spring-cloud.version>Hoxton.SR4</spring-cloud.version>
</properties>
<modules>
<!--后续添加子模块用-->
</modules>
<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>
</project>
3.1 zipkin-server
在 Github zipkin-server 的 Quick-start 中下载最新版。
启动 zipkin-server,访问 http://localhost:9411/
java -jar zipkin-server-2.21.7-exec.jar
zipkin-server 不保存数据,可存储到Elasticsearch中。
java -jar zipkin-server-2.21.7-exec.jar --STORAGE_TYPE=elasticsearch --ES_HOSTS=http://192.168.110.40:9200
3.2 eureka-server,user-service,ribbon-service
这三个子模块和 Spring Cloud Netfix Ribbon (Hoxton版) 使用 一致,需要修改pom.xml中的parent。
修改user-service和ribbon-service的pom.xml,添加依赖
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-zipkin</artifactId>
</dependency>
修改user-service和ribbon-service的application.yml,添加sleuth的配置和zipkin地址。
spring:
sleuth:
sampler:
# 采样请求的概率
probability: 0.1
# 整合Zipkin
zipkin:
base-url: http://localhost:9411
4. 测试
多次通过ribbon-sevice调用user-service,等待片刻,访问zipkin,可查看到链路跟踪信息
链路跟踪信息详情
链路依赖
使用Elasticsearch存储链路数据
参考:
Spring Cloud Sleuth 官方文档
Spring Cloud入门-Sleuth服务链路跟踪(Hoxton版本)