root: INFO

org.springframework.web.servlet.DispatcherServlet: DEBUG

org.springframework.cloud.sleuth: DEBUG

每个微服务都需要添加如上的配置。

运行测试

java微服务链路追踪自己实现 微服务调用链路追踪_Server

访问http://localhost:8080/order-service/order/buy/1

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_02

查看控制台输出的日志信息

  • GatewayServerApplication :8080/

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_03

  • OrderApplication :9002/

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_04

  • ProductApplication :9001/

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_05

启动微服务,调用之后,我们可以在控制台观察到sleuth的日志输出。

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_06

java微服务链路追踪自己实现 微服务调用链路追踪_Server_07

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_08

上述三个日志信息都有:fa49799c056547b9,fa49799c056547b9,false]

其中 fa49799c056547b9是TraceId,后面跟着的是SpanId,依次调用有一个全局的TraceId,将调用链路串起来。

仔细分析每个微服务的日志,不难看出请求的具体过程。

查看日志文件并不是一个很好的方法,当微服务越来越多日志文件也会越来越多,通过Zipkin可以将日志聚合,并进行可视化展示和全文检索。

二、 Zipkin


1、 Zipkin的概述

Zipkin 是 Twitter 的一个开源项目,它基于 Google Dapper 实现,它致力于收集服务的定时数据,以解决微服务架构中的延迟问题,包括数据的收集、存储、查找和展现。

我们可以使用它来收集各个服务器上请求链路的跟踪数据,并通过它提供的 REST API 接口来辅助我们查询跟踪数据以实现对分布式系统的监控程序,

从而及时地发现系统中出现的延迟升高问题并找出系统性能瓶颈的根源。

除了面向开发的 API 接口之外,它也提供了方便的 UI 组件来帮助我们直观的搜索跟踪信息和分析请求链路明细,

比如:可以查询某段时间内各用户请求的处理时间等。

Zipkin 提供了可插拔数据存储方式:In-MemoryMySqlCassandra 以及 Elasticsearch

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_09

上图展示了 Zipkin 的基础架构,它主要由 4 个核心组件构成:

  • Collector:收集器组件,它主要用于处理从外部系统发送过来的跟踪信息,将这些信息转换为Zipkin 内部处理的 Span 格式,以支持后续的存储、分析、展示等功能。
  • Storage:存储组件,它主要对处理收集器接收到的跟踪信息,默认会将这些信息存储在内存中,

我们也可以修改此存储策略,通过使用其他存储组件将跟踪信息存储到数据库中。

  • RESTful API:API 组件,它主要用来提供外部访问接口。比如给客户端展示跟踪信息,或是外接

系统访问以实现监控等。

  • Web UI:UI 组件,基于 API 组件实现的上层应用。通过 UI 组件用户可以方便而有直观地查询和分析跟踪信息。

Zipkin 分为两端,一个是 Zipkin 服务端,一个是 Zipkin 客户端,客户端也就是微服务的应用。

客户端会配置服务端的 URL 地址,一旦发生服务间的调用的时候,会被配置在微服务里面的 Sleuth 的监听器监听,并生成相应的 Trace 和 Span 信息发送给服务端。

发送的方式主要有两种,一种是 HTTP 报文的方式,还有一种是消息总线的方式如 RabbitMQ。

不论哪种方式,我们都需要:

  • 一个 Eureka 服务注册中心,这里我们就用之前的 eureka 项目来当注册中心。
  • 一个 Zipkin 服务端。
  • 多个微服务,这些微服务中配置Zipkin 客户端。

2、 Zipkin Server的部署和配置

(1)Zipkin Server下载与启动
  • 下载

从spring boot 2.0开始,官方就不再支持使用自建Zipkin Server的方式进行服务链路追踪,而是直接提供了编译好的 jar 包来给我们使用。

下载链接:https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin-server&v=LATEST&c=exec

可以从官方网站下载先下载Zipkin的web UI,我们这里下载的是

zipkin-server-2.12.9-exec.jar

  • 启动

在命令行输入 java -jar zipkin-server-2.12.9-exec.jar 启动 Zipkin Server

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_10

默认Zipkin Server的请求端口为 9411

Zipkin Server的启动参数可以通过官方提供的yml配置文件查找

配置文件查看地址:https://github.com/openzipkin/zipkin/blob/master/zipkin-server/src/main/resources/zipkin-server-shared.yml

在浏览器输入 http://127.0.0.1:9411即可进入到Zipkin Server的管理后台

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_11

三、 客户端Zipkin+Sleuth整合


通过查看日志分析微服务的调用链路并不是一个很直观的方案,结合zipkin可以很直观地显示微服务之间的调用关系。

1、客户端添加依赖

客户端指的是需要被追踪的微服务

  • api_gateway_server

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_12

  • order_service

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_13

  • product_service

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_14

org.springframework.cloud

spring-cloud-starter-zipkin

2、修改客户端配置文件

  • api_gateway_server

java微服务链路追踪自己实现 微服务调用链路追踪_java_15

  • order_service

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_16

  • product_service

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_17

zipkin:

base-url: http://127.0.0.1:9411/ #zipkin server的请求地址

sender:

type: web #请求方式,默认以http的方式向zipkin server发送追踪数据

sleuth:

sampler:

probability: 1.0 #采样的百分比

指定了zipkin server的地址,下面制定需采样的百分比,

默认为0.1,即10%,这里配置1,是记录全部的sleuth信息,是为了收集到更多的数据(仅供测试用)。

在分布式系统中,过于频繁的采样会影响系统性能,所以这里配置需要采用一个合适的值。

3、重新启动运行测试

java微服务链路追踪自己实现 微服务调用链路追踪_java_18

http://localhost:8080/order-service/order/buy/1

java微服务链路追踪自己实现 微服务调用链路追踪_java_19

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_20

查询指定的链路

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_21

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_22

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_23

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_24

因为数据是保存到内存当中的所有Zipkin重启数据就会丢失

四、 Zipkin服务端数据保存到mysql


java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_25

1、准备MYSQL数据库和表(官方提供好的)

SQL语句

/*

SQLyog Ultimate v11.33 (64 bit)

MySQL - 5.5.58 : Database - zipkin


*/

/*!40101 SET NAMES utf8 */;

/!40101 SET SQL_MODE=‘’/;

/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;

/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;

/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE=‘NO_AUTO_VALUE_ON_ZERO’ */;

/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;

CREATE DATABASE /!32312 IF NOT EXISTS/zipkin /*!40100 DEFAULT CHARACTER SET utf8 */;

USE zipkin;

/*Table structure for table zipkin_annotations */

DROP TABLE IF EXISTS zipkin_annotations;

CREATE TABLE zipkin_annotations (

trace_id_high bigint(20) NOT NULL DEFAULT ‘0’ COMMENT ‘If non zero, this means the trace uses 128 bit traceIds instead of 64 bit’,

trace_id bigint(20) NOT NULL COMMENT ‘coincides with zipkin_spans.trace_id’,

span_id bigint(20) NOT NULL COMMENT ‘coincides with zipkin_spans.id’,

a_key varchar(255) NOT NULL COMMENT ‘BinaryAnnotation.key or Annotation.value if type == -1’,

a_value blob COMMENT ‘BinaryAnnotation.value(), which must be smaller than 64KB’,

a_type int(11) NOT NULL COMMENT ‘BinaryAnnotation.type() or -1 if Annotation’,

a_timestamp bigint(20) DEFAULT NULL COMMENT ‘Used to implement TTL; Annotation.timestamp or zipkin_spans.timestamp’,

endpoint_ipv4 int(11) DEFAULT NULL COMMENT ‘Null when Binary/Annotation.endpoint is null’,

endpoint_ipv6 binary(16) DEFAULT NULL COMMENT ‘Null when Binary/Annotation.endpoint is null, or no IPv6 address’,

endpoint_port smallint(6) DEFAULT NULL COMMENT ‘Null when Binary/Annotation.endpoint is null’,

endpoint_service_name varchar(255) DEFAULT NULL COMMENT ‘Null when Binary/Annotation.endpoint is null’,

UNIQUE KEY trace_id_high (trace_id_high,trace_id,span_id,a_key,a_timestamp) COMMENT ‘Ignore insert on duplicate’,

KEY trace_id_high_2 (trace_id_high,trace_id,span_id) COMMENT ‘for joining with zipkin_spans’,

KEY trace_id_high_3 (trace_id_high,trace_id) COMMENT ‘for getTraces/ByIds’,

KEY endpoint_service_name (endpoint_service_name) COMMENT ‘for getTraces and getServiceNames’,

KEY a_type (a_type) COMMENT ‘for getTraces’,

KEY a_key (a_key) COMMENT ‘for getTraces’,

KEY trace_id (trace_id,span_id,a_key) COMMENT ‘for dependencies job’

) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

/*Data for the table zipkin_annotations */

/*Table structure for table zipkin_dependencies */

DROP TABLE IF EXISTS zipkin_dependencies;

CREATE TABLE zipkin_dependencies (

day date NOT NULL,

parent varchar(255) NOT NULL,

child varchar(255) NOT NULL,

call_count bigint(20) DEFAULT NULL,

UNIQUE KEY day (day,parent,child)

) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

/*Data for the table zipkin_dependencies */

/*Table structure for table zipkin_spans */

DROP TABLE IF EXISTS zipkin_spans;

CREATE TABLE zipkin_spans (

trace_id_high bigint(20) NOT NULL DEFAULT ‘0’ COMMENT ‘If non zero, this means the trace uses 128 bit traceIds instead of 64 bit’,

trace_id bigint(20) NOT NULL,

id bigint(20) NOT NULL,

name varchar(255) NOT NULL,

parent_id bigint(20) DEFAULT NULL,

debug bit(1) DEFAULT NULL,

start_ts bigint(20) DEFAULT NULL COMMENT ‘Span.timestamp(): epoch micros used for endTs query and to implement TTL’,

duration bigint(20) DEFAULT NULL COMMENT ‘Span.duration(): micros used for minDuration and maxDuration query’,

UNIQUE KEY trace_id_high (trace_id_high,trace_id,id) COMMENT ‘ignore insert on duplicate’,

KEY trace_id_high_2 (trace_id_high,trace_id,id) COMMENT ‘for joining with zipkin_annotations’,

KEY trace_id_high_3 (trace_id_high,trace_id) COMMENT ‘for getTracesByIds’,

KEY name (name) COMMENT ‘for getTraces and getSpanNames’,

KEY start_ts (start_ts) COMMENT ‘for getTraces ordering and range’

) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

/*Data for the table zipkin_spans */

/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;

/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;

/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;

/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_26

2、修改server的启动命令

java微服务链路追踪自己实现 微服务调用链路追踪_java_27

java -jar zipkin-server-2.12.9-exec.jar --STORAGE_TYPE=mysql --MYSQL_HOST=127.0.0.1 --MYSQL_TCP_PORT=3306 --MYSQL_DB=zipkin --MYSQL_USER=root --MYSQL_PASS=root

  • STORAGE_TYPE : 存储类型
  • MYSQL_HOST: mysql主机地址
  • MYSQL_TCP_PORT:mysql端口
  • MYSQL_DB: mysql数据库名称
  • MYSQL_USER:mysql用户名
  • MYSQL_PASS :mysql密码

配置好服务端之后,可以在浏览器请求几次。回到数据库查看会发现数据已经持久化到mysql中

访问:http://localhost:8080/order-service/order/buy/1

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_28

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_29

五、 基于消息中间件RabbitMQ收集数据


在默认情况下,Zipkin客户端和Server之间是使用HTTP请求的方式进行通信(即同步的请求方式),在网络波动,Server端异常等情况下可能存在信息收集不及时的问题。

Zipkin支持与rabbitMQ整合完成异步消息传输。

加了MQ之后,通信过程如下图所示:

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_30

java微服务链路追踪自己实现 微服务调用链路追踪_Server_31

1、服务端启动

java -jar zipkin-server-2.12.9-exec.jar --RABBIT_ADDRESSES=127.0.0.1:5672

  • RABBIT_ADDRESSES : 指定RabbitMQ地址
  • RABBIT_USER: 用户名(默认guest)
  • RABBIT_PASSWORD : 密码(默认guest)

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_32

启动Zipkin Server之后,我们打开RabbitMQ的控制台可以看到多了一个Queue

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_33

2、客户端配置

(1)配置依赖
  • api_gateway_server

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_34

  • order_service

java微服务链路追踪自己实现 微服务调用链路追踪_Server_35

  • product_service

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_36

org.springframework.cloud

spring-cloud-sleuth-zipkin

org.springframework.amqp

spring-rabbit

导入 spring-rabbit 依赖,是Spring提供的对rabbit的封装,客户端会根据配置自动的生产消息并发送到目标队列中

(2) 配置消息中间件rabbit mq地址等信息
  • api_gateway_server

java微服务链路追踪自己实现 微服务调用链路追踪_java微服务链路追踪自己实现_37

  • order_service

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_38

  • product_service

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_39

zipkin:

#base-url: http://127.0.0.1:9411/ #zipkin server的请求地址

sender:

type: rabbit #请求方式向rabbit发送追踪数据

sleuth:

sampler:

probability: 1 #采样的百分比

rabbitmq:

host: localhost

port: 5672

username: guest

password: guest

listener: # 这里配置了重试策略

direct:

retry:

enabled: true

simple:

retry:

enabled: true

  • 修改消息的投递方式,改为rabbit即可。
  • 添加rabbitmq的相关配置
(3)测试

java微服务链路追踪自己实现 微服务调用链路追踪_spring cloud_40

关闭Zipkin Server,并随意请求连接。打开rabbitmq管理后台可以看到,消息已经推送到rabbitmq。

java微服务链路追踪自己实现 微服务调用链路追踪_java_41

Ctrl + C 停止Zipkin Server

多访问几次:http://localhost:8080/order-service/order/buy/1

java微服务链路追踪自己实现 微服务调用链路追踪_Server_42

当Zipkin Server启动时,会自动的从rabbitmq获取消息并消费,展示追踪数据

可以看到如下效果:

访问rabbitmqhttp://localhost:15672/#/

java微服务链路追踪自己实现 微服务调用链路追踪_Server_43

账号密码都是:guest

java微服务链路追踪自己实现 微服务调用链路追踪_Server_44

java微服务链路追踪自己实现 微服务调用链路追踪_java_45

java微服务链路追踪自己实现 微服务调用链路追踪_java_46

重新启动ZipkinServer

java微服务链路追踪自己实现 微服务调用链路追踪_java_47

java -jar zipkin-server-2.12.9-exec.jar --RABBIT_ADDRESSES=127.0.0.1:5672

访问:http://localhost:9411/

java微服务链路追踪自己实现 微服务调用链路追踪_微服务_48

  • 请求的耗时时间不会出现突然耗时特长的情况
  • 当ZipkinServer不可用时(比如关闭、网络不通等),追踪信息不会丢失,因为这些信息会保存在Rabbitmq服务器上,直到Zipkin服务器可用时,再从Rabbitmq中取出这段时间的信息