Zipkin介绍和使用

Posted 2023-05-15

参考技术A Zipkin是一个分布式链路跟踪系统，可以采集时序数据来协助定位延迟等相关问题。数据可以存储在cassandra,mysql,ES,mem中。分布式链路跟踪是个老话题，国内也有类似的框架，比如阿里的skywalking。 zipkin目前和SpringCloud生态结合紧密，有相关的支持。

主要包括客户端和一个管理服务端。在客户端采集数据后，发送给服务端，用来展示数据。在每个instrumented的客户端，写入了traceId，然后统一收集数据在服务端存储。这里instrumented翻译过来是仪器化，设备化，为了简单我把他称作 标识实体 ，代表一个接入了zipkin的客户端。

zipkin包括四个组件，collector，storage，search，webUI。其中collector中重点有两个

zipkin可以跟踪多种请求，如async方法,schedule,rxjava等，都在 org.springframework.cloud.sleuth.instrument 包下，这里以web请求做介绍。在SpringCloud下用sleuth来做跟踪处理。具体通过一个拦截器 org.springframework.cloud.sleuth.instrument.web.TraceHandlerInterceptor 实现，如下

zipkin支持mem，MySQL，ES存储方式，以 io.zipkin.java:zipkin-server:2.6.1 为例，可以通过配置实现。具体配置项可以在 zipkin-server-shared.yaml 中查看，如下：

同时，举例用MySQL作为存储时的一张span对象表，如下：

一般来说，分布式的链路跟踪数据是比较大量的，建议采用ES来存储，方便支持分区，以及后期的扩展等，比如使用某些字段来存储非结构化数据。

以上就是所有内容，下面是一个请求和记录展示。

使用zipkin做分布式链路监控

介绍

Zipkin 为一个分布式的调用链跟踪系统( distributed tracing system ) ,设计来源于 google dapper paper
官方网站 http://zipkin.io/
快速入门

安装方式一：使用zipkin官方提供的jar启动服务
zipkin官方提供了一个现成的使用springboot写的zipkin服务端，客户端的链路监控报告可以通过多种方式（下文会讲解具体的方式）向服务端发送报告。
系统需要安装java8
下载地址 https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin-server&v=LATEST&c=exec
配置详解

查看源码可知其有4种持久化方式，本文选择使用最熟悉的mysql持久化链路调用信息。

首先建立数据库：
默认情况下 zipkin 运行时数据保存在内存中，重启数据会丢失
数据库脚本下载 (https://github.com/openzipkin/zipkin/blob/master/zipkin-storage/mysql/src/main/resources/mysql.sql)

查看与mysql storage相关的配置

@ConfigurationProperties("zipkin.storage.mysql")
public class ZipkinMySQLStorageProperties implements Serializable { // for Spark jobs
private static final long serialVersionUID = 0L;

private String host = "localhost";
private int port = 3306;
private String username;
private String password;
private String db = "zipkin";
private int maxActive = 10;
private boolean useSsl;
...
}
所以，我们使用mysql作为持久化策略，启动服务端的脚本也就有了

java -server -jar zipkin-server-1.26.0-exec.jar --zipkin.storage.type=mysql --zipkin.storage.mysql.host=localhost --zipkin.storage.mysql.port=3306 --zipkin.storage.mysql.username=root --zipkin.storage.mysql.password=root --zipkin.storage.mysql.db=zipkin
安装方式二
springcloud官方按照传输方式分成了三种启动服务端的方式：Sleuth with Zipkin via HTTP，Sleuth with Zipkin via Spring Cloud Stream，Spring Cloud Sleuth Stream Zipkin Collector。只需要添加相应的依赖，之后配置相应的注解，如@EnableZipkinStreamServer即可。具体配置参考官方文档：
（http://cloud.spring.io/spring-cloud-static/spring-cloud-sleuth/1.2.1.RELEASE/#_adding_to_the_project）
项目中，我们使用第一种作为服务端的启动方式，使用mysql作为持久化方案

被监控项目配置

application.properties

spring:
zipkin:
#服务端地址
base-url: http://10.19.52.11:9411
#本项目服务名
service:
name: ${spring.application.name}
sleuth:
#监控开关
enabled: true
#采样率
sampler:
percentage: 1
springboot对zipkin的自动配置可以使得所有RequestMapping匹配到的endpoints得到监控，以及强化了restTemplate，对其加了一层拦截器，使得由他发起的http请求也同样被监控。

motan rpc调用监控

Motan通过filter的SPI扩展机制支持OpenTracing，可以支持任何实现了OpenTracing标准的trace实现。使用OpenTracing需要以下步骤。

1.引入filter-opentracing扩展

<dependency>
<groupId>com.weibo</groupId>
<artifactId>filter-opentracing</artifactId>
<version>release</version>
</dependency>
2.如果第三方trace工具声明了io.opentracing.Tracer的SPI扩展，直接引入第三方trace的jar包即可。如果第三方没有声明，则转第三步。

3.自定义一个TracerFactory实现TracerFactory接口，通过getTracer()来获取不同tracer实现。设置OpenTracingContext的tracerFactory为自定义的TracerFactory即可。

项目中的具体配置：

MotanConfig.java

@Bean(name = "motanServerBasicConfig")
public BasicServiceConfigBean baseServiceConfig(@Value("${spring.sleuth.enabled:false}") Boolean tracing
) {
BasicServiceConfigBean config = new BasicServiceConfigBean();
...
if(tracing){
config.setFilter("sleuth-tracing");
}
...
return config;
}

@Bean
SleuthTracingContext sleuthTracingContext(@Autowired(required = false) org.springframework.cloud.sleuth.Tracer tracer){
SleuthTracingContext context = new SleuthTracingContext();
context.setTracerFactory(new SleuthTracerFactory() {br/>@Override
public org.springframework.cloud.sleuth.Tracer getTracer() {
return tracer;
}
});

    return context;
}

数据查询

具体的服务就不列出来了，为了演示依赖关系，service1使用restTemplate调用了service2,service2调用了service3，service4。
还有一些现成的motan调用

find a trace
当应用正常启动后，可以通过 http://10.19.52.11:9411 查看管理端

项目已经成功被监控

Dependencies
motan依赖树：

http依赖树：

java架构、java高级开发、nginx、dubbo、java分布式架构、redis、jvm、多线程、java网络编程、netty、kafka、spring，Mybatis，高可用，高性能

需要学习资料和路线可以加Java高级交流群：( 725633148 ) 每晚8点高清在线直播与你分享java企业当下招聘人才需求，怎么学Java，和学习什么内容，相信你了解之后对你今后学习Java会有非常大的帮助