首页手记 Dubbo日志链路追踪TraceId选型

Dubbo日志链路追踪TraceId选型

标签：

Java SpringBoot 微服务

一、目的

开发排查系统问题用得最多的手段就是查看系统日志，但是在分布式环境下使用日志定位问题还是比较麻烦，需要借助 全链路追踪ID 把上下文串联起来，本文主要分享基于 Spring Boot + Dubbo 框架下 日志链路追踪ID 的实现方案选型思路。

目前大多数分布式追踪系统的思想模型都来自 Google’s Dapper 论文

全链路追踪的核心思想：

为每条请求都单独分配一个唯一的 traceId 用来标识一条请求链路，该 traceId 会贯穿整个请求处理过程的所有服务
每个服务/线程都拥有自己的 spanId 标识，代表请求的其中一段处理步骤
一个请求包含一个 traceId 和一个或多个 spanId

日志全链路追踪 就是在每条系统日志里都添加显示 traceId 和 spanId 信息

二、方案选型

2.1. 方案一(apm-toolkit)

这是 SkyWalking 的一个日志插件，通过这个插件可以在日志中输出
traceId

2.1.1. 使用方式

配置依赖，在 pom 文件中添加以下内容

<dependency>
    <groupId>org.apache.skywalking</groupId>
    <artifactId>apm-toolkit-logback-1.x</artifactId>
    <version>8.1.0</version>
</dependency>

配置日志模板，修改 logback-spring.xml 文件中 Appender 元素的 encoder 为以下内容

<encoder class="ch.qos.logback.core.encoder.LayoutWrappingEncoder">
    <layout class="org.apache.skywalking.apm.toolkit.log.logback.v1.x.TraceIdPatternLogbackLayout">
        <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%tid] [%thread] %-5level %logger{35} - %msg%n</pattern>
    </layout>
</encoder>

ps: pattern 中的内容按需修改，其中的 %tid 就是相当于 traceId，默认 TID:N/A，当有请求调用时会生成并显示 traceId

2.1.2. 总结

优点：无需编码，业务无入侵，可与 SkyWalking 的图形化界面中使用该ID快速定位各种接口的调用关系。
缺点：强耦合 SkyWalking 才能生效
- 必须添加sk的 javaagent
- 必须部署 SkyWalking 服务端

2.2. 方案二(sleuth)

Sleuth 是 Spring Cloud 的组件之一，它为 Spring Cloud 实现了一种分布式追踪解决方案，兼容Zipkin，HTrace与其他日志追踪系统

2.2.1. 使用方式

配置父依赖，在 pom 文件中添加以下内容管理版本号

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-sleuth</artifactId>
            <version>2.2.4.RELEASE</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
</dependencyManagement>

配置依赖，在 pom 文件中添加以下内容

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

适配dubbo，要让 sleuth 支持 dubbo 框架，需要增加以下两个步骤：

首先添加 dubbo 的插件依赖

<dependency>
    <groupId>io.zipkin.brave</groupId>
    <artifactId>brave-instrumentation-dubbo-rpc</artifactId>
    <version>5.12.6</version>
</dependency>

配置 dubbo 过滤器

dubbo:
  provider:
    filter: tracing
  consumer:
    filter: tracing

配置日志模板，修改 logback-spring.xml 文件中 Appender 元素的 encoder 为以下内容

<encoder>
    <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%X{X-B3-TraceId},%X{X-B3-SpanId}] [%thread] %-5level %logger{35} - %msg%n</pattern>
    <charset>utf-8</charset>
</encoder>