一、SpringCloud版本
本文介绍的Springboot版本为2.1.1.RELEASE,SpringCloud版本为Greenwich.RC1,JDK版本为1.8,集成环境为IntelliJ IDEA
二、Spring Cloud Sleuth介绍
Spring Cloud Sleuth为Spring Cloud实现分布式跟踪解决方案。
微服务架构上通过业务来划分服务的,通过REST调用,对外暴露的一个接口,可能需要很多个服务协同才能完成这个接口功能,如果链路上任何一个服务出现问题或者网络超时,都会形成导致接口调用失败。随着业务的不断扩张,服务之间互相调用会越来越复杂,在项目中引入sleuth可以方便程序进行调试。
sleuth中的一些术语
Spring Cloud Sleuth借用了Dapper的术语。
- Span:基本工作单元,例如,在一个新建的span中发送一个RPC等同于发送一个回应请求给RPC,span通过一个64位ID唯一标识,trace以另一个64位ID表示,span还有其他数据信息,比如摘要、时间戳事件、关键值注释(tags)、span的ID、以及进度ID(通常是IP地址)
span在不断的启动和停止,同时记录了时间信息,当你创建了一个span,你必须在未来的某个时刻停止它。
通俗点理解Span相当于各个子系统的服务,注册到Zipkin中,统一管理从而实现各服务之间的链路追踪。也可以理解跟服务注册中心Eureka类似
- 跟踪:一系列spans组成的一个树状结构,例如,如果你正在跑一个分布式大数据工程,你可能需要创建一个trace。
- 注释:用于及时记录事件的存在。用于定义请求的开始和停止的一些核心注释是:
- cs - Client Sent -客户端发起一个请求,这个annotion描述了这个span的开始
- sr - Server Received -服务端获得请求并准备开始处理它,如果将其sr减去cs时间戳便可得到网络延迟
- ss - Server Sent -注解表明请求处理的完成(当请求返回客户端),如果ss减去sr时间戳便可得到服务端需要的处理请求时间
- cr - Client Received-表明span的结束,客户端成功接收到服务端的回复,如果cr减去cs时间戳便可得到客户端从服务端获取回复的所有所需时间
注:本文分三部分搭建
第一步:搭建链路追踪服务端(Zipkin服务端)
第二部:子系统配置链路追踪
第三部:访问测试
三、创建Sleuth服务
- 3.1创建Zipkin服务端
创建一个module,取名问cloudzipkin,手动导入pom文件,这里没有引用父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>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.jthao</groupId>
<artifactId>cloudzipkin</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>cloudzipkin</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.RC1</spring-cloud.version>
</properties>
<dependencies>
<!--引入的zipkinServer依赖-->
<dependency>
<groupId>io.zipkin.java</groupId>
<artifactId>zipkin-server</artifactId>
<version>2.9.4</version>
</dependency>
<dependency>
<groupId>io.zipkin.java</groupId>
<artifactId>zipkin-autoconfigure-ui</artifactId>
<version>2.9.4</version>
</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>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
</repository>
</repositories>
</project>
启动类上增加@EnableZipkinServer注解,标识为zipkin服务端
package com.jthao.cloudzipkin;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import zipkin.server.internal.EnableZipkinServer;
@EnableZipkinServer
@SpringBootApplication
public class CloudzipkinApplication {
public static void main(String[] args) {
SpringApplication.run(CloudzipkinApplication.class, args);
}
}
修改配置文件
server.port=8201
spring.main.allow-bean-definition-overriding=true
management.metrics.web.server.auto-time-requests=false
通过浏览器访问http://localhost:8201/zipkin/,稍后会详细介绍这个页面
- 3.2创建子系统
创建两个module,取名为servicea和serviceb,选择Cloud Tracing,再勾选上Zipkin Client,完成
创建完成的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>2.1.1.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.jthao</groupId>
<artifactId>servicea</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>servicea</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.RC1</spring-cloud.version>
</properties>
<dependencies>
<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>
<repositories>
<repository>
<id>spring-milestones</id>
<name>Spring Milestones</name>
<url>https://repo.spring.io/milestone</url>
</repository>
</repositories>
</project>
servicea启动类和配置文件,端口分别为8202,8203。spring.zipkin.base-url为配置zipkin服务端地址
package com.jthao.servicea;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
@RestController
@SpringBootApplication
public class ServiceaApplication {
public static void main(String[] args) {
SpringApplication.run(ServiceaApplication.class, args);
}
@Autowired
private RestTemplate restTemplate;
@Bean
public RestTemplate getRestTemplate() {
return new RestTemplate();
}
@RequestMapping("/serviceAInfo")
public String serviceAInfo() {
System.out.println("serviceAInfo start");
return "serviceA 被调用了";
}
@RequestMapping("/getServiceB")
public String getServiceB() {
System.out.println("开始访问serviceb");
return restTemplate.getForObject("http://localhost:8203/serviceBInfo", String.class);
}
}
server.port=8202
spring.application.name=servicea
spring.zipkin.base-url=http://localhost:8201
serviceb启动类和配置文件
package com.jthao.serviceb;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
@RestController
@SpringBootApplication
public class ServicebApplication {
public static void main(String[] args) {
SpringApplication.run(ServicebApplication.class, args);
}
@Autowired
private RestTemplate restTemplate;
@Bean
public RestTemplate getRestTemplate() {
return new RestTemplate();
}
@RequestMapping("/serviceBInfo")
public String serviceBInfo() {
System.out.println("serviceBInfo start");
return "serviceB 被调用了";
}
@RequestMapping("/getServiceA")
public String getServiceA() {
System.out.println("开始访问servicea");
return restTemplate.getForObject("http://localhost:8202/serviceAInfo", String.class);
}
}
server.port=8203
spring.application.name=serviceb
spring.zipkin.base-url=http://localhost:8201
通过浏览器分别访问http://localhost:8202/getServiceB和http://localhost:8203/getServiceA
到这,zipkin服务端和两个子系统链路追踪均已搭建完成
- 3.3测试
这时我们在看zipkin服务端访问页面依赖分析,可以看到servicea和serviceb互相依赖调用(这里只有serviea和serviceb互相调用后才可以看到)
查找调用链中,可以看到Service name中有两个子系统的注册服务,类似于服务注册中心,Span name可以查到各个服务的所有方法,下面的访问情况蓝色代表网络通畅,红色代表访问失败