spring cloud sleuth+zipkin 链路追踪入门及进阶使用

最新推荐文章于 2024-06-24 19:18:47 发布

卧虫凤鸟

最新推荐文章于 2024-06-24 19:18:47 发布

阅读量594

点赞数

分类专栏： Spring Cloud

本文链接：https://blog.csdn.net/weixin_43845422/article/details/112257929

版权

Spring Cloud 专栏收录该内容

15 篇文章 0 订阅

订阅专栏

文章目录

1.Spring cloud sleuth简介

Spring Cloud Sleuth为分布式跟踪提供了Spring Boot自动配置，是Spring Cloud实现分布式跟踪的解决方案。Sleuth大量借用Dapper，Zipkin和HTrace，通过拦截http请求，在服务调用的请求和响应中加入ID，标明上下游服务请求的关系。我们可以简单地在日志中捕获这些数据，也可以将数据发送到远程收集器服务如zipkin server。

2.为什么使用sleuth

在这里插入图片描述

微服务架构上通过业务来划分服务，对外暴露的一个接口，通过REST的方式进行调用。这个接口功能可能需要很多个微服务协同才能完成，如果链路上任何一个服务出现问题或者网络超时，都会导致接口调用失败。随着服务越来越多，对调用链的分析、定位系统故障的范围会越来越复杂。面对这些问题，Spring Cloud Sleuth提供了分布式服务跟踪解决方案。

3.sleuth 核心原理及作用

在这里插入图片描述

上图展示了sleuth工作的核心原理，通过拦截http请求，在请求request和响应response中对每个服务节点添加当前服务的名称、span id、parent id、开始时间戳、结束时间戳，并且一个请求链路共享一个全局trace id，实现了微服务链路追踪。

由此，得出sleuth的作用：

耗时分析：通过Sleuth可以很方便的了解到每个采样请求的耗时，从而分析出哪些服务调用比较耗时。
链路优化：对于调用比较频繁的服务，可以针对这些服务实施一些优化措施。

4.zipkin简介

Zipkin 是 Twitter 的开源分布式跟踪系统，分为客户端、服务端。客户端负责采集、上报链路追踪的时序数据，服务端负责收集、存储、UI展示这些时序数据。zipkin服务端会根据调用关系生成调用关系图，有助于开发者通过 Web 前端轻松地进行数据分析和跟踪。Zipkin服务端提供了多种数据存储方式，如：In-Memory、MQ、MySQL、Elasticsearch等，默认的存储方式是In-Memory即内存。

5.sleuth与zipkin的关系

sleuth的实现借鉴了zipkin 客户端，可以说spring cloud sleuth是对zipkin client的封装或者二次开发的升级版，并且spring cloud提供了 spring-cloud-sleuth-zipkin 来方便 sleuth 与 zipkin client进行集成。

6.spring cloud sleuth+zipkin 入门使用

示例整体架构图如下：

6.1 zipkin server 服务搭建

pom文件增加zipkin-server依赖

<modelVersion>4.0.0</modelVersion>
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.0.RELEASE</version>
    <relativePath/>
</parent>
<groupId>com.example</groupId>
<artifactId>zipkin-server-demo</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>zipkin-server-demo</name>
<description>Demo project for Spring Boot</description>

<properties>
    <java.version>1.8</java.version>
    <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring-cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <!--zipkin服务端依赖-->
    <dependency>
        <groupId>io.zipkin</groupId>
        <artifactId>zipkin-server</artifactId>
        <version>2.23.2</version>
    </dependency>

    <!--web依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!--注册中心客户端依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
    </dependency>
</dependencies>

bootstrap.yml 文件

spring:
  application:
    name: zipkin-server-demo
  profiles:
    active: dev
server:
  port: 3080
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8090/eureka/
  instance:
    lease-expiration-duration-in-seconds: 30
    lease-renewal-interval-in-seconds: 10
    prefer-ip-address: true
    instance-id: ${spring.cloud.client.ip-address}:${server.port}

application.properties 文件

# 自定义 zipkin server地址
armeria.ports[0].ip=127.0.0.1
armeria.ports[0].port=9800
armeria.ports[0].protocol=HTTP

Application启动文件增加 @EnableZipkinServer，启用zipkin server功能

@SpringBootApplication
@EnableDiscoveryClient
@EnableZipkinServer
public class ZipkinServerDemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(ZipkinServerDemoApplication.class, args);
    }

}

启动ZipkinServerDemo项目，使用浏览器访问 http://127.0.0.1:9800/zipkin

在这里插入图片描述

6.2 客户端增加sleuth相关配置

pom文件增加依赖

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

<!--sleuth整合zipkin客户端的依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-sleuth-zipkin</artifactId>
</dependency>

或者

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

application.properties 文件增加配置

# sleuth上报数据的采样比率，1代表100%上报
spring.sleuth.sampler.probability=1
# 指定上报数据的地址
spring.zipkin.base-url=http://localhost:9800/

6.3 启动各个微服务

分别启动 eureka-demo、configserver-demo、zipkin-server-demo、consumer-demo、provider-demo、gateway-demo服务，然后再通过postman发送请求。

在这里插入图片描述
再次访问 http://127.0.0.1:9800/zipkin

图一，链路跟踪痕迹列表展示
在这里插入图片描述
图二，链路追踪痕迹详情展示

基本概念解释：

Span是基本的工作单元，用一个64位ID来唯一标识，包括描述、时间戳、span parent id。
Trace Id也用一个64位的ID唯一标识，同一个请求中的所有Span都共享该ID。
Annotation 用于定义请求的开始和结束
CS：Client Sent客户端请求。这个annotion表示客户端发起请求，描述了span的开始。
SR：Server Received服务端接收。服务端获得请求并准备开始处理它，如果将其SR减去CS时间戳便可得到网络延迟。
SS：Server Sent服务端发送。表明请求处理的完成（当响应返回客户端），如果SS减去SR时间戳便可得到服务端处理请求所需的时间。
CR：Client Received客户端接收。Span的结束标识。客户端成功接收到服务端的响应，如果CR减去CS时间戳便可得到客户端发送请求到从服务端响应所需的总时间。

图三，服务调用依赖关系
在这里插入图片描述

7.spring cloud sleuth+zipkin 进阶使用

zipkin-server服务端收集数据后默认存储在内存中，当重新启动zipkin-server-demo项目后，之前各个客户端项目上传的链路追踪的数据会被清空。所以，此小节就是解决这个问题的。
在这里插入图片描述
示例整体架构图：

链路追踪的数据先上报到kafka，然后zipkin server使用collector收集器从kafka进行收集，通过存储器storage存储到Es搜索引擎里面，最后zipkin内置的UI层从Es里面加载链路追踪的数据呈现五彩缤纷的界面。

7.1 zipkin-server-demo项目修改

zipkin-server pom文件增加kafka收集器和es存储器依赖

<!--zipkin kafka 收集器-->
<dependency>
    <groupId>io.zipkin.zipkin2</groupId>
    <artifactId>zipkin-collector-kafka</artifactId>
    <version>2.23.2</version>
</dependency>

<!--zipkin es存储器-->
<dependency>
    <groupId>io.zipkin.zipkin2</groupId>
    <artifactId>zipkin-storage-elasticsearch</artifactId>
    <version>2.23.2</version>
</dependency>

zipkin-server properties文件增加收集器和存储器配置

# 自定义 zipkin server地址
armeria.ports[0].ip=127.0.0.1
armeria.ports[0].port=9800
armeria.ports[0].protocol=HTTP

# zipkin 收集器配置
zipkin.collector.kafka.bootstrap-servers=127.0.0.1:9092
zipkin.collector.kafka.topic=zipkin
zipkin.collector.kafka.groupId=zipkin

# zipkin 存储器配置
zipkin.storage.type=elasticsearch
zipkin.storage.elasticsearch.hosts=192.168.0.119:9201

7.2 sleuth各个客户端项目修改

分别修改provider-demo、consumer-demo、gateway-demo项目配置

pom文件增加kafka依赖

<dependency>
  <groupId>org.springframework.kafka</groupId>
   <artifactId>spring-kafka</artifactId>
   <version>2.6.4</version>
</dependency>

application.properties配置文件修改

# sleuth上报数据的采样比率
spring.sleuth.sampler.probability=1
# 指定上报数据的地址
# spring.zipkin.base-url=http://localhost:9800/

# 指定zipkin发送器为kafka
spring.zipkin.sender.type=kafka
# 指定存储sleuth上报数据的kafka主题
spring.zipkin.kafka.topic=zipkin
# 指定kafka的地址
spring.kafka.bootstrap-servers=127.0.0.1:9092

7.3 重新启动各个微服务

重新启动 zipkin-server-demo、provider-demo、consumer-demo、gateway-demo四个项目，通过postman再次发送请求。

在这里插入图片描述
图一，使用kafka消费zipkin主题的数据

图二，使用elasticsearch-head查看存储的链路数据

图三，zipkin-server UI层展示链路追踪的数据
至此，spring cloud 链路追踪入门及进阶使用分享完毕

卧虫凤鸟

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
3
评论
spring cloud sleuth+zipkin 链路追踪入门及进阶使用

文章目录1.Spring cloud sleuth简介2.为什么使用sleuth3.sleuth 核心原理及作用4.zipkin简介5.sleuth与zipkin的关系6.spring cloud sleuth+zipkin 入门使用6.1 zipkin server 服务搭建6.2 客户端增加sleuth相关配置6.3 启动各个微服务7.spring cloud sleuth+zipkin 进阶使用7.1 zipkin-server-demo项目修改7.2 sleuth各个客户端项目修改7.3 重新启动各
复制链接

扫一扫

专栏目录