分布式服务跟踪——Sleuth

分布式服务跟踪——Sleuth（侦探）

当用户请求链路中的任何一环出现问题或者网络超时，如何对整个请求处理链进行分析。

8.1 Spring Cloud Sleuth简介

Spring Cloud Sleuth为微服务之间调用提供了一套完整的服务链路跟踪解决方案。

·耗时分析，·可视化错误：对于程序未捕捉的异常，可以在集成Zipkin服务界面上看到。

·链路优化：识别出调用比较频繁的微服务；

Spring Cloud Sleuth基于HTTP，在HTTP中的header（头部）添加跟踪所需要的信息，实现原理可以总结如下。

·服务追踪：对于同一个用户请求，认为是同一条链路，并赋值一个相同的TraceID，在后续中通过该标识就可以在多个微服务之间找到完整的处理链路。

·服务监控：对于链路上的每一个微服务处理，Sleuth会再生成一个独立的SpanID，同时记录请求到达时间和离开时间等信息，以作为用户请求追踪的依据，从而判断每一个微服务的处理效率。

术语：

·Span：是Sleuth中最基本的工作单元。微服务发起一次请求就是一个新Span。在Span中可以带有其他数据，如描述、时间戳、键值对、起始Span的ID等数据。Span有起始和结束，可以用于跟踪服务处理时间信息。Span一般都是成对出现，因为有始必有终，所以一旦创建了一个Span，就必须在未来某个时间点结束它。

·Trace：一次用户请求所涉及的所有Span的集合，采用树形结构进行管理。·Annotation：用于记录时间信息，包含了以下几项。

✧ cs：客户端发送（Client Sent），表示一个Span的起始点。

✧ sr：服务端接收（Server Received），表示服务端接收到请求并开始处理。如果减去cs的时间戳，则可以计算出网络传输耗时。

✧ ss：服务端完成请求处理，应答信息被发回客户端（Server Sent）。通过减去sr的时间戳，可以计算出服务端处理请求的耗时。

✧ cr：客户端接收（Client Received），标志着一个Span生命周期的结束，客户端成功地接收到服务端的应答信息。如果减去cs的时间戳，则可以计算出整个请求的响应耗时。

---

8.1.1 快速启用Sleuth

1．修改配置文件(微服务项目)

bootstrap.properties文件

server.port=2200

spring.application.name=productservice

2．修改POM文件

spring-cloud-starter-sleuth的依赖

3．启动测试(请求地址)

[ApplicationName,TraceId, SpanId, Exportable]

·ApplicationName：该值必须在bootstrap.properties文件中进行配置，这是由于日志框架启动时间较早造成的。如果是在application.properties文件中进行配置，则会因为该配置数据尚未加载而导致日志框架无法获取到该值。

·TraceId：找到完整链路

·SpanId：一次链路请求最起始的Span通常被称为根Span（RootSpan），它的ID通常也被作为Trace的ID

·Exportable：是否将追踪到的信息输出到Zipkin服务器等日志采集服务器上。

8.1.2 Sleuth与日志框架

默认情况，Sleuth会默认与Slf4jMDC（Mapped Diagnostic Context，映射调试上下文）进行整合，当在项目中没有对日志配置进行覆写的话，启动Sleuth后上述追踪数据时就会立即在日志中显示，如果在项目中更改了日志配置的话，则需要在日志配置文件中手工配置日志输入格式；

<? xml version="1.0" encoding="UTF-8" ? >
        <configuration>
            <include
              resource="org/springframework/boot/logging/logback/defaults.xml"/>
            <springProperty scope="context" name="springAppName"
                            source="spring.application.name"/>
            <property name="LOG_FILE" value="${BUILD_FOLDER:-build}/${spring
            AppName}
        "/>
            <! -- 这里重新定义日志的输出格式，并包含Sleuth中的追踪数据 -->
            <property name="CONSOLE_LOG_PATTERN"
                      value="%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint}
                            %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:-}){magenta}
                            %clr(---){faint} %clr([%15.15t]){faint}
                            %clr(%-40.40logger{39}){cyan} %clr(:){faint}
                            %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}"/>
            <appender name="STDOUT" clas