springboot2 springcloud Greenwich.SR3 构建微服务--9.服务跟踪

怼烎@ 2023-10-11 11:49 30阅读 0赞

在前面的章节中, 我们使用order 去调用product的服务, 然后就出现了,问题, 非常不容易去调试, 也没有办法去跟踪各个服务.

不用担心, 跟踪微服务的必备组件, 这里介绍的是zipkin

Spring Cloud Sleuth 主要功能就是在分布式系统中提供追踪解决方案，并且兼容支持了 zipkin，你只需要在pom文件中引入相应的依赖即可。

Zipkin **是一款开源的分布式实时数据追踪系统**（Distributed Tracking System），基于 Google Dapper 的论文设计而来，由 Twitter公司开发贡献。其主要功能是**聚集来自各个异构系统的实时监控数据，用来追踪微服务架构下的系统延时问题**。**应用系统需要进行装备（instrument）以向 Zipkin 报告数据**。Zipkin 的用户界面可以呈现一幅关联图表，以显示有多少被追踪的请求通过了每一层应用。Zipkin 以 Trace 结构表示对一次请求的追踪，又把每个 Trace 拆分为若干个有依赖关系的 Span。在**微服务架构**中，**一次用户请求可能会由后台若干个服务负责处理**，那么每个处理请求的服务就可以理解为**一个 Span**（可以包括 **API 服务，缓存服务，数据库服务以及报表服务**等）。当然这个服务也可能继续请求其他的服务，因此** Span 是一个树形结构**，**以体现服务之间的调用关系**。**Zipkin 的用户界面除了可以查看 Span 的依赖关系之外**，**还以瀑布图的形式显示了每个 Span 的耗时情况**，**可以一目了然的看到各个服务的性能状况**。打开每个 Span，还有更详细的数据以键值对的形式呈现，而且这些数据可以在装备应用的时候自行添加。

## zipkin结构 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzOTg3NzE_size_16_color_FFFFFF_t_70][]

可以看到zipkin内部主要分为四部分：**collector、storage、api、ui**

** collector：负责将各系统报告过来的追踪数据进行接收**

**storage：默认使用Cassandra存储数据，也可以替换为其他存储**，例如**mysql5.6-5.7，ElasticSearch 2.x和5.x**，还有一些第三方的存储

** api：查询服务用来向其他服务提供数据查询的能力，是以json api格式提供**

**ui：Web服务是官方默认提供的一个图形用户界面**

##     transport ##

transport负责从运输从service收集来的spans，并把这些spans转化为zipkin的通用span，并将其传递到存储层，这种方法是模块化的，允许任何生产者接收任何类型的数据，zipkin配有HTTP、kafka、scribe三种类型的transport。instrumentations负责和transport进行交互。

# 核心数据结构 #

**traceId：全局跟踪ID**，用它来标记一次完整服务调用，所以和一次服务调用相关的span中的traceId都是相同的，Zipkin将具有相同traceId的span组装成跟踪树来直观的将调用链路图展现在我们面前。

id：span的id，理论上来说，span的id只要做到一个traceId下唯一就可以

**parentId：父span的id，调用有层级关系**，所以span作为调用节点的存储结构，也有层级关系，就像图3所示，跟踪链是采用跟踪树的形式来展现的，树的根节点就是调用调用的顶点，从开发者的角度来说，顶级span是从接入了Zipkin的应用中最先接触到服务调用的应用中采集的。所以，顶级span是没有parentId字段的

**name：span的名称，主要用于在界面上展示，一般是接口方法名**，name的作用是让人知道它是哪里采集的span，不然某个span耗时高我都不知道是哪个服务节点耗时高

**timestamp：span创建时的时间戳**，用来记录采集的时刻。

**duration：持续时间**，即span的创建到span完成最终的采集所经历的时间，除去span自己逻辑处理的时间，该时间段可以理解成对于该跟踪埋点来说服务调用的总耗时

**annotations：基本标注列表**，一个标注可以理解成span生命周期中重要时刻的数据快照，比如一个标注中一般包含发生时刻（timestamp）、事件类型（value）、端点（endpoint）等信息

**事件类型**

**cs：客户端/消费者发起请求**

** cr：客户端/消费者接收到应答**

** sr：服务端/生产者接收到请求**

** ss：服务端/生产者发送应答**

PS：这四种事件类型的统计都应该是Zipkin提供客户端来做的，因为这些事件和业务无关，这也是为什么跟踪数据的采集适合放到中间件或者公共库来做的原因。

binaryAnnotations：业务标注列表，如果某些跟踪埋点需要带上部分业务数据（比如url地址、返回码和异常信息等），可以将需要的数据以键值对的形式放入到这个字段中。

构建工程  
本文的案例主要有三个工程组成:一个server-zipkin,它的主要作用使用ZipkinServer 的功能，收集调用数据，并展示；一个service-hi,对外暴露hi接口；一个service-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

访问浏览器localhost:9494

4.2 创建service-hi  
在其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>
    	<groupId>com.forezp</groupId>
    	<artifactId>service-zipkin</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<packaging>jar</packaging>
    	<name>service-hi</name>
    	<description>Demo project for Spring Boot</description>
    	<parent>
    		<groupId>com.forezp</groupId>
    		<artifactId>sc-f-chapter9</artifactId>
    		<version>0.0.1-SNAPSHOT</version>
    	</parent>
    	<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.yml指定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就可以了。

对外暴露接口：

package com.forezp;
    
    import brave.sampler.Sampler;
    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 java.util.logging.Level;
    import java.util.logging.Logger;
    
    @SpringBootApplication
    @RestController
    public class ServiceHiApplication {
    
    	public static void main(String[] args) {
    		SpringApplication.run(ServiceHiApplication.class, args);
    	}
    
    	private static final Logger LOG = Logger.getLogger(ServiceHiApplication.class.getName());
    
    
    	@Autowired
    	private RestTemplate restTemplate;
    
    	@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 创建service-miya

创建过程痛service-hi，引入相同的依赖，配置下spring.zipkin.base-url。

对外暴露接口：

package com.forezp;
    
    import brave.sampler.Sampler;
    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 java.util.logging.Level;
    import java.util.logging.Logger;
    
    @SpringBootApplication
    @RestController
    public class ServiceMiyaApplication {
    
    	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);
    	}
    
    	@Autowired
    	private RestTemplate restTemplate;
    
    	@Bean
    	public RestTemplate getRestTemplate(){
    		return new RestTemplate();
    	}
    
    
    	@Bean
    	public Sampler defaultSampler() {
    		return Sampler.ALWAYS_SAMPLE;
    	}
    }

4.4 启动工程，演示追踪  
依次启动上面的工程，打开浏览器访问：http://localhost:9411/，会出现以下界面：

访问：http://localhost:8989/miya，浏览器出现：

i’m service-hi

再打开http://localhost:9411/的界面，点击Dependencies,可以发现服务的依赖关系：

点击find traces,可以看到具体服务相互调用的数据：

本文源码下载：

https://github.com/forezp/SpringCloudLearning/tree/master/sc-f-chapter9

我把自己写的删除了, 然后从别人那里转载了一篇, 本文示例代码内容转载自:

[https://blog.csdn.net/forezp/article/details/81041078][https_blog.csdn.net_forezp_article_details_81041078]

整个代码地址是:

https://github.com/changhe626/micro-service

Java Framework,欢迎各位前来交流java相关  
QQ群:965125360

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzOTg3NzE_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/201909231359151.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTAzOTg3NzE=,size_16,color_FFFFFF,t_70
[https_blog.csdn.net_forezp_article_details_81041078]: https://blog.csdn.net/forezp/article/details/81041078