Spring Cloud教程七:Sleuth

文章目录
  1. 1. zipkin服务端
  2. 2. zipkin客户端
    1. 2.1. 创建frontend-service项目
    2. 2.2. 创建backend-service项目
  3. 3. 测试

随着分布式服务架构的流行,特别是微服务等设计理念在系统中的应用,系统规模也会变得越来越大,各微服务间的调用关系也变得越来越复杂。通常一个由客户端发起的请求在后端系统中会经过多个不同的微服务调用来协同产生最后的请求结果。

在复杂的微服务架构系统中,几乎每一个前端请求都会形成一个复杂的分布式服务调用链路。那么就带来一系列问题,在业务规模不断增大、服务不断增多以及频繁变更的情况下,如何快速发现问题?如何判断故障影响范围?如何梳理服务依赖以及依赖的合理性?如何分析链路性能问题以及实时容量规划?面对上面这些问题,Spring Cloud Sleuth提供了分布式服务跟踪解决方案, 并且兼容支持了zipkin

zipkin服务端

zipkin服务端并非不能自己代码构建,但官方目前建议用已经提供好的server。构建方法也可以查看官网或者github,默认端口是9411,可通过几种方式构建。

Java环境,直接在终端执行

1
2
curl -sSL https://zipkin.io/quickstart.sh | bash -s
java -jar zipkin.jar

如果实在Docker中,可直接使用

1
docker run -d -p 9411:9411 openzipkin/zipkin

最后一种方法,是直接拉取源代码编译,也很方便

1
2
3
4
5
6
7
# get the latest source
git clone https://github.com/openzipkin/zipkin
cd zipkin
# Build the server and also make its dependencies
./mvnw -DskipTests --also-make -pl zipkin-server clean install
# Run the server
java -jar ./zipkin-server/target/zipkin-server-*exec.jar

完成后访问 http://localhost:9411/ ,可查看到管理界面。

使用java -jar xxx.jar的方式启动,server所有参数都是默认的,如果要修改,比如集成了rabbitmq需要修改地址为localhost,那么启动命令就变成了

1
java -jar xxx.jar --zipkin.collector.rabbitmq.addresses=localhost

所有可以配置的参数都可以通过 https://github.com/openzipkin/zipkin/blob/master/zipkin-server/src/main/resources/zipkin-server-shared.yml 查看。

zipkin客户端

新建两个项目 frontend-servicebackend-service ,然后通过frontend-service调用backend-service提供的接口.

创建frontend-service项目

使用Spring Initializr新建一个Moudle,取名为frontend-service, 在Spring Cloud Discovery中勾选Eureka Discovery Client,在Web中勾选Spring Web:

创建成功后,项目pom.xml如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<?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.1.9.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.noodles.mars</groupId>
<artifactId>frontend-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>frontend-service</name>
<description>Frontend Service</description>

<properties>
<java.version>11</java.version>
<spring-cloud.version>Greenwich.SR3</spring-cloud.version>
</properties>

<dependencies>
<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>
</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>

配置文件内容:

1
2
3
4
5
6
7
8
9
10
11
server:
port: 8080

spring:
application:
name: frontend-service
zipkin:
base-url: http://localhost:9411/
sleuth:
sampler:
probability: 1.0

application.yml中,spring.zipkin.base-url指定zipkin服务端的地址,spring.sleuth.sampler.probalility指定采样百分比,默认0.1,改成1.0表示所有数据都采用。

在启动类中添加一个Bean,用来注入RestTemplate。

1
2
3
4
5
6
7
8
9
10
11
12
@SpringBootApplication
public class FrontendServiceApplication {

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

@Bean
RestTemplate restTemplate() {
return new RestTemplate();
}
}

最后新建一个Controller, 调用后端服务提供的接口:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
@RestController
public class FrontendController {

private final RestTemplate restTemplate;

@Autowired
public FrontendController(RestTemplate restTemplate) {
this.restTemplate = restTemplate;
}

@GetMapping("/frontend-api")
public String frontendApi() {
String backendUrl = "http://localhost:8090/backend-api";
return restTemplate.getForObject(backendUrl, String.class);
}
}

创建backend-service项目

使用Spring Initializr新建一个Moudle,取名为backend-service, 在Spring Cloud Discovery中勾选Eureka Discovery Client,在Web中勾选Spring Web:

创建成功后,项目pom.xml如下:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
<?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.1.9.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.noodles.mars</groupId>
<artifactId>backend-service</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>backend-service</name>
<description>Backend Service</description>

<properties>
<java.version>11</java.version>
<spring-cloud.version>Greenwich.SR3</spring-cloud.version>
</properties>

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

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

配置文件内容:

1
2
3
4
5
6
7
8
9
10
11
server:
port: 8090

spring:
application:
name: backend-service
zipkin:
base-url: http://localhost:9411/
sleuth:
sampler:
probability: 1.0

application.yml中,spring.zipkin.base-url指定zipkin服务端的地址,spring.sleuth.sampler.probalility指定采样百分比,默认0.1,改成1.0表示所有数据都采用。

最后新建一个Controller, 给前端服务提供一个接口:

1
2
3
4
5
6
7
8
@RestController
public class BackendController {

@GetMapping("/backend-api")
public String backendApi() {
return "Hello, My name is Mars!";
}
}

测试

启动zipkin服务、frontend-service、backend-service, 调用 http://localhost:8080/frontend-api ,可以调用多次,确认返回值是backend-service接口返回的数据。

然后查看 http://localhost:9411 ,确认显示了刚刚调用的链路。

点击进入源码仓库