Question

在介绍各种概念与原理之前，我们先通过实现一个简单的示例，为存在服务调用的应用增加一些Sleuth的配置以实现基本的服务跟踪功能，以此来对Spring Cloud Sleuth有一个初步的了解，随后再逐步展开，介绍实现过程中的各个细节。

准备工作

在引入Sleuth之前，我们先按照之前章节学习的内容来做一些准备工作，构建一些基础的设施和应用。

- 服务注册中心：eureka-server，这里不做赘述，直接使用之前构建的工程即可。

- 微服务应用：trace-1，实现一个REST接口/trace-1，调用该接口后将触发对trace-2应用的调用。具体实现如下所述。

- 创建一个基础的Spring Boot应用，在pom.xml中增加下面的依赖：

<parent>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-parent</artifactId>

<version>1.3.7.RELEASE</version>

<relativePath/>

</parent>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

</dependency>

<dependency>

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-starter-eureka</artifactId>

</dependency>

<dependency>

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-starter-ribbon</artifactId>

</dependency>

<dependencyManagement>

<dependencies>

<dependency>

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-dependencies</artifactId>

<version>Brixton.SR5</version>

<type>pom</type>

<scope>import</scope>

</dependency>

</dependencies>

</dependencyManagement>

- 创建应用主类，实现/trace-1接口，并使用 RestTemplate 调用 trace-2应用的接口。具体如下：

@RestController

@EnableDiscoveryClient

@SpringBootApplication

public class TraceApplication {

private final Logger logger=Logger.getLogger（getClass（））;

@Bean

@LoadBalanced

RestTemplate restTemplate（）{

return new RestTemplate（）;

}

@RequestMapping（value="/trace-1",method=RequestMethod.GET）

public String trace（）{

logger.info（"===call trace-1==="）;

return restTemplate（）.getForEntity（"http://trace-2/trace-2",String.class）.getBody（）;

}

public static void main（String[]args）{

SpringApplication.run（TraceApplication.class,args）;

}

}

- 在application.properties中，将eureka.client.serviceUrl.defaultZone参数指向eureka-server的地址，具体如下：

spring.application.name=trace-1

server.port=9101

eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

- 微服务应用：trace-2，实现一个REST接口/trace-2，供trace-1调用。具体实现如下所示。

- 创建一个基础的Spring Boot应用，pom.xml中的依赖与trace-1相同。

- 创建应用主类，并实现/trace-2接口，具体实现如下：

@RestController

@EnableDiscoveryClient

@SpringBootApplication

public class TraceApplication {

private final Logger logger=Logger.getLogger（getClass（））;

@RequestMapping（value="/trace-2",method=RequestMethod.GET）

public String trace（）{

logger.info（"===<call trace-2>==="）;

return "Trace";

}

public static void main（String[]args）{

SpringApplication.run（TraceApplication.class,args）;

}

}

- 在application.properties中，将eureka.client.serviceUrl.defaultZone参数指向eureka-server的地址，另外还需要设置不同的应用名和端口号，具体如下：

spring.application.name=trace-2

server.port=9102

eureka.client.serviceUrl.defaultZone=http://localhost:1111/eureka/

在实现了上面的内容之后，我们可以将 eureka-server、trace-1、trace-2三个应用都启动起来，并通过 postman 或 curl 等工具来对 trace-1的接口发送请求http://localhost:9101/trace-1。可以得到返回值 Trace，同时还能在它们的控制台中分别获得下面的输出：

--trace-1

INFO 25272---[nio-9101-exec-2]ication$$EnhancerBySpringCGLIB$$36e12c68 :

===<call trace-1>===

--trace-2

INFO 7136---[nio-9102-exec-1]ication$$EnhancerBySpringCGLIB$$52a02f0b :===<call

trace-2>===

实现跟踪

在完成了准备工作之后，接下来我们开始进行本章的主题内容，为上面的 trace-1和trace-2添加服务跟踪功能。通过Spring Cloud Sleuth的封装，我们为应用增加服务跟踪能力的操作非常简单，只需在 trace-1和 trace-2的 pom.xml 依赖管理中增加spring-cloud-starter-sleuth依赖即可，具体如下：

<dependency>

<groupId>org.springframework.cloud</groupId>

<artifactId>spring-cloud-starter-sleuth</artifactId>

</dependency>

到这里，实际上我们已经为trace-1和trace-2实现服务跟踪做好了基础的准备，重启 trace-1和 trace-2，再对 trace-1的接口发送请求http://localhost:9101/trace-1。此时，我们可以从它们的控制台输出中窥探到Sleuth的一些端倪。

--trace-1

INFO[trace-1,f410ab57afd5c145,a9f2118fa2019684,false]25028---[nio-9101-exec-1]

ication$$EnhancerBySpringCGLIB$$d8228493 :===<call trace-1>===

--trace-2

INFO[trace-2,f410ab57afd5c145,e9a377dc2268bc29,false]23112---[nio-9102-exec-1]

ication$$EnhancerBySpringCGLIB$$e6cb4078 :===<call trace-2>===

从上面的控制台输出内容中，我们可以看到多了一些形如[trace-1,f410ab57afd5c145,a9f2118fa2019684,false]的日志信息，而这些元素正是实现分布式服务跟踪的重要组成部分，每个值的含义如下所述。

- 第一个值：trace-1，它记录了应用的名称，也就是application.properties中spring.application.name参数配置的属性。

- 第二个值：f410ab57afd5c145,Spring Cloud Sleuth生成的一个ID，称为Trace ID，它用来标识一条请求链路。一条请求链路中包含一个Trace ID，多个Span ID。

- 第三个值：a9f2118fa2019684,Spring Cloud Sleuth 生成的另外一个 ID，称为Span ID，它表示一个基本的工作单元，比如发送一个HTTP请求。

- 第四个值：false，表示是否要将该信息输出到Zipkin等服务中来收集和展示。

上面四个值中的Trace ID和Span ID是Spring Cloud Sleuth实现分布式服务跟踪的核心。在一次服务请求链路的调用过程中，会保持并传递同一个 Trace ID，从而将整个分布于不同微服务进程中的请求跟踪信息串联起来。以上面输出内容为例，trace-1和trace-2同属于一个前端服务请求来源，所以它们的Trace ID是相同的，处于同一条请求链路中。