【Spring Cloud】Sleuth +Zinkin 实现链路追踪并持久化的解决方案

文章目录

前言
链路追踪介绍
Sleuth入门
- Sleuth介绍
- - Trace
  - Span
  - Annotation
- Sleuth入门
- - 1、引入依赖
  - 2、修改配置文件
  - 3、网关路由配置
  - 4、演示
Zipkin的集成
- ZipKin介绍
- ZipKin服务端安装
- Zipkin客户端集成
- - 1、添加依赖
  - 2、添加配置
  - 3、访问微服务
  - 4、演示
Zipkin数据持久化
- 使用mysql实现数据持久化
- - 1、创建mysql数据环境
  - 2、启动Zipkin Server
  - 3、演示
- 使用elasticsearch实现数据持久化
- - 1、下载
  - 2、启动
- 3、启动Zipkin Server
- - 4、ES-head安装
  - 5、演示
总结

前言

开始之前先降个版本，我发现高版本的springcloud好像不统计gateway的链路信息，百度了一大顿没有发现问题，如果有小伙伴在高版本里解决了，欢迎留言指正。

<spring-cloud.version>Hoxton.sR12</spring-cloud.version>
<spring-cloud-alibaba.version>2.2.8.RELEASE</spring-cloud-alibaba.version>
<spring-boot.version>2.3.12.RELEASE</spring-boot.version>

链路追踪介绍

在大型系统的微服务化构建中，一个系统被拆分成了许多模块。这些模块负责不同的功能，组合成系统，最终可以提供丰富的功能。

在这种架构中，一次请求往往需要涉及到多个服务。互联网应用构建在不同的软件模块集上，这些软件模块，有可能是由不同的团队开发、可能使用不同的编程语言来实现、有可能布在了几千台服务器，横跨多个不同的数据中心，也就意味着这种架构形式也会存在一些问题：

如何快速发现问题?
如何判断故障影响范围?
如何梳理服务依赖以及依赖的合理性?
如何分析链路性能问题以及实时容量规划?

在这里插入图片描述

分布式链路追踪(Distributed Tracing)，就是将一次分布式请求还原成调用链路，进行日志记录，性能监控并将一次分布式请求的调用情况集中展示。比如各个服务节点上的耗时、请求具体到达哪台机器上、每个服务节点的请求状态等等。

常见的链路追踪技术有下面这些：

cat 由大众点评开源，基于Java开发的实时应用监控平台，包括实时应用监控、业务监控。集成方案是通过代码埋点的方式来实现监控，比如：拦截器，过滤器等。对代码的侵入性很大，集成成本较高，风险较大。
zipkin 由 Twitter 公司开源，开放源代码分布式的跟踪系统，用于收集服务的定时数据，以解决微服务架构中的延迟问题，包括：数据的收集、存储、查找和展现。该产品结合 spring-cloud-sleuth 使用较为简单，集成很方便，但是功能较简单。
pinpoint 是韩国人开源的基于字节码注入的调用链分析以及应用监控分析工具。特点是支持多种插件，UI功能强大，接入端无代码侵入。
skywalking 是本土开源的基于字节码注入的调用链分析，以及应用监控分析工具。特点是**支持多种插件，U功能较强，接入端无代码侵入。**目前已加入Apache孵化器。
Sleuth 是SpringCloud提供的分布式系统中链路追踪解决方案。

注意：SpringCloud alibaba技术栈中并没有提供自己的链路追踪技术，我们可以采用Sleuth +Zinkin来做链路追踪解决方案。

Sleuth入门

Sleuth介绍

SpringCloud Sleuth 主要功能就是在分布式系统中提供追踪解决方案。它大量借用了Google Dapper的设计，先来了解一下Sleuth 中的术语和相关概念。

Trace

整个调用链路，由一组Trace Id相同的Span串联形成一个树状结构。为了实现请求跟踪，当请求到达分布式系统的入口端点时，只需要服务跟踪框架为该请求创建一个唯一的标识(即Traceld)，同时在分布式系统内部流转的时候，框架始终保持传递该唯一值，直到整个请求的返回。那么我们就可以使用该唯一标识将所有的请求串联起来，形成一条完整的请求链路。

Span

代表了一组基本的工作单元，产生于一次远程微服务调用。为了统计各处理单元的延迟，当请求到达各个服务组件的时候，也通过一个唯一标识(Spanld)来标记它的开始、具体过程和结束。通过 Spanld 的开始和结束时间戳，就能统计该 span 的调用时间。除此之外，我们还可以获取如事件的名称、请求信息等元数据。

Annotation

用它记录一段时间内的事件，内部使用的重要注释：

cs(Client Send)客户端发出请求，开始一个请求的生命；
sr(Server Received)服务端接受到请求开始进行处理，sr-cs=网络延迟(服务调用的时间)；
ss(Server Send)服务端处理完毕准备发送到客户端， ss-sr=服务器上的请求处理时间；
cr(Client Reveived)客户端接受到服务端的响应，请求结束。cr-sr=请求的总时间；

在这里插入图片描述

Sleuth入门

接下来我们一起来通过之前的项目案例整合Sleuth

1、引入依赖

每个微服务都添加依赖

<!--链路追踪sleuth-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-sleuth</artifactId>
</dependency>

2、修改配置文件

每个微服务都添加日志级别

logging:
  level:
    root: info
    org.springframework.web.servlet.DispatcherServlet: debug
    org.springframework.cloud.sleuth: debug

3、网关路由配置

spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      discovery:
        locator:
          enabled: true  # 让gateway可以发现nacos中的微服务
          lowerCaseServiceId: true # 将请求路径上的服务名配置为小写
      routes:
        - id: shop-order #当前路由标识，要求唯一
          uri: lb://shop-order #lb代表从nacos中获取微服务，shop-order 是微服务的名称
          order: 1 #路由的优先级，数字越小级别越高
          predicates: #断言(就是路由转发要满足的条件)
            - Path=/order/** #当请求路径满足Path指定的规则时,才进行路由转发
          filters: #过滤器，请求在传递过程中可以通过过滤器对其进行一定的修改
            - StripPrefix=1 #去掉请求路径的第一层

4、演示

启动微服务，我们调用之前下订单的操作，即网关->订单微服务->商品微服务，调用http://127.0.0.1:7000/order/order2/1?token=123

在这里插入图片描述

我们可以在控制台观察到 sleuth 的日志输出

在这里插入图片描述

截图中的解释：[微服务名称， traceld， spanId，是否将链路的追踪结果输出到第三方平台]

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

Zipkin的集成

ZipKin介绍

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

我们可以使用它来收集各个服务器上请求链路的跟踪数据，并通过它提供的 REST API 接口来辅助我们查询跟踪数据以实现对分布式系统的监控程序，从而及时地发现系统中出现的延迟升高问题并找出系统性能瓶颈的根源。

除了面向开发的API接口之外，它也提供了方便的UI组件来帮助我们直观的搜索跟踪信息和分析请求链路明细，比如：可以查询某段时间内各用户请求的处理时间等。

Zipkin 提供了可插拔数据存储方式：In-Memory、MySqI、Cassandra 以及 Elasticsearch。

在这里插入图片描述

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

Collector：收集器组件，它主要用于处理从外部系统发送过来的跟踪信息，将这些信息转换为 Zipkin 内部处理的 Span 格式，以支持后续的存储、分析、展示等功能。
Storage：存储组件，它主要对处理收集器接收到的跟踪信息，默认会将这些信息存储在内存中，我们也可以修改此存储策略，通过使用其他存储组件将跟踪信息存储到数据库中。
RESTful API：API组件，它主要用来提供外部访问接口。比如给客户端展示跟踪信息，或是外接系统访问以实现监控等。
Web UI：UI组件，基于API组件实现的上层应用。通过UI组件用户可以方便而有直观地查询和分析跟踪信息。

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

ZipKin服务端安装

1、下载jar包

访问下载链接即可得到一个jar包，这就是ZipKin服务端的jar包。

2、启动服务端

通过命令行输入命令启动ZipKin Server java-jar zipkin-server-2.12.9-exec. jar

3、访问

通过浏览器访问 http://127.0.0.1:9411访问

在这里插入图片描述

Zipkin客户端集成

ZipKin 客户端集成非常简单，只需要在微服务中添加其依赖和配置即可。

1、添加依赖

在每个微服务上添加依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-sleuth-zipkin</artifactId>
</dependency>

2、添加配置

spring:
  zipkin:
    base-url: http://127.0.0.1:9411/ #zipkin server的请求地址
    discovery-client-enabled: false #关闭服务发现，因为zipkin server和gateway在同一个nacos中,让nacos把他当成一个URL，而不是当做服务名
  sleuth:
    sampler:
      probability: 1.0 #设置采样比例为：1.0，即全部都需要

3、访问微服务

http://127.0.0.1:7000/order/order2/1?token=123

4、演示

访问zipkin的UI界面，观察效果

在这里插入图片描述

点击其中一条记录，可观察一次访问的详细线路。
在这里插入图片描述
点击其中的某个服务，查看详细信息

在这里插入图片描述

Zipkin数据持久化

Zipkin Server默认会将追踪数据信息保存到内存，但这种方式不适合生产环境。Zipkin支持将追踪数据持久化到mysql数据库或elasticsearch中。

使用mysql实现数据持久化

1、创建mysql数据环境

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',
  UNIQUE KEY `trace_id_high_4` (`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',
  KEY `trace_id_high_5` (`trace_id_high`,`trace_id`,`span_id`) COMMENT 'for joining with zipkin_spans',
  KEY `trace_id_high_6` (`trace_id_high`,`trace_id`) COMMENT 'for getTraces/ByIds',
  KEY `endpoint_service_name_2` (`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames',
  KEY `a_type_2` (`a_type`) COMMENT 'for getTraces',
  KEY `a_key_2` (`a_key`) COMMENT 'for getTraces',
  KEY `trace_id_2` (`trace_id`,`span_id`,`a_key`) COMMENT 'for dependencies job'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

-- ----------------------------
-- Table structure for 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`),
  UNIQUE KEY `day_2` (`day`,`parent`,`child`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

-- ----------------------------
-- Table structure for 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',
  UNIQUE KEY `trace_id_high_4` (`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',
  KEY `trace_id_high_5` (`trace_id_high`,`trace_id`,`id`) COMMENT 'for joining with zipkin_annotations',
  KEY `trace_id_high_6` (`trace_id_high`,`trace_id`) COMMENT 'for getTracesByIds',
  KEY `name_2` (`name`) COMMENT 'for getTraces and getSpanNames',
  KEY `start_ts_2` (`start_ts`) COMMENT 'for getTraces ordering and range'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;
SET FOREIGN_KEY_CHECKS=1;

2、启动Zipkin Server

在启动Zipkin Server的时候，指定数据保存的mysql的信息

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=123456

参数参考链接：https://github.com/openzipkin/zipkin/blob/master/zipkin-server/src/main/resources/zipkin-server-shared.yml

3、演示

去访问http://127.0.0.1:7000/order/order2/1?token=123链接，查看数据库发现存在数据

在这里插入图片描述
停掉zinkin服务，重启查看网页数据，发现调用链接依然存在，持久化生效

在这里插入图片描述

使用elasticsearch实现数据持久化

1、下载

下载地址：https://www.elastic.co/cn/downloads/past-releases/elasticsearch-6-8-4 此处我选择的是windows版本。

修改config文件夹下的elasticsearch.yml，增加配置

http.cors.enabled: true
http.cors.allow-origin: "*"

2、启动

在这里插入图片描述

3、启动Zipkin Server

在启动Zipkin Server的时候，指定数据保存的elasticsearch的信息

java -jar zipkin-server-2.12.9-exec.jar --STORAGE_TYPE=elasticsearch --ES-HOST=localhost:9200

4、ES-head安装

为了清楚的查看es中的数据，我们需要安装一个es-head可视化工具。es5以上就需要安装node和grunt，所以安装head插件的前提，是需要把该两项配置好。此处不再赘述，有问题私聊阿Q即可。

①下载地址：https://github.com/mobz/elasticsearch-head，下载zip包，解压zip包。

②在dos窗口进入到head路径下，使用命令npm install 安装 pathomjs。

③使用命令npm start启用服务，出现如下截图，则说明服务启动成功。

在这里插入图片描述
④使用地址：localhost:9100 访问，出现如下截图，则说明head安装成功，默认端口是9100。

在这里插入图片描述

5、演示

去访问http://127.0.0.1:7000/order/order2/1?token=123链接，发现es的控制台有数据打印

在这里插入图片描述

我们去es-head中查看数据

在这里插入图片描述
停掉zinkin服务，重启查看网页数据，发现调用链接依然存在，持久化生效。

总结

到这儿，Sleuth +Zinkin 实现链路追踪并持久化的解决方案的内容就已经介绍完了。下一篇将为大家带来Rocketmq消息驱动的文章，敬请期待吧！

后续的文章，我们将继续完善我们的微服务系统，集成更多的Alibaba组件。想要了解更多JAVA后端知识，请点击文末名片与我交流吧。留下您的一键三连，让我们在这个寒冷的东西互相温暖吧！