Nepxion Discovery学习笔记9 链路追踪(Sleuth+Zipkin)

分布式链路追踪（Distributed Tracing）

就是将一次分布式请求还原成调用链路，进行日志记录，性能监控并将一次分布式请求的调用情况集中展示。

比如各个服务节点上的耗时、请求具体到达哪台机器上、每个服务节点的请求状态等等。

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

cat

由大众点评开源，基于Java开发的实时应用监控平台，包括实时应用监控，业务监控 。 集成 方案是通过代码埋点的方式来实现监控，比如： 拦截器，过滤器等。 对代码的侵入性很大，集成 成本较高。风险较大。

pinpoint

Pinpoint是韩国人开源的基于字节码注入的调用链分析，以及应用监控分析工具。特点 是支持多种插件，UI功能强大，接入端无代码侵入。

skywalking

SkyWalking是本土开源的基于字节码注入的调用链分析，以及应用监控分析工具。特点是支持多 种插件，UI功能较强，接入端无代码侵入。目前已加入Apache孵化器。

Sleuth(主要)

SpringCloud 提供的分布式系统中链路追踪解决方案。

zipkin (主要)

由Twitter公司开源，开放源代码分布式的跟踪系统，用于收集服务的定时数据，以解决微 服务架构中的延迟问题，包括：数据的收集、存储、查找和展现。

该产品结合spring-cloud-sleuth 使用较为简单， 集成很方便， 但是功能较简单。

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

---

Sleuth

SpringCloud Sleuth主要功能就是在分布式系统中提供追踪解决方案。

1.Span (基本工作单元)

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

2.Trace (Span的树状集合)

由一组Trace Id相同的Span串联形成一个树状结构。为了实现请求跟踪，当请求到达分布式系统的 入口端点时，只需要服务跟踪框架为该请求创建一个唯一的标识（即TraceId），同时在分布式系

统内部流转的时候，框架始终保持传递该唯一值，直到整个请求的返回。那么我们就可以使用该唯 一标识将所有的请求串联起来，形成一条完整的请求链路。

3.Annotation(事件单元)

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

cs（Client Send）客户端发出请求，开始一个请求的生命周期

sr（Server Received）服务端接受到请求开始进行处理， sr－cs = 网络延迟（服务调用的时间）

ss（Server Send）服务端处理完毕准备发送到客户端，ss - sr = 服务器上的请求处理时间

cr（Client Reveived）客户端接受到服务端的响应，请求结束。 cr - sr = 请求的总时间

在gateway网关微服务中移入依赖:

        <!--Sleuth:形成链路追踪信息-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-sleuth</artifactId>
        </dependency>

测试接口,可以在控制台看见接口调用的链路信息,四个属性分别表示:[微服务名称, traceId, spanid,是否将链路的追踪结果输出到第三方平台]

---

Zipkin

要知道为什么会用到Zipkin?

Sleuth可以实现链路追踪,并将信息存在每个微服务的日志中,当一个个查看日志并不方便,同时日志文件越来越多,也不方便查看.

而Zipkin可以将日志聚合，并进行可视化展示和全文检索。

 

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

作用:

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

2.它提供了UI组件可以帮助我们直观的搜索跟踪信息和分析请 求链路明细，比如：可以查询某段时间内各用户请求的处理时间等。

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

 

Zipkin 的基础架构:

1.Collector：收集器组件，它主要用于处理从外部系统发送过来的跟踪信息，将这些信息转换为 Zipkin内部处理的 Span 格式，以支持后续的存储、分析、展示等功能。

2.Storage：存储组件，它主要对处理收集器接收到的跟踪信息，默认会将这些信息存储在内存中， 我们也可以修改存储策略，通过使用其他存储组件将跟踪信息存储到数据库中。

3.RESTful API：API 组件，它主要用来提供外部访问接口。比如给客户端展示跟踪信息，或是外接系统访问以实现监控等。

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

 

Zipkin CS:

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

听，并生成相应的 Trace 和 Span 信息发送给服务端。

 

 

ZipKin服务端安装

https://dl.bintray.com/openzipkin/maven/io/zipkin/java/zipkin-server/

下载2.12.9版本,并用cmd命令窗口启动

java -jar zipkin-server-2.12.9-exec.jar --logging.level.zipkin2=INFO

logging的默认级别就是INFO(所以也可以不设置)

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

 

Zipkin客户端集成

在每个微服务上添加依赖(必须保证接口调用链中的服务都导入了zipkin依赖,否则最终的链路中会识别不到对应的微服务):

        <!--zipkin:链路追踪信息的收集、存储、查找和展现,常和Sleuth一起使用-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-zipkin</artifactId>
        </dependency>

配置文件:

spring:
  zipkin:
    base-url: http://127.0.0.1:9411/ #zipkin 服务端的地址
    discoveryClientEnabled: false #让nacos把它当成一个URL，而不要当做服务名
  sleuth:
    sampler:
      probability: 1.0 #采样的百分比

测试接口:

去到zipkin服务端(http://127.0.0.1:9411/zipkin/)点击查找按钮

查找到3个链路追踪日志,选一个看看:

可以看到链路追踪信息:

 

ZipKin数据持久化

仅仅是查询到链路追踪是不行的,因为此时数据是存储在内存中的,一旦服务重启就会消失;因此需要实现数据的持久化.

持久化的方式有很多种:In-Memory、MySql、Cassandra 以及 Elasticsearch。

这里主要介绍我认为最简单也是最方便的方式: Elasticsearch.

新建module模块(shop-zipkin),并导入关键依赖 zipkin-autoconfigure-ui 和 zipkin-server :

        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
            <version>2.12.9</version>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
            <version>2.12.9</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

配置文件:(记得配置nacos,否则会报错:java.lang.IllegalArgumentException: no server available)

server:
  port: 9411
spring:
  application:
    name: service-zipkin
  cloud:
    nacos: #nacos的作用就是一个注册中心
      discovery:
        server-addr: 127.0.0.1:8848

记得导入 spring-boot-starter-web 依赖,否则会报错:

Caused by: org.springframework.context.ApplicationContextException: Unable to start ServletWebServerApplicationContext due to missing ServletWebServerFactory bean.
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.getWebServerFactory(ServletWebServerApplicationContext.java:206) ~[spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.createWebServer(ServletWebServerApplicationContext.java:180) ~[spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
	at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.onRefresh(ServletWebServerApplicationContext.java:154) ~[spring-boot-2.1.3.RELEASE.jar:2.1.3.RELEASE]
	... 8 common frames omitted

然后就会看见启动成功了:但是会有红字警告:

这是因为:SLF4J绑定了多个实现的日志框架，虽然不影响项目启动，但作为强迫症还是选择将pom文件中将zipkin-server绑定的log4j移除,修改后的依赖为:

        <!--nacos客户端,引入依赖即可自动注册微服务-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery
            </artifactId>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
            <version>2.12.9</version>
            <exclusions>
                <exclusion>
                    <artifactId>log4j-slf4j-impl</artifactId>
                    <groupId>org.apache.logging.log4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
            <version>2.12.9</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

然后启动又报错,如下:

Caused by: java.lang.NullPointerException: null
	at zipkin2.autoconfigure.ui.ZipkinUiAutoConfiguration.lambda$uiServerConfigurator$0(ZipkinUiAutoConfiguration.java:179) ~[zipkin-autoconfigure-ui-2.12.9.jar:na]
	at com.linecorp.armeria.spring.ArmeriaAutoConfiguration.lambda$armeriaServer$0(ArmeriaAutoConfiguration.java:111) ~[armeria-spring-boot-autoconfigure-0.83.0.jar:na]
	at java.util.ArrayList.forEach(ArrayList.java:1257) ~[na:1.8.0_211]
	at com.linecorp.armeria.spring.ArmeriaAutoConfiguration.lambda$armeriaServer$1(ArmeriaAutoConfiguration.java:110) ~[armeria-spring-boot-autoconfigure-0.83.0.jar:na]
	at java.util.Optional.ifPresent(Optional.java:159) ~[na:1.8.0_211]
	at com.linecorp.armeria.spring.ArmeriaAutoConfiguration.armeriaServer(ArmeriaAutoConfiguration.java:109) ~[armeria-spring-boot-autoconfigure-0.83.0.jar:na]
	at com.linecorp.armeria.spring.ArmeriaAutoConfiguration$$EnhancerBySpringCGLIB$$167b7a26.CGLIB$armeriaServer$0(<generated>) ~[armeria-spring-boot-autoconfigure-0.83.0.jar:na]
	at com.linecorp.armeria.spring.ArmeriaAutoConfiguration$$EnhancerBySpringCGLIB$$167b7a26$$FastClassBySpringCGLIB$$641124e0.invoke(<generated>) ~[armeria-spring-boot-autoconfigure-0.83.0.jar:na]
	at org.springframework.cglib.proxy.MethodProxy.invokeSuper(MethodProxy.java:244) ~[spring-core-5.1.5.RELEASE.jar:5.1.5.RELEASE]
	at org.springframework.context.annotation.ConfigurationClassEnhancer$BeanMethodInterceptor.intercept(ConfigurationClassEnhancer.java:363) ~[spring-context-5.1.5.RELEASE.jar:5.1.5.RELEASE]
	at com.linecorp.armeria.spring.ArmeriaAutoConfiguration$$EnhancerBySpringCGLIB$$167b7a26.armeriaServer(<generated>) ~[armeria-spring-boot-autoconfigure-0.83.0.jar:na]
	at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) ~[na:1.8.0_211]
	at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) ~[na:1.8.0_211]
	at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) ~[na:1.8.0_211]
	at java.lang.reflect.Method.invoke(Method.java:498) ~[na:1.8.0_211]
	at org.springframework.beans.factory.support.SimpleInstantiationStrategy.instantiate(SimpleInstantiationStrategy.java:154) ~[spring-beans-5.1.5.RELEASE.jar:5.1.5.RELEASE]
	... 20 common frames omitted

这是因为从 2.12.6 版本开始有个较大的更新，迁移使用 Armeria HTTP 引擎。从此版本开始，若直接添加依赖的 Spring Boot 应用启动会存在冲突。所以改为2.12.3版本(其他版本会出问题):

        <!--nacos客户端-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery
            </artifactId>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-server</artifactId>
            <version>2.12.3</version>
            <exclusions>
                <exclusion>
                    <artifactId>log4j-slf4j-impl</artifactId>
                    <groupId>org.apache.logging.log4j</groupId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>io.zipkin.java</groupId>
            <artifactId>zipkin-autoconfigure-ui</artifactId>
            <version>2.12.3</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

启动成功,访问http://127.0.0.1:9411/却报错:

修改配置文件(加入关闭自动检测所有请求的配置):

server:
  port: 9411
spring:
  application:
    name: service-zipkin
  cloud:
    nacos: #nacos的作用就是一个注册中心
      discovery:
        server-addr: 127.0.0.1:8848
management:
  metrics:
    web:
      server:
        auto-time-requests: false # 关闭自动检测所有请求

访问http://127.0.0.1:9411,注意如果设置为其他端口的话,似乎只能检测到当前微服务,而不能检测到其他微服务,这个应该是zipkin后端服务器的地址映射有关系: