服务链路追踪

一、简介

微服务架构是一个分布式架构，它按业务划分服务单元，一个分布式系统往往有很多个服务单元。由于服务单元数量众多，业务的复杂性，如果出现了错误和异常，很难去定位。主要体现在，一个请求可能需要调用很多个服务，而内部服务的调用复杂性，决定了问题难以定位。所以微服务架构中，必须实现分布式链路追踪，去跟进一个请求到底有哪些服务参与，参与的顺序又是怎样的，从而达到每个请求的步骤清晰可见，出了问题，很快定位。Spring Cloud Sleuth为Spring Cloud实现了分布式跟踪解决方案

二、相关术语

Spring Cloud Sleuth采用的是Google的开源项目Dapper的专业术语。

• Span：
  基本工作单元，发送一个远程调度任务 就会产生一个Span，Span是一个64位ID唯一标识的，Trace是用另一个64位ID唯一标识的，Span还有其他数据信息，比如摘要、时间戳事件、Span的ID、以及进度ID。
• Trace：
  一系列Span组成的一个树状结构。请求一个微服务系统的API接口，这个API接口，需要调用多个微服务，调用每个微服务都会产生一个新的Span，所有由这个请求产生的Span组成了这个Trace。
• Annotation：
  用来及时记录一个事件的，一些核心注解用来定义一个请求的开始和结束 。这些注解包括以下：

cs - Client Sent ：客户端发送一个请求，这个注解描述了这个Span的开始
sr - Server Received ：服务端获得请求并准备开始处理它，如果将其sr减去cs时间戳便可得到网络传输的时间。
ss - Server Sent （服务端发送响应）：该注解表明请求处理的完成(当请求返回客户端)，如果ss的时间戳减去sr时间戳，就可以得到服务器请求的时间。
cr - Client Received （客户端接收响应）：此时Span的结束，如果cr的时间戳减去cs时间戳便可以得到整个请求所消耗的时间。

三、工程准备

这里就不讲解eureka-server工程的搭建了。
下面我们搭建zipkin-server服务端，新建zipkin_server工程，注意引入zipkin的依赖

    io.zipkin.java
    zipkin-server



    io.zipkin.java
    zipkin-autoconfigure-ui

启动类加上@EnableZipkinServer，注解的作用是开启zipkin功能

@SpringBootApplication
@EnableEurekaClient
@EnableZipkinServer
public class ZipkinServerApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SpringcloudZipkinServerApplication.class, args);
    }
}

配置文件application.yml：

server:
  port: 9411
spring:
  application:
    name: zipkin-server
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

这样zipkin server端就搭建好了。

四、新建user_service

添加依赖

        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.cloud
            spring-cloud-starter-eureka
        
        
        
            org.springframework.cloud
            spring-cloud-starter-zipkin
        

启动类：

@SpringBootApplication
@EnableEurekaClient
public class UserServiceApplication {
 
    public static void main(String[] args) {
        SpringApplication.run(SpringcloudZipkinServerApplication.class, args);
    }
}

配置文件：

server:
  port: 8762
spring:
  application:
    name: user-service
  zipkin:
    base-url:  http://localhost:9411
  sleuth:
    sampler:
      percentage: 1.0
eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

然后随便暴露个接口出去

@RestController
@RequestMapping("/user")
public class UserController {

    @GetMapping("/hi")
    public String hi(){
        return "I'm test";
    }
}

五、构建gateway-service

新建一个工程作为服务网关，将请求转发到user-service，作为Zipkin客户端，需要将链路数据上传给Zipkin Server，同时它也作为Eureka Client。它在pom文件除了需要继承主Maven工程的 pom，还需引入的依赖如下：

        
            org.springframework.cloud
            spring-cloud-starter-eureka
        
        
            org.springframework.cloud
            spring-cloud-starter-zuul
        
        
            org.springframework.boot
            spring-boot-starter-web
        
        
            org.springframework.cloud
            spring-cloud-starter-zipkin
        

配置文件配置如下：

eureka:
  client:
    serviceUrl:
      defaultZone: http://localhost:8761/eureka/

server:
  port: 5000
spring:
  application:
    name: gateway-service
  sleuth:
    sampler:
      percentage: 1.0
  zipkin:
    base-url: http://localhost:9411

zuul:
  routes:
    api-a:
      path: /user-api/**
      serviceId: user-service

启动类加上@EnableEurekaClient注解开启Eureka Client，加上@EnableZuulProxy注解，开启Zuul代理功能。

@SpringBootApplication
@EnableZuulProxy
@EnableEurekaClient
public class GatewayServiceApplication {

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

为我们访问之前随便定义的接口，产生一条调用记录。

访问http://localhost:9411，这里就会展示Zipkin Server收集的链路数据