Sleuth简介

Sleuth是Spring Cloud的组件之一，它为Spring Cloud实现了一种分布式追踪解决方案，兼容Zipkin，HTrace和其他基于日志的追踪系统，例如 ELK（Elasticsearch 、Logstash、 Kibana）。

使用Sleuth

为了确保你的应用名称能够在Zipkin中正确显示，你需要先在Springboot的核心配置文件中对spring.application.name 属性进行配置。

引入依赖

如果你只想使用SpringCloud Sleuth 而不想与 Zipkin 做集成，引入如下依赖：

 <dependencies><!-- Sleuth 依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-sleuth</artifactId></dependency></dependencies><dependencyManagement><dependencies><!-- SpringCloud 版本控制依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${spring-cloud.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>

如果你想通过 HTTP 将 SpringCloud Sleuth 与 Zipkin做集成，引入如下依赖：

 <dependencies><!-- Zipkin 依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-zipkin</artifactId></dependency></dependencies><dependencyManagement><dependencies><!-- SpringCloud 版本控制依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${spring-cloud.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>

如果你想使用RabbitMQ 或者Kafka 替代 HTTP ，需先引入 spring-rabbit 或者 spring-kafka 依赖。默认的目标名称是 zipkin 。如果你使用的是Kafka ，必须设置相应的 spring.zipkin.sender.type 属性：

spring.zipkin.sender.type: kafka

注意：spring-cloud-sleuth-stream已经过期并且和这些目标不兼容。

如果你使用的是RabbitMQ，需要添加 spring-cloud-starter-zipkin 和 spring-rabbit 依赖。

 <dependencyManagement><dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${release.train.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-zipkin</artifactId></dependency><dependency><groupId>org.springframework.amqp</groupId><artifactId>spring-rabbit</artifactId></dependency>

为了示例，这里我们使用Sleuth+Zipkin的默认配置，在需要进行链路追踪的所有服务端添加如下配置：

 <parent><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-parent</artifactId><version>2.0.6.RELEASE</version></parent><properties><spring-cloud.version>Finchley.SR2</spring-cloud.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId></dependency><!-- Eureka-Server 依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-netflix-eureka-client</artifactId></dependency><!-- Feign 依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId></dependency><!-- Sleuth+Zipkin 依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-zipkin</artifactId></dependency></dependencies><dependencyManagement><dependencies><!-- SpringCloud 版本控制依赖 --><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-dependencies</artifactId><version>${spring-cloud.version}</version><type>pom</type><scope>import</scope></dependency></dependencies></dependencyManagement>

创建服务

如图所示，创建order-service和product-service两个服务，并在order-service中通过Feign对product-service进行远程调用。

product-service

在product-service的controller中提供一个商品服务：

@RestController
@RequestMapping("/api/v1/product")
public class ProductController {private final Logger logger = LoggerFactory.getLogger(getClass());/*** 商品服务*/@GetMapping("/service")public String productService() {logger.info("Product Service Is Called...");return "Product Service Is Called...";}
}

order-service

由于需要在 order-service 中调用product-service，先创建一个ProductClient：

@FeignClient(name = "product-service")
public interface ProductClient {@GetMapping("/api/v1/product/service")public String productService();}

为了示例简单，我们直接在order-service的controller中通过ProductClient对product-service进行调用：

@RestController
@RequestMapping("/api/v1/order")
public class OrderController {private final Logger logger = LoggerFactory.getLogger(getClass());@Autowiredprivate ProductClient productClient;@GetMapping(value = "/service")public String orderService() {logger.info("Order Service Is Called...");String ret = productClient.productService();logger.info(ret.toString());return "Order Service Is Called...";}
}

启动&测试

按照以下顺序启动应用进行测试：

==>启动Eureka注册中心，端口号 8761==>分别通过8771和8781两个端口启动product-service和order-service两个服务

启动完成之后，Eureka注册中心中注册的服务列表如下：

在浏览器中输入以下地址: http://localhost:8781/api/v1/order/service，返回如下内容：

同时，在order-service后台打印如下日志：

2019-02-27 13:49:17.439  INFO [order-service,895caa4daa30bb0a,895caa4daa30bb0a,true] 2812 --- [nio-8781-exec-2] c.pengjunlee.controller.OrderController  : Order Service Is Called...
2019-02-27 13:49:17.465  INFO [order-service,895caa4daa30bb0a,895caa4daa30bb0a,true] 2812 --- [nio-8781-exec-2] c.pengjunlee.controller.OrderController  : Product Service Is Called...

在product-service后台打印如下日志：

2019-02-27 13:49:17.448  INFO [product-service,895caa4daa30bb0a,9cd122253ea82104,true] 20736 --- [nio-8771-exec-8] c.p.controller.ProductController         : Product Service Is Called...

正如上面 product-service 和 order-service 中打印的日志所示，Sleuth将Trace Id和Span Id添加到Slf4J MDC（Mapped Diagnostic Context）并在日志中进行了打印，这样，你就能够从日志聚合器中提取任何一个给定的Trace 或者Span 的所有日志了。

接下来，重点解释一下日志中的 [appname,traceId,spanId,exportable] 各部分所代表的含义：

appname：记录日志的应用的名称，即spring.application.name的值；

traceId：Sleuth为一次请求链路生成的唯一ID，一个Trace中可以包含多个Span；

spanId：请求链路基本的工作单元，代表发生一次特定的操作，例如：发送一个Http请求；

exportable：是否需要将日志导出到 Zipkin；

Sleuth提供了对常见分布式链路追踪数据模型的抽象：Trace、Span、Annotation和键值对Annotation。Spring-Cloud-Sleuth虽然基于htrace，但与Zipkin（dapper）也兼容。

Sleuth记录时间信息以帮助进行延迟分析。通过使用sleuth，您可以查明应用程序中延迟的原因。

当spring-cloud-sleuth-zipkin包含在classpath中时，应用程序将生成并收集与zipkin兼容的追踪记录。默认情况下，会通过HTTP将它们发送到本地主机（端口9411）上的Zipkin服务器。您可以通过设置spring.zipkin.baseurl来配置服务的地址。

如果你依赖的是spring-rabbit，那么应用程序会将追踪记录发送到Rabbit MQ代理，而不是HTTP。

如果你依赖的是spring-kafka，并设置了spring.zipkin.sender.type:kafka，那么应用程序会将追踪记录发送到Kafka代理而不是HTTP。

注意：如果你使用的是Zipkin，请通过设置spring.sleuth.sampler.probability来配置导出Span的概率（默认值：0.1，即10%）。否则，您可能会认为Sleuth不起作用，因为它省略了一些Span。

注意：如果你使用的是SLF4J，Trace和Span的追踪记录默认会被记录到MDC，所以日志的用户可以立刻看到。但如果你使用的是其他的日志系统，你还需要对日志的打印格式进行设置才能看到相同的结果：

logging.pattern.level = %5p [${spring.zipkin.service.name:${spring.application.name:-}},%X{X-B3-TraceId:-},%X{X-B3-SpanId:-},%X{X-Span-Export:-}]

Zipkin

Zipkin是一个分布式系统的APM工具（Application Performance Management），基于Google Dapper 实现。它帮助收集解决微服务架构中延迟问题所需的时间数据，并管理这些数据。和Sleuth结合可以提供可视化Web界面分析调用链路耗时情况。

使用Zipkin

如果你使用的Java版本为JDK 8，可以下载一个Zipkin的独立可执行Jar。

下载地址：

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

使用如下命令启动Zipkin：

java -jar zipkin-server-2.12.2-exec.jar

启动完成后，访问 http://localhost:9411/zipkin/dependency/ 查看服务的依赖关系。

参考文章

https://cloud.spring.io/spring-cloud-netflix/single/spring-cloud-netflix.html#netflix-zuul-starter

https://github.com/openzipkin/brave

https://cloud.spring.io/spring-cloud-static/Finchley.SR2/single/spring-cloud.htmlhttps://cloud.spring.io/spring-cloud-static/Finchley.SR2/single/spring-cloud.html

微服务下的链路追踪（Sleuth+Zipkin）相关推荐

springboot 之微服务调用之链路追踪
说明:本文来自本篇主要内容一.为什么要用链路追踪? 1.1 因:拆分服务单元微服务架构其实是一个分布式的架构,按照业务划分成了多个服务单元. 由于服务单元的数量是很多的,有可能几千个,而且业务也 ...
ajax请求是宏任务还是微任务_微服务-如何解决链路追踪问题
一.链路追踪微服务架构是将单个应用程序被划分成各种小而连接的服务,每一个服务完成一个单一的业务功能,相互之间保持独立和解耦,每个服务都可以独立演进.相对于传统的单体服务,微服务具有隔离性.技术异构性 ...
微服务链路追踪_.NET Core微服务：分布式链路追踪系统分享
(给DotNet加星标,提升.Net技能) 转自:另一个老李 cnblogs.com/SteveLee/p/10463200.html 对于普通系统或者服务来说,一般通过打日志来进行埋点,然后再通过e ...
微服务治理之分布式链路追踪--3.zipkin实战
微服务治理之分布式链路追踪–3.zipkin实战本节是基于zipkin分布式追踪系统搭建,因为对 scala 和 play framework 2 框架不熟悉,所以,没有采用opentelemetr ...
微服务下的APM全链路监控
https://opentalk.upyun.com/333.html 2017 年 10 月 29 日,又拍云 Open Talk 联合 Spring Cloud 中国社区成功举办了"进击 ...
springclound 链路追踪sleuth
1.pom引入 spring-clound-starter-sleuth 假如不使用openfeign使用dubbo,需要增加最后一个brave-insxxxx-dubbo来链路追踪再增加一个dub ...
如何保证微服务下的数据一致性?
目录 1.传统应用的事务管理 1.1 本地事务 1.2 分布式事务 1.2.1 两阶段提交(2PC) 1.2.2 三阶段提交(3PC) 2.微服务下的事务管理 3.实现微服务下数据一致性的方式 3.1 ...
AspNetCore微服务下的网关-Kong(一)
Kong是Mashape开源的高性能高可用API网关和API服务管理层.它基于OpenResty,进行API管理,并提供了插件实现API的AOP.Kong在Mashape 管理了超过15,000 个A ...
微服务下蓝绿部署、红黑部署、AB测试、灰度发布、金丝雀发布、滚动发布的概念与区别...
更多内容关注微信公众号:fullstack888 在有关微服务.DevOps.Cloud-native的迭代过程中,不可避免的需要"上线",上线就需要部署,需要部署就意味着有修改, ...

微服务下的链路追踪（Sleuth+Zipkin）