Spring Cloud Sleuth--服务链路追踪组件配置与使用

目标：使用Spring Cloud Sleuth建立服务链路追踪中心

开发环境：IntelliJ IDEA

操作步骤：基础环境配置->使用zipkin组件建立服务追踪中心->使用Eureka/Zuul/Client构建服务注册/网关/API功能->应用启动测试->使用RabbitMQ传输链路数据->在ElasticSearch中存储链路数据->用Kibana展示链路数据

1.基础环境配置

与Eureka组件类似，新建一个项目Spring_Cloud_Sleuth，配置参考博客：

https://blog.csdn.net/xingyuzhe/article/details/79907748

2.使用zipkin组件建立服务链路追踪中心

微服务架构是一个分布式架构，微服务系统按业务划分服务单元，一个微服务系统往往有多个服务单元，由于服务单元数量众多，业务的复杂性较高，如果出现了错误和异常，难以定位。

工作流：一个请求可能需要调用很多个服务，而内部服务的调用复杂性决定了问题难以定位。

因此在微服务架构中需要实现分布式链路追踪，使得每个请求的步骤清晰可见。

例：用户请求->前端A(远程调用)->系统中间件(B/C)->后端服务D/E->处理完成后返回给用户。

常用的链路追踪组件：Google/Drapper，Twitter/Zipkin

Spring Cloud Sleuth组件的主要功能是在分布式系统中提供服务追踪的解决方案。

项目地址：https://github.com/spring-cloud/spring-cloud-sleuth

开发流程：

(1)新建Module工程-CaaS_Zipkin_Server

(2)添加配置依赖

启用eureka客户端：

添加zipkin组件：

(3)添加Module主程序

@EnableZipkinServer开启ZipkinServer的功能

(4)添加应用配置文件

3.使用Eureka/Zuul/Client构建服务注册/网关/API功能

(1)新建CaaS_Sleuth_User作为服务提供者

a.新建Module工程

b.添加配置依赖

添加zipkin组件支持，以及eureka客户端功能与web功能

c.新建项目主程序

只需添加@EnableEurekaClient注解开启服务注册功能

d.编写控制器SleuthUserController

e.新建应用配置文件

设置zipkinserver地址为9411，并设置以100%的概率将链路的数据上传给zipkinserver

(2)新建CaaS_Sleuth_Gateway作为服务网关

a.新建Module工程

b.添加配置依赖

与User类似，并增加zuul组件依赖：

c.编写项目主程序

d.编写应用配置文件

(3)使用CaaS_Eureka_Server作为服务注册中心

无需新建，直接使用原有Eureka编译的jar包即可。

4.应用启动测试

依次启动eureka server、zipkin server、user、gateway：

访问http://localhost:9411

多次发出调用请求：http://localhost:5000/user-api/user/hello

点击查找链路：

依赖分析：

5.使用RabbitMQ传输链路数据

首先需要在windows下安装RabbitMQ组件并设置用户名密码：

rabbitmq软件地址(包括Erlang与rabbitmq server)

http://www.erlang.org/downloads

https://www.rabbitmq.com/install-windows-manual.html

(1)安装Erlang

双击安装

配置环境变量：ERLANG_HOME并添加到Path变量中

cmd输入erl测试：

(2)安装RabbitMQ Server

解压安装包至myapps目录，配置环境变量：

安装rabbitmq服务：

进入sbin文件夹执行：rabbitmq-service install

启动rabbitmq-service服务：rabbitmq-service start

web ui扩展功能开启：rabbitmq-plugins enable rabbitmq_management

重启后配置生效：访问http://localhost:15672/

默认用户名密码均为guest：

(3)改造CaaS_Zipkin_Server微服务

a.修改配置依赖

删除原有zipkin-server的依赖，新增如下依赖：

b.修改项目主程序

新增注解@EnableZipkinStreamServer

c.修改应用配置文件

新增rabbitmq配置

(4)改造CaaS_Sleuth_User微服务

仅需删除spring-cloud-starter-zipkin依赖，并加上与server相同的依赖，同时在应用配置文件上加上rabbitmq配置信息即可。

(5)应用启动测试

依次运行eureka server -> zipkin server -> user ->gateway

多次请求后访问：http://localhost:15672/

6.在ElasticSearch中存储链路数据

首先需要安装ElasticSearch：https://www.elastic.co/products/elasticsearch

选择zip文件，解压到myapps中，进入bin文件夹下，双击elasticsearch.bat启动ES

访问http://localhost:9200/

修改zipkin server配置：添加ElasticSearch配置依赖

在应用的配置文件application.yml中加上es配置：

多次发出请求：访问http://localhost:9200/_search

可见数据已经存储进ElasticSearch数据库。

7.用Kibana展示数据

下载：https://www.elastic.co/downloads/kibana

配置：修改文件config/kibana.yml

server.port: 5601
server.host: "0.0.0.0"
elasticsearch.url: "http://localhost:9200"
elasticsearch.preserveHost: true
kibana.index: ".kibana"

启动：

运行kibana.bat

访问http://localhost:5601/