链路追踪sleuth and zipkin

1/ sleuth 入门

（1）修改微服务工程引入Sleuth依赖

       

            org.springframework.cloud

            spring-cloud-starter-sleuth

       

（2） 修改配置文件 

修改application.yml添加日志级别

logging:

  level:

    root: info

    org.springframework.web.servlet.DispatcherServlet: DEBUG

    org.springframework.cloud.sleuth: DEBUG

sleuth日志配置

从网关到每个微服务都需要添加如上的配置。启动微服务，调用之后，我们可以在控制台观察到sleuth的日志输 出。

sleuth日志打印

其中 ff8ff8b803a3b558 是TraceId(我理解的是从网关开始创建的一个总id)，后面跟着的是SpanId(每条日志都要记录调用链上一个微服务的spanid)，依次调用有一个全局的TraceId，将调用链 路串起来。仔细分析每个微服务的日志，不难看出请求的具体过程。

查看日志文件并不是一个很好的方法，当微服务越来越多日志文件也会越来越多，通过Zipkin可以将日 志聚合，并进行可视化展示和全文检索。

2、加入zipkin

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

Zipkin 分为两端，一个是 Zipkin 服务端，一个是 Zipkin 客户端，客户端也就是微服务的应用。 客户端会配置服务端的 URL 地址，一旦发生服务间的调用的时候，会被配置在微服务里面的 Sleuth 的 监听器监听，并生成相应的 Trace 和 Span 信息发送给服务端。 发送的方式主要有两种，一种是 HTTP 报文的方式，还有一种是消息总线的方式如 RabbitMQ。

不论哪种方式，我们都需要：

一个 Eureka 服务注册中心，这里我们就用之前的 eureka 项目来当注册中心。 一个 Zipkin 服务端。 多个微服务，这些微服务中配置Zipkin 客户端。

（1） Zipkin Server下载，可以从以下链接下载 https://repo1.maven.org/maven2/io/zipkin/java/zipkin-server/，我们这里下载的是 zipkin-server-2.12.9-exec.jar

（2） 启动 在命令行输入 java -jar zipkin-server-2.12.9-exec.jar 启动 Zipkin Server

启动zipkin服务端

默认Zipkin Server的请求端口为 9411 

Zipkin Server的启动参数可以通过官方提供的yml配置文件查找https://github.com/openzipkin/zipkin/blob/master/zipkin-server/src/main/resources/zipkin-server-shared.yml
 在浏览器输入 http://127.0.0.1:9411即可进入到Zipkin Server的管理后

 客户端Zipkin+Sleuth整合 

（1）客户端添加依赖

客户端指的是需要被追踪的微服务

       

            org.springframework.cloud

            spring-cloud-starter-sleuth

       

       

       

            org.springframework.cloud

            spring-cloud-starter-zipkin

       

       

            org.springframework.cloud

            spring-cloud-sleuth-zipkin

       

（2）修改客户端配置文件

web方式日志信息目前存memery里

指定了zipkin server的地址，下面制定需采样的百分比，默认为0.1，即10%，这里配置1，是记录全部 的sleuth信息，是为了收集到更多的数据（仅供测试用）。在分布式系统中，过于频繁的采样会影响系 统性能，所以这里配置需要采用一个合适的值

（3） 测试

启动每个微服务，启动Zipkin Service。通过浏览器发送一次微服务请求。打开 Zipkin Service 控制台http://127.0.0.1:9411，我们可以根据条件追踪每次请求调用过程

基于消息中间件日志收集数据，举例RabbitMq

(1) rabbitmq 安装和启动先准备好。

（2）zipkin 服务端启动

java -jar zipkin-server-2.12.9-exec.jar --RABBIT_ADDRESSES=127.0.0.1:5672
 --RABBIT_USER:guest  --RABBIT_PASSWORD=guest

RABBIT_ADDRESSES ： 指定RabbitMQ地址
RABBIT_USER： 用户名（默认guest）
RABBIT_PASSWORD ： 密码（默认guest

官网提供的rabbitmq可配置启动参数

rabbitmq 队列界面

（3）微服务中的配置

【3.1】引入依赖：

四个依赖

       

            org.springframework.cloud

            spring-cloud-starter-sleuth

       

       

       

            org.springframework.cloud

            spring-cloud-starter-zipkin

       

       

            org.springframework.cloud

            spring-cloud-sleuth-zipkin

       

       

            org.springframework.amqp

            spring-rabbit

       

【3.2】yml配置文件中的更改

加入rabbitmq

【3.3】测试

关闭Zipkin Server，并随意请求连接。打开rabbitmq管理后台可以看到，消息已经推送到rabbitmq。 当Zipkin Server启动时，会自动的从rabbitmq获取消息并消费，展示追踪数据

可以看到如下效果：

请求的耗时时间不会出现突然耗时特长的情况 当ZipkinServer不可用时（比如关闭、网络不通等），追踪信息不会丢失，因为这些信息会保存在 Rabbitmq服务器上，直到Zipkin服务器可用时，再从Rabbitmq中取出这段时间的信息

存储跟踪数据到mysql

Zipkin Server默认时间追踪数据信息保存到内存，这种方式不适合生产环境。Zipkin支持将追踪数据持久化到mysql数据库或者存储到 elasticsearch中。这里已mysql为例。

1、准备数据库

可以从官网找到Zipkin Server持久mysql的数据库脚本

/*

SQLyog Ultimate v11.33 (64 bit)

MySQL - 5.5.58 : Database - zipkin

*********************************************************************

*/

/*!40101 SET NAMES utf8 */;

/*!40101 SET SQL_MODE=''*/;

/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;

/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;

/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;

/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;

CREATE DATABASE /*!32312 IF NOT EXISTS*/`zipkin` /*!40100 DEFAULT CHARACTER SET utf8 */;

USE `zipkin`;

/*Table structure for table `zipkin_annotations` */

DROP TABLE IF EXISTS `zipkin_annotations`;

CREATE TABLE `zipkin_annotations` (

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

  `trace_id` bigint(20) NOT NULL COMMENT 'coincides with zipkin_spans.trace_id',

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

  `a_timestamp` bigint(20) DEFAULT NULL COMMENT 'Used to implement TTL; Annotation.timestamp or zipkin_spans.timestamp',

  `endpoint_ipv4` int(11) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',

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

  `endpoint_port` smallint(6) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',

  `endpoint_service_name` varchar(255) DEFAULT NULL COMMENT 'Null when Binary/Annotation.endpoint is null',

  UNIQUE KEY `trace_id_high` (`trace_id_high`,`trace_id`,`span_id`,`a_key`,`a_timestamp`) COMMENT 'Ignore insert on duplicate',

  KEY `trace_id_high_2` (`trace_id_high`,`trace_id`,`span_id`) COMMENT 'for joining with zipkin_spans',

  KEY `trace_id_high_3` (`trace_id_high`,`trace_id`) COMMENT 'for getTraces/ByIds',

  KEY `endpoint_service_name` (`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames',

  KEY `a_type` (`a_type`) COMMENT 'for getTraces',

  KEY `a_key` (`a_key`) COMMENT 'for getTraces',

  KEY `trace_id` (`trace_id`,`span_id`,`a_key`) COMMENT 'for dependencies job'

) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

/*Data for the table `zipkin_annotations` */

/*Table structure for table `zipkin_dependencies` */

DROP TABLE IF EXISTS `zipkin_dependencies`;

CREATE TABLE `zipkin_dependencies` (

  `day` date NOT NULL,

  `parent` varchar(255) NOT NULL,

  `child` varchar(255) NOT NULL,

  `call_count` bigint(20) DEFAULT NULL,

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

) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

/*Data for the table `zipkin_dependencies` */

/*Table structure for table `zipkin_spans` */

DROP TABLE IF EXISTS `zipkin_spans`;

CREATE TABLE `zipkin_spans` (

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

  `trace_id` bigint(20) NOT NULL,

  `id` bigint(20) NOT NULL,

  `name` varchar(255) NOT NULL,

  `parent_id` bigint(20) DEFAULT NULL,

  `debug` bit(1) DEFAULT NULL,

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

  `duration` bigint(20) DEFAULT NULL COMMENT 'Span.duration(): micros used for minDuration and maxDuration query',

  UNIQUE KEY `trace_id_high` (`trace_id_high`,`trace_id`,`id`) COMMENT 'ignore insert on duplicate',

  KEY `trace_id_high_2` (`trace_id_high`,`trace_id`,`id`) COMMENT 'for joining with zipkin_annotations',

  KEY `trace_id_high_3` (`trace_id_high`,`trace_id`) COMMENT 'for getTracesByIds',

  KEY `name` (`name`) COMMENT 'for getTraces and getSpanNames',

  KEY `start_ts` (`start_ts`) COMMENT 'for getTraces ordering and range'

) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=COMPRESSED;

/*Data for the table `zipkin_spans` */

/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;

/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;

/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;

/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;

mysql tabel part 1

mysql tabel part 2

2/ 配置启动服务端

zipkin mysql 参数启动

官网关于mysql的参数

storage 方式选择

存到mysql 与默认内存方式比较，只是数据库里增加了表，zipkin服务端启动增加了mysql 参数，微服务里添加mysql 驱动， 配置文件加入 mysql 数据源配置。

可以同时配置rabbitmq 和mysql 启动参数。