SpringCloud第九篇：服务链路追踪(Spring Cloud Sleuth)(Finchley版本)
这篇文章主要讲述服务追踪组件zipkin，Spring Cloud Sleuth集成了zipkin组件。
一、简介
Spring Cloud Sleuth 主要功能就是在分布式系统中提供追踪解决方案，并且兼容支持了 zipkin，你只需要在pom文件中引入相应的依赖即可。
二、服务追踪分析
微服务架构上通过业务来划分服务的，通过REST调用，对外暴露的一个接口，可能需要很多个服务协同才能完成这个接口功能，如果链路上任何一个服务出现问题或者网络超时，都会形成导致接口调用失败。随着业务的不断扩张，服务之间互相调用会越来越复杂。
随着服务的越来越多，对调用链的分析会越来越复杂。它们之间的调用关系也许如下：
三、术语
1、Span
基本工作单元，例如，在一个新建的span中发送一个RPC等同于发送一个回应请求给RPC，span通过一个64位ID唯一标识，trace以另一个64位ID表示，span还有其他数据信息，比如摘要、时间戳事件、关键值注释(tags)、span的ID、以及进度ID(通常是IP地址)。span在不断的启动和停止，同时记录了时间信息，当你创建了一个span，你必须在未来的某个时刻停止它。
2、Trace一系列spans组成的一个树状结构，例如，如果你正在跑一个分布式大数据工程，你可能需要创建一个trace。
3、Annotation
用来及时记录一个事件的存在，一些核心annotations用来定义一个请求的开始和结束
cs-----Client Sent：客户端发起一个请求，这个annotion描述了这个span的开始
sr-----Server Received：服务端获得请求并准备开始处理它，如果将其sr减去cs时间戳便可得到网络延迟
ss-----Server Sent：注解表明请求处理的完成(当请求返回客户端)，如果ss减去sr时间戳便可得到服务端需要的处理请求时间
cr-----Client Received：表明span的结束，客户端成功接收到服务端的回复，如果cr减去cs时间戳便可得到客户端从服务端获取回复的所有所需时间
将Span和Trace在一个系统中使用Zipkin注解的过程图形化：
四、构建工程
基本知识讲解完毕，下面我们来实战，本文的案例主要有三个工程组成:一个server-zipkin，它的主要作用使用ZipkinServer 的功能，收集调用数据，并展示；一个SpringCloud_Server_Zipkin_Hi对外暴露hi接口；一个SpringCloud_Server_Zipkin_Miya，对外暴露miya接口；这两个service可以相互调用；并且只有调用了，server-zipkin才会收集数据的，这就是为什么叫服务追踪了。
4.1、构建server-zipkin
在spring Cloud为F版本的时候，已经不需要自己构建Zipkin Server了，只需要下载jar即可，下载地址：
https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/
也可以在这里下载：https://pan.baidu.com/s/1w614Z8gJXHtqLUB6dKWOpQ 密码：26pf
下载完成jar 包之后，需要运行jar，如下：
java -jar zipkin-server-2.10.1-exec.jar访问浏览器http://localhost:9411
4.2、构建SpringCloud_Server_Zipkin_Hi
在pom.xml中添加spring-cloud-starter-zipkin依赖，完整的pom内容如下所示：
<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>
<artifactId>SpringCloud_Server_Zipkin_Hi</artifactId>
<packaging>jar</packaging>
<name>SpringCloud_Server_Zipkin_Hi</name>
<url>http://maven.apache.org</url>
<parent>
<groupId>com</groupId>
<artifactId>SpringCloud_Common_Config_Server</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
在application.properties中指定zipkin server的地址，通过配置spring.zipkin.base-url指定
server.port=8988
spring.zipkin.base-url=http://localhost:9411
spring.application.name=service-hi通过引入spring-cloud-starter-zipkin依赖和设置spring.zipkin.base-url就可以了。
对外暴露接口ServiceHiApplication内容如下所示：
package com.forezp;
import java.util.logging.Level;
import java.util.logging.Logger;
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;
import brave.sampler.Sampler;
@SpringBootApplication
@RestController
public class ServiceHiApplication {
private static final Logger LOG = Logger.getLogger(ServiceHiApplication.class.getName());
@Autowired
private RestTemplate restTemplate;
public static void main(String[] args) {
SpringApplication.run(ServiceHiApplication.class, args);
}
@Bean
public RestTemplate getRestTemplate(){
return new RestTemplate();
}
@RequestMapping("/hi")
public String callHome(){
LOG.log(Level.INFO, "calling trace service-hi ");
return restTemplate.getForObject("http://localhost:8989/miya", String.class);
}
@RequestMapping("/info")
public String info(){
LOG.log(Level.INFO, "calling trace service-hi ");
return "i'm service-hi";
}
@Bean
public Sampler defaultSampler() {
return Sampler.ALWAYS_SAMPLE;
}
}
4.3、构建SpringCloud_Server_Zipkin_Miya
在pom.xml中添加spring-cloud-starter-zipkin依赖，完整的pom内容如下所示：
<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>
<artifactId>SpringCloud_Server_Zipkin_Miya</artifactId>
<packaging>jar</packaging>
<name>SpringCloud_Server_Zipkin_Miya</name>
<url>http://maven.apache.org</url>
<parent>
<groupId>com</groupId>
<artifactId>SpringCloud_Common_Config_Server</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</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>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
</project>
在application.properties中指定zipkin server的地址，通过配置spring.zipkin.base-url指定
server.port=8989
spring.zipkin.base-url=http://localhost:9411
spring.application.name=service-miya对外暴露接口ServiceMiyaApplication内容如下所示：
package com.forezp;
import java.util.logging.Level;
import java.util.logging.Logger;
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;
import brave.sampler.Sampler;
@SpringBootApplication
@RestController
public class ServiceMiyaApplication {
@Autowired
private RestTemplate restTemplate;
public static void main(String[] args) {
SpringApplication.run(ServiceMiyaApplication.class, args);
}
private static final Logger LOG = Logger.getLogger(ServiceMiyaApplication.class.getName());
@RequestMapping("/hi")
public String home(){
LOG.log(Level.INFO, "hi is being called");
return "hi i'm miya!";
}
@RequestMapping("/miya")
public String info(){
LOG.log(Level.INFO, "info is being called");
return restTemplate.getForObject("http://localhost:8988/info",String.class);
}
@Bean
public RestTemplate getRestTemplate(){
return new RestTemplate();
}
@Bean
public Sampler defaultSampler() {
return Sampler.ALWAYS_SAMPLE;
}
}
4.4 启动工程，演示追踪
依次启动刚才以jar包方式启动的Zipkin Server、SpringCloud_Server_Zipkin_Hi、SpringCloud_Server_Zipkin_Miya
4.5 访问：http://localhost:8989/miya，浏览器出现
再次打开http://localhost:9411的界面，点击Dependencies（依赖分析）,可以发现服务的依赖关系：
点击find traces(查找调用链)，可以看到具体服务相互调用的数据：
推荐阅读
-
spring cloud 入门系列八：使用spring cloud sleuth整合zipkin进行服务链路追踪
-
第九篇 : 服务链路追踪（Spring Cloud Sleuth）
-
SpringCloud教程 | 第九篇: 服务链路追踪(Spring Cloud Sleuth)(Finchley版本)
-
SpringCloud第九篇：服务链路追踪(Spring Cloud Sleuth)(Finchley版本)
-
spring cloud 入门系列八：使用spring cloud sleuth整合zipkin进行服务链路追踪
-
Spring Cloud（Finchley.RELEASE版本）微服务学习实践：6.2全链路追踪监控-Zipkin
-
Spring cloud（Finchley）微服务框架，sleuth整合zipkin链路追踪失效的问题