微服务中的Sleuth链路追踪技术

在大型系统的微服务架构中，一次请求往往需要涉及到多个服务，这些服务模块可能是不同的团队开发、可能使用不同的编程语言实现，横跨不同的数据中心，这就意味着这种架构形式也会存在一些问题。如何快速发现问题并判断故障影响范围，如何梳理服务依赖以及依赖的合理性，以及如何分析链路性能问题和实时容量规划将是一个问题。

因此在微服务项目中引入了分布式链路追踪解决这种问题，讲一次分布式请求还原成调用链路，进行日志记录，性能监控并将一次分布式请求的调用情况集中展示。比如各个服务节点上的耗时、请求具体到达哪台机器上，每个服务节点的请求状态等等。

常用的链路追踪技术有很多，比如cat、zipkin、pinpoint、skywalking、Sleuth等等。我们这里主要是使用Sleuth+Zipkin做链路追踪解决方案。

1. SpringBoot集成Sleuth

首先我们在微服务的父工程的pom文件中引入Sleuth的依赖

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

我们启动微服务后使用服务的调用，我们就可以观察到请求在微服务中的调用过程。如下所示，对于一个微服务调用的日志由4个部分组成。d5c297457472ecc9代表的是traceId。

 其中的service-order代表的是微服务的名称。

d5c297457472ecc9代表的是traceId，Trace是由一组Trace Id相同的Span串联形成的一个树状结构，为了实现请求跟踪，当请求到达分布式系统的 入口端点时，只需要服务跟踪框架为该请求创建一个唯一的标识（即TraceId），同时在分布式系 统内部流转的时候，框架始终保持传递该唯一值，直到整个请求的返回。那么我们就可以使用该唯 一标识将所有的请求串联起来，形成一条完整的请求链路。换句话说，TraceId就是代表的微服务的一个请求。

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

最后的一个boolean值代表的是否将链路的追踪结果输出到第三方平台，true代表的是输出到第三方平台，false代表不输出到第三方平台。我们这里设置true是为了接下来将Sleuth和Zipkin联合使用。

2. ZipKin组件的使用

Zipkin是Twitter的一个开源项目，它致力于收集服务的定时数据，以解决微服务架构中的延迟问题，包括数据的收集、存储、查找和展现。我们可以使用它来收集各个服务器上请求链路的跟踪数据，并通过它提供的REST API接口来辅助我 们查询跟踪数据以实现对分布式系统的监控程序，从而及时地发现系统中出现的延迟升高问题并找出系 统性能瓶颈的根源。 除了面向开发的 API 接口之外，它也提供了方便的UI组件来帮助我们直观的搜索跟踪信息和分析请 求链路明细，比如：可以查询某段时间内各用户请求的处理时间等。

2.1 SpringBoot集成ZipKin组件

首先我们需要下载ZipKin的jar包。

https://search.maven.org/remote_content?g=io.zipkin.java&a=zipkin&server&v=LATEST&c=exec

 然后我们通过下面的命令行启动ZipKin Server程序。然后就可以通过http://localhost:9411默认的9411端口访问ZipKin的server端。

java -jar zipkin-server-2.12.9-exec.jar

此时zipkin的服务器端已经启动起来了，我们还需要在每个微服务上引入ZipKin的依赖才能通过UI界面观察到我们后端的请求经历的微服务。

首先我们在需要观察的微服务的pom.xml文件中引入ZipKin的依赖。

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

 然后我们在application中添加ZipKin的配置。

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

我们访问微服务的请求，在前端UI界面就可以看到该请求的耗时，如下图所示：

 进入第一个链路，我们可以看到该请求先是经历了service-order微服务，访问该服务的http请求为get，URL为/order/prod/{pid}。

然后该请求又经历了service-product微服务，访问该服务的http请求为get，请求的URL为/product/select。

 2.2 ZipKin的数据持久化的操作

ZipKin Server默认会将追踪数据信息保存到内存中，但是这种方式并不适合生产环境，ZipKin也将追踪数据持久化到Mysql数据库中。

首先我们需要在Mysql数据库中创建适合存储ZipKin数据的表，具体的代码如下所示：

    CREATE TABLE IF NOT EXISTS zipkin_spans (
        `trace_id_high` BIGINT NOT NULL DEFAULT 0 COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
        `trace_id` BIGINT NOT NULL,
        `id` BIGINT NOT NULL,
        `name` VARCHAR(255) NOT NULL,
        `parent_id` BIGINT,
        `debug` BIT(1),
        `start_ts` BIGINT COMMENT 'Span.timestamp(): epoch micros used for endTs query and to implement TTL',
        `duration` BIGINT COMMENT 'Span.duration(): micros used for minDuration and maxDuration query'
    ) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

    ALTER TABLE zipkin_spans ADD UNIQUE KEY(`trace_id_high`, `trace_id`, `id`) COMMENT 'ignore insert on duplicate';
    ALTER TABLE zipkin_spans ADD INDEX(`trace_id_high`, `trace_id`, `id`) COMMENT 'for joining with zipkin_annotations';
    ALTER TABLE zipkin_spans ADD INDEX(`trace_id_high`, `trace_id`) COMMENT 'for getTracesByIds';
    ALTER TABLE zipkin_spans ADD INDEX(`name`) COMMENT 'for getTraces and getSpanNames';
    ALTER TABLE zipkin_spans ADD INDEX(`start_ts`) COMMENT 'for getTraces ordering and range';

    CREATE TABLE IF NOT EXISTS zipkin_annotations (
        `trace_id_high` BIGINT NOT NULL DEFAULT 0 COMMENT 'If non zero, this means the trace uses 128 bit traceIds instead of 64 bit',
        `trace_id` BIGINT NOT NULL COMMENT 'coincides with zipkin_spans.trace_id',
        `span_id` BIGINT 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 NOT NULL COMMENT 'BinaryAnnotation.type() or -1 if Annotation',
        `a_timestamp` BIGINT COMMENT 'Used to implement TTL; Annotation.timestamp or zipkin_spans.timestamp',
        `endpoint_ipv4` INT COMMENT 'Null when Binary/Annotation.endpoint is null',
        `endpoint_ipv6` BINARY(16) COMMENT 'Null when Binary/Annotation.endpoint is null, or no IPv6 address',
        `endpoint_port` SMALLINT COMMENT 'Null when Binary/Annotation.endpoint is null',
        `endpoint_service_name` VARCHAR(255) COMMENT 'Null when Binary/Annotation.endpoint is null'
    ) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

    ALTER TABLE zipkin_annotations ADD UNIQUE KEY(`trace_id_high`, `trace_id`,`span_id`, `a_key`, `a_timestamp`) COMMENT 'Ignore insert on duplicate';
    ALTER TABLE zipkin_annotations ADD INDEX(`trace_id_high`, `trace_id`,`span_id`) COMMENT 'for joining with zipkin_spans';
    ALTER TABLE zipkin_annotations ADD INDEX(`trace_id_high`, `trace_id`) COMMENT 'for getTraces/ByIds';
    ALTER TABLE zipkin_annotations ADD INDEX(`endpoint_service_name`) COMMENT 'for getTraces and getServiceNames';

    ALTER TABLE zipkin_annotations ADD INDEX(`a_type`) COMMENT 'for getTraces';
    ALTER TABLE zipkin_annotations ADD INDEX(`a_key`) COMMENT 'for getTraces';
    ALTER TABLE zipkin_annotations ADD INDEX(`trace_id`, `span_id`, `a_key`) COMMENT 'for dependencies job';
    CREATE TABLE IF NOT EXISTS zipkin_dependencies (
        `day` DATE NOT NULL,
        `parent` VARCHAR(255) NOT NULL,
        `child` VARCHAR(255) NOT NULL,
        `call_count` BIGINT
    ) ENGINE=InnoDB ROW_FORMAT=COMPRESSED CHARACTER SET=utf8 COLLATE utf8_general_ci;

    ALTER TABLE zipkin_dependencies ADD UNIQUE KEY(`day`, `parent`, `child`);

然后我们在启动ZipKin Server的时候，指定数据保存的mysql的信息即可。

java -jar zipkin-server-2.12.9-exec.jar --STORAGE_TYPE=mysql -- MYSQL_HOST=127.0.0.1 --MYSQL_TCP_PORT=3306 --MYSQL_DB=zipkin --MYSQL_USER=root - -MYSQL_PASS=root