一、Spring Cloud Sleuth简介
Spring Cloud Sleuth 主要功能就是在分布式系统中提供追踪解决方案,并且兼容支持了 zipkin,你只需要在pom文件中引入相应的依赖即可。
术语
Spring Cloud Sleuth借用了Dapper的术语。
Span:工作的基本单位 。例如,发送RPC是一个新的跨度,以及向RPC发送响应。Span由跨度的唯一64位ID标识,跨度是其中一部分的跟踪的另一个64位ID。跨度还具有其他数据,例如描述,时间戳记事件,键值注释(标签),导致它们的跨度的ID以及进程ID(通常是IP地址)。。
跟踪:一组spans形成树状结构。例如,如果您正在运行分布式大数据存储,则可能会由put请求形成跟踪。
注释: 用于及时记录事件的存在。用于定义请求的开始和停止的一些核心注释是:
cs - 客户端发送 - 客户端已经发出请求。此注释描绘了跨度的开始。
sr - 服务器接收 - 服务器端得到请求,并将开始处理它。如果从此时间戳中减去cs时间戳,则会收到网络延迟。
ss - 服务器发送 - 在完成请求处理后(响应发送回客户端时)注释。如果从此时间戳中减去sr时间戳,则会收到服务器端处理请求所需的时间。
cr - 客户端接收 - 表示跨度的结束。客户端已成功接收到服务器端的响应。如果从此时间戳中减去cs时间戳,则会收到客户端从服务器接收响应所需的整个时间。
可视化Span和Trace将与Zipkin注释一起查看系统:
一个音符的每个颜色表示跨度(7 spans - 从A到G)。
这意味着,当前的跨度痕量-ID设置为X,Span -编号设置为ð。它也发出了 客户端发送的事件。
这样,spans的父/子关系的可视化将如下所示:
二、创建工程实现代码测试
1、构建server-zipkin
在spring Cloud为F版本的时候,已经不需要自己构建Zipkin Server了,只需要下载jar即可。
下载地址:https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/
运行jar包:
java -jar zipkin-server-2.10.1-exec.jar
2、创建service-sleuth
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>
<groupId>com.example.demo.sleuth</groupId>
<artifactId>service-sleuth</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>service-sleuth</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>com.example.demo</groupId>
<artifactId>springcloud-sleuth</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
applicatio.yml配置文件:
server:
port: 8081
spring:
application:
name: service-sleuth
zipkin:
base-url: http://localhost:9411
创建暴露接口,TestSleuthController.java 文件:
package com.example.demo.sleuth.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
/**
* 路径:com.example.demo.sleuth.controller
* 类名:
* 功能:对外暴露接口
* 备注:
* 创建人:typ
* 创建时间:2018/9/18 22:26
* 修改人:
* 修改备注:
* 修改时间:
*/
@RestController
public class TestSleuthController {
private static final Logger log = LoggerFactory.getLogger(TestSleuthController.class);
@Autowired
private RestTemplate restTemplate;
@GetMapping("/test")
public String test(){
log.info("calling trace service-sleuth");
return restTemplate.getForObject("http://localhost:8082/miya", String.class);
}
@GetMapping("/info")
public String info(){
log.info("calling trace service-sleuth");
return "I'm service-sleuth";
}
}
启动类ServiceSleuthApplication.java文件:
package com.example.demo.sleuth;
import brave.sampler.Sampler;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
@SpringBootApplication
public class ServiceSleuthApplication {
public static void main(String[] args) {
SpringApplication.run(ServiceSleuthApplication.class, args);
}
@Bean
public RestTemplate restTemplate(){
return new RestTemplate();
}
@Bean
public Sampler defaultSampler() {
return Sampler.ALWAYS_SAMPLE;
}
}
3、创建sleuth- miya
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>
<groupId>com.example.demo.sleuth</groupId>
<artifactId>service-miya</artifactId>
<version>0.0.1-SNAPSHOT</version>
<packaging>jar</packaging>
<name>service-miya</name>
<description>Demo project for Spring Boot</description>
<parent>
<groupId>com.example.demo</groupId>
<artifactId>springcloud-sleuth</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
application.yml配置文件:
server:
port: 8082
spring:
application:
name: service-miya
zipkin:
base-url: http://localhost:9411
暴露接口TestMiyaController.java文件:
package com.example.demo.sleuth.controller;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
/**
* 路径:com.example.demo.sleuth.controller
* 类名:
* 功能:《用一句描述一下》
* 备注:
* 创建人:typ
* 创建时间:2018/9/18 22:39
* 修改人:
* 修改备注:
* 修改时间:
*/
@RestController
public class TestMiyaController {
private static final Logger log = LoggerFactory.getLogger(TestMiyaController.class);
@Autowired
private RestTemplate restTemplate;
@GetMapping("/test")
public String test(){
log.info("test is being called");
return "I'm miya!";
}
@GetMapping("/miya")
public String info(){
log.info("info is being called");
return restTemplate.getForObject("http://localhost:8081/info",String.class);
}
}
启动类ServiceMiyaApplication.java文件:
package com.example.demo.sleuth;
import brave.sampler.Sampler;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;
import org.springframework.web.client.RestTemplate;
@SpringBootApplication
public class ServiceMiyaApplication {
public static void main(String[] args) {
SpringApplication.run(ServiceMiyaApplication.class, args);
}
@Bean
public RestTemplate getRestTemplate(){
return new RestTemplate();
}
@Bean
public Sampler defaultSampler() {
return Sampler.ALWAYS_SAMPLE;
}
}
4、启动工程测试
在浏览器访问:http://localhost:9411/,会出现以下界面:
浏览器访问:http://localhost:8082/miya,浏览器出现:
"I'm service-sleuth
刷新http://localhost:9411/的界面,点击Dependencies,可以发现服务的依赖关系:
点击find traces,可以看到具体服务相互调用的数据:
源码下载:https://download.csdn.net/download/typ1805/10677402