Spring Cloud 系列之 Sleuth 链路追踪（二）

2023-08-04 14:05:58

本篇文章为系列文章，未读第一集的同学请猛戳这里：Spring Cloud 系列之 Sleuth 链路追踪（一）

本篇文章讲解 Sleuth 基于 Zipkin 存储链路追踪数据至 MySQL，Elasticsearch 以及使用 MQ 存储链路追踪数据至 MySQL，Elasticsearch。

存储追踪数据

　　Zipkin Server 默认存储追踪数据至内存中，这种方式并不适合生产环境，一旦 Server 关闭重启或者服务崩溃，就会导致历史数据消失。Zipkin 支持修改存储策略使用其他存储组件，支持 MySQL，Elasticsearch 等。

MySQL

数据库脚本

　　打开 MySQL 数据库，创建 zipkin 库，执行以下 SQL 脚本。

　　官网地址：https://github.com/openzipkin/zipkin/blob/master/zipkin-storage/mysql-v1/src/main/resources/mysql.sql

--

-- Copyright 2015-2019 The OpenZipkin Authors

--

-- Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except

-- in compliance with the License. You may obtain a copy of the License at

--

-- http://www.apache.org/licenses/LICENSE-2.0

--

-- Unless required by applicable law or agreed to in writing, software distributed under the License

-- is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express

-- or implied. See the License for the specific language governing permissions and limitations under

-- the License.

--

CREATE TABLE IF NOT EXISTS zipkin_spans (

  `trace_id_high` BIGINT NOT NULL DEFAULT 0 COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',

  `trace_id` BIGINT NOT NULL,

  `id` BIGINT NOT NULL,

  `name` VARCHAR(255) NOT NULL,

  `remote_service_name` VARCHAR(255),

  `parent_id` BIGINT,

  `debug` BIT(1),

  `start_ts` BIGINT COMMENT 'Span.timestamp(): epoch micros used for endTs query and to implement TTL',

  `duration` BIGINT COMMENT 'Span.duration(): micros used for minDuration and maxDuration query',

  PRIMARY KEY (`trace_id_high`, `trace_id`, `id`)

) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

ALTER TABLE zipkin_spans ADD INDEX(`trace_id_high`, `trace_id`) COMMENT 'for getTracesByIds';

ALTER TABLE zipkin_spans ADD INDEX(`name`) COMMENT 'for getTraces and getSpanNames';

ALTER TABLE zipkin_spans ADD INDEX(`remote_service_name`) COMMENT 'for getTraces and getRemoteServiceNames';

ALTER TABLE zipkin_spans ADD INDEX(`start_ts`) COMMENT 'for getTraces ordering and range';

CREATE TABLE IF NOT EXISTS zipkin_annotations (

  `trace_id_high` BIGINT NOT NULL DEFAULT 0 COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',

  `trace_id` BIGINT NOT NULL COMMENT 'coincides with zipkin_spans.trace_id',

  `span_id` BIGINT 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 NOT NULL COMMENT 'BinaryAnnotation.type() or -1 if Annotation',

  `a_timestamp` BIGINT COMMENT 'Used to implement TTL; Annotation.timestamp or zipkin_spans.timestamp',

  `endpoint_ipv4` INT COMMENT 'Null when Binary/Annotation.endpoint is null',

  `endpoint_ipv6` BINARY(16) COMMENT 'Null when Binary/Annotation.endpoint is null, or no IPv6 address',

  `endpoint_port` SMALLINT COMMENT 'Null when Binary/Annotation.endpoint is null',

  `endpoint_service_name` VARCHAR(255) COMMENT 'Null when Binary/Annotation.endpoint is null'

) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

ALTER TABLE zipkin_annotations ADD UNIQUE KEY(`trace_id_high`, `trace_id`, `span_id`, `a_key`, `a_timestamp`) COMMENT 'Ignore insert on duplicate';

ALTER TABLE zipkin_annotations ADD INDEX(`trace_id_high`, `trace_id`, `span_id`) COMMENT 'for joining with zipkin_spans';

ALTER TABLE zipkin_annotations ADD INDEX(`trace_id_high`, `trace_id`) COMMENT 'for getTraces/ByIds';

ALTER TABLE zipkin_annotations ADD INDEX(`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames';

ALTER TABLE zipkin_annotations ADD INDEX(`a_type`) COMMENT 'for getTraces and autocomplete values';

ALTER TABLE zipkin_annotations ADD INDEX(`a_key`) COMMENT 'for getTraces and autocomplete values';

ALTER TABLE zipkin_annotations ADD INDEX(`trace_id`, `span_id`, `a_key`) COMMENT 'for dependencies job';

CREATE TABLE IF NOT EXISTS zipkin_dependencies (

  `day` DATE NOT NULL,

  `parent` VARCHAR(255) NOT NULL,

  `child` VARCHAR(255) NOT NULL,

  `call_count` BIGINT,

  `error_count` BIGINT,

  PRIMARY KEY (`day`, `parent`, `child`)

) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

部署 Zipkin 服务端

　　添加启动参数，重新部署服务端：

　　官网地址：https://github.com/openzipkin/zipkin/blob/master/zipkin-server/src/main/resources/zipkin-server-shared.yml

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

测试

　　访问：http://localhost:9000/order-service/order/1 查看数据库结果如下：

　　在 MySQL 模式下，每次启动服务端时，服务端会从数据库加载链路信息展示至 Web 界面。

RabbitMQ

　　点击链接观看：基于 MQ 并存储链路信息至 MySQL 视频（获取更多请关注公众号「哈喽沃德先生」）

　　之前的课程中我们已经学习过 RabbitMQ 的详细使用，这里不再过多赘述，直接开启使用即可。

启动 RabbitMQ 服务器

　　开启虚拟机，通过以下命令启动 RabbitMQ 服务端。

systemctl start rabbitmq-server.service

　　访问：http://192.168.10.101:15672/ 使用默认用户名和密码 guest

　　查看队列，此时无任何队列。

部署 Zipkin 服务端

　　添加启动参数，重新部署服务端：

　　官网地址：https://github.com/openzipkin/zipkin/blob/master/zipkin-server/src/main/resources/zipkin-server-shared.yml

java -jar zipkin-server-2.20.1-exec.jar --STORAGE_TYPE=mysql --MYSQL_HOST=localhost --MYSQL_TCP_PORT=3306 --MYSQL_USER=root --MYSQL_PASS=root --MYSQL_DB=zipkin --RABBIT_ADDRESSES=192.168.10.101:5672 --RABBIT_USER=guest --RABBIT_PASSWORD=guest --RABBIT_VIRTUAL_HOST=/ --RABBIT_QUEUE=zipkin

　　启动参数中包含 MySQL 和 RabbitMQ 的配置，实现基于 MQ 并存储链路信息至 MySQL，如下图：

查看队列

　　访问：http://192.168.10.101:15672/#/queues 可以看到已经创建好了 zipkin 队列。

客户端添加依赖

　　官网文档：https://cloud.spring.io/spring-cloud-static/spring-cloud-sleuth/2.2.1.RELEASE/reference/html/#sleuth-with-zipkin-over-rabbitmq-or-kafka

<!-- spring cloud zipkin 依赖 -->

<dependency>

    <groupId>org.springframework.cloud</groupId>

    <artifactId>spring-cloud-starter-zipkin</artifactId>

</dependency>

<!-- 消息队列通用依赖 -->

<dependency>

    <groupId>org.springframework.amqp</groupId>

    <artifactId>spring-rabbit</artifactId>

</dependency>

客户端配置文件

spring:

  zipkin:

    base-url: http://localhost:9411/ # 服务端地址

    sender:

      type: rabbit

    rabbitmq:

      queue: zipkin                  # 队列名称

  rabbitmq:

    host: 192.168.10.101             # 服务器 IP

    port: 5672                       # 服务器端口

    username: guest                  # 用户名

    password: guest                  # 密码

    virtual-host: /                  # 虚拟主机地址

    listener:

      direct:

        retry:

          enabled: true              # 是否开启发布重试

          max-attempts: 5            # 最大重试次数

          initial-interval: 5000     # 重试间隔时间（单位毫秒）

      simple:

        retry:

          enabled: true              # 是否开启消费者重试

          max-attempts: 5            # 最大重试次数

          initial-interval: 5000     # 重试间隔时间（单位毫秒）

  sleuth:

    sampler:

      probability: 1.0               # 收集数据百分比，默认 0.1（10%）

测试

　　先关闭 Zipkin 服务端，访问：http://localhost:9000/order-service/order/1 客户端已将链路追踪数据写入队列当中：

　　启动 Zipkin 服务端后，队列中消息被消费。

　　链路追踪数据被存储至 MySQL。

Elasticsearch

　　之前的课程中我们已经学习过 Elasticsearch 的详细使用，这里不再过多赘述，直接开启使用即可。

启动 Elasticsearch 集群

　　本文使用的 Elasticsearch 集群地址为：

192.168.10.101:9200
192.168.10.102:9200
192.168.10.103:9200

　　启动集群，访问：http://192.168.10.101:9200/_cluster/health?pretty 结果如下：

　　启动 head 插件，访问：http://192.168.10.101:9100/ 结果如下：

部署 Zipkin 服务端

　　添加启动参数，重新部署服务端：

　　官网地址：https://github.com/openzipkin/zipkin/blob/master/zipkin-server/src/main/resources/zipkin-server-shared.yml

java -jar zipkin-server-2.20.1-exec.jar --STORAGE_TYPE=elasticsearch --ES_HOSTS=http://192.168.10.101:9200/,http://192.168.10.102:9200/,http://192.168.10.103:9200/ --RABBIT_ADDRESSES=192.168.10.101:5672 --RABBIT_USER=guest --RABBIT_PASSWORD=guest --RABBIT_QUEUE=zipkin

　　启动参数中包含 Elasticsearch 和 RabbitMQ 的配置，实现基于 MQ 并存储链路信息至 Elasticsearch。

查看索引库

　　访问：http://192.168.10.101:9100 可以看到已经创建好了 zipkin 索引库。

客户端添加依赖

　　官网文档：https://cloud.spring.io/spring-cloud-static/spring-cloud-sleuth/2.2.1.RELEASE/reference/html/#sleuth-with-zipkin-over-rabbitmq-or-kafka

<!-- spring cloud zipkin 依赖 -->

<dependency>

    <groupId>org.springframework.cloud</groupId>

    <artifactId>spring-cloud-starter-zipkin</artifactId>

</dependency>

<!-- 消息队列通用依赖 -->

<dependency>

    <groupId>org.springframework.amqp</groupId>

    <artifactId>spring-rabbit</artifactId>

</dependency>

客户端配置文件

spring:

  zipkin:

    base-url: http://localhost:9411/ # 服务端地址

    sender:

      type: rabbit

    rabbitmq:

      queue: zipkin                  # 队列名称

  rabbitmq:

    host: 192.168.10.101             # 服务器 IP

    port: 5672                       # 服务器端口

    username: guest                  # 用户名

    password: guest                  # 密码

    virtual-host: /                  # 虚拟主机地址

    listener:

      direct:

        retry:

          enabled: true              # 是否开启发布重试

          max-attempts: 5            # 最大重试次数

          initial-interval: 5000     # 重试间隔时间（单位毫秒）

      simple:

        retry:

          enabled: true              # 是否开启消费者重试

          max-attempts: 5            # 最大重试次数

          initial-interval: 5000     # 重试间隔时间（单位毫秒）

  sleuth:

    sampler:

      probability: 1.0               # 收集数据百分比，默认 0.1（10%）

测试

　　访问：http://localhost:9000/order-service/order/1 查看索引库结果如下：

下一篇我们讲解 Sleuth 如何使用 Elasticsearch、Logstash、Kibana 分析追踪数据，记得关注噢～

　　本文采用 知识共享「署名-非商业性使用-禁止演绎 4.0 国际」许可协议。

　　大家可以通过 分类 查看更多关于 Spring Cloud 的文章。

码农公寓

存储追踪数据

MySQL

数据库脚本

部署 Zipkin 服务端

测试

RabbitMQ

启动 RabbitMQ 服务器

部署 Zipkin 服务端

查看队列

客户端添加依赖

客户端配置文件

测试

Elasticsearch

启动 Elasticsearch 集群

部署 Zipkin 服务端

查看索引库

客户端添加依赖

客户端配置文件

测试

相关文章