全链路追踪 on Apache Dubbo

全链路追踪使用与实现说明

Mon, 01 Jan 0001 00:00:00 +0000

Dubbo 内置了全链路追踪能力，你可以通过引入 spring-boot-starter 或者相关依赖开启链路跟踪能力，通过将跟踪数据导出到一些主流实现如 Zipkin、Skywalking、Jaeger 等后端系统，可以实现全链路跟踪数据的分析与可视化展示。

Dubbo 目前借助 Micrometer Observation 完成 Tracing 的所有埋点工作，依赖 Micrometer 提供的各种 Bridge 适配，我们可以实现将 Tracing 导入各种后端系统，具体工作原理如下。

使用方式

以 Dubbo Spring Boot 应用为例，通过加入如下依赖即可开启链路追踪，并使用 zipkin exporter bridge 将链路追踪数据导入 Zipkin 后端系统。

<dependency>
 <groupId>org.apache.dubbo</groupId>
 <artifactId>dubbo-spring-boot-tracing-otel-zipkin-starter</artifactId>
 <version>3.2.1-SNAPSHOT</version>
</dependency>

更多完整示例请参见：

关联日志

Dubbo Tracing 还实现了与日志系统的自动关联，即将 tracing-id、span-id 等信息自动置入日志 MDC 上下文，你只需要设置日志输出格式中包含类似 %X{traceId:-},%X{spanId:-}]，即可实现业务日志与 tracing 系统的自动关联，具体可参见 Tracing 日志上下文配置示例。

工作原理

Tracing相关概念

Span：基本工作单元。例如，发送 RPC 是一个新的 span，发送对 RPC 的响应也是如此。Span还有其他数据，例如description、带时间戳的事件、键值注释（标签）、导致它们的跨度的 ID 和进程 ID（通常是 IP 地址）。跨度可以启动和停止，并且它们会跟踪它们的时间信息。创建跨度后，您必须在将来的某个时间点停止它。

OTlp

Mon, 01 Jan 0001 00:00:00 +0000

概述

这个案例展示了在 Dubbo 项目中以 OpenTelemetry 作为 Tracer，将 Trace 信息上报到 Otlp Collector，再由 collector 转发至 Zipkin、Jagger。代码地址

有三部分组成：

dubbo-samples-spring-boot-tracing-otel-oltp-interface
dubbo-samples-spring-boot-tracing-otel-oltp-provider
dubbo-samples-spring-boot-tracing-otel-oltp-consumer

案例架构图

快速开始

安装 & 启动 Otlp Collector

按照 OpenTelemetry Collector Quick Start 去启动 otlp collector.

启动 Provider

直接运行org.apache.dubbo.springboot.demo.provider.ProviderApplication directly from IDE.

启动 Consumer

Start org.apache.dubbo.springboot.demo.consumer.ConsumerApplication directly from IDE.

查看 Trace 信息

在浏览器中打开zipkin看板 http://localhost:9411/zipkin/ :

在浏览器中打开Jaeger看板 http://localhost:16686/search :

如何在SpringBoot项目中使用

1. 在你的项目中添加依赖

对于 SpringBoot 项目，你可以使用dubbo-spring-boot-tracing-otel-otlp-starter ：


<!-- OpenTelemetry as Tracer, Otlp as exporter -->
<dependency>
 <groupId>org.apache.dubbo</groupId>
 <artifactId>dubbo-spring-boot-tracing-otel-otlp-starter</artifactId>
</dependency>

2. 配置

application.yml

dubbo:
 tracing:
 enabled: true # default is false
 sampling:
 probability: 0.5 # sampling rate, default is 0.1
 propagation:
 type: W3C # W3C/B3 default is W3C
 tracing-exporter:
 otlp-config:
 endpoint: http://localhost:4317
 timeout: 10s # default is 10s
 compression-method: none # none/gzip The method used to compress payloads, default is "none"
 headers: # customized added headers, default is empty
 auth: admin

# tracing info output to logging
logging:
 level:
 root: info
 pattern:
 console: '[%d{dd/MM/yy HH:mm:ss:SSS z}] %t %5p %c{2} [%X{traceId:-}, %X{spanId:-}]: %m%n'

如何基于Dubbo API使用

1. 在你的项目中添加依赖

 <!-- 必选，dubbo-tracing核心依赖 -->
 <dependency>
 <groupId>org.apache.dubbo</groupId>
 <artifactId>dubbo-tracing</artifactId>
 </dependency>
 <!-- Opentelemetry as Tracer -->
 <dependency>
 <groupId>io.micrometer</groupId>
 <artifactId>micrometer-tracing-bridge-otel</artifactId>
 </dependency>
 <!-- OTlp as exporter -->
 <dependency>
 <groupId>io.opentelemetry</groupId>
 <artifactId>opentelemetry-exporter-otlp</artifactId>
 </dependency>

2. 配置

TracingConfig tracingConfig = new TracingConfig();
// 开启dubbo tracing
tracingConfig.setEnabled(true);
// 设置采样率
tracingConfig.setSampling(new SamplingConfig(1.0f));
// 设置Propagation，默认为W3C，可选W3C/B3
tracingConfig.setPropagation(new PropagationConfig("W3C"));
// 设置trace上报
ExporterConfig exporterConfig = new ExporterConfig();
// 设置将trace上报到Zipkin
exporterConfig.setZipkin(new ExporterConfig.OtlpConfig("http://localhost:4317", Duration.ofSeconds(10), "none"));
tracingConfig.setExporter(exporterConfig);

Zipkin

Mon, 01 Jan 0001 00:00:00 +0000

这个示例演示了 Dubbo 集成 Zipkin 全链路追踪的基础示例，完整代码请参考 dubbo-samples-tracing-zipkin，此示例共包含三部分内容：

dubbo-samples-spring-boot3-tracing-provider
dubbo-samples-spring-boot3-tracing-consumer
dubbo-samples-spring-boot3-tracing-interface

快速开始

安装 & 启动 Zipkin

参考 Zipkin’s quick start 安装 Zipkin。

这里我们使用 Docker 来演示如何快速的启动 Zipkin 服务。

docker run -d -p 9411:9411 --name zipkin openzipkin/zipkin

紧接着，你可以通过如下链接确认 Zipkin 正常工作 [http://localhost:9411](http://localhost:9411)

安装 & 启动 Nacos

跟随 Nacos’s quick start 快速安装并启动 Nacos。

启动示例 Provider

在 IDE 中直接运行 org.apache.dubbo.springboot.demo.provider.ProviderApplication。

启动示例 Consumer

在 IDE 中直接运行 org.apache.dubbo.springboot.demo.consumer.ConsumerApplication。

检查监控效果

在浏览器中打开 http://localhost:9411/zipkin/ 查看效果。

如何在SpringBoot项目中使用 Dubbo Tracing

1. 添加 Dubbo Tracing 相关的 Starter 依赖

从下面两个 starter 中选择一个加入到你的项目中，区别在于 Tracer 的选型不一样，一个是 Opentelemetry，一个是 Brave：

Skywalking

Mon, 01 Jan 0001 00:00:00 +0000

本文演示如何将 Dubbo 接入 Skywalking 全链路监控体系，完整示例请参考 dubbo-samples-tracing-skywalking。依赖的 Skywalking Agent 版本为 skywalking micrometer-1.10 api.

1. 添加 Micrometer Observation 依赖到你的项目

为了能够将 Micrometer 及相关 Metrics 依赖添加到 classpath，需要增加 dubbo-metrics-api 依赖，如下所示：


<dependency>
 <groupId>org.apache.dubbo</groupId>
 <artifactId>dubbo-metrics-api</artifactId>
</dependency>

2. 添加 Skywalking Micrometer-1.10 Api 到项目

为了将 Dubbo Micrometer tracing 数据集成到 Skywalking，需要添加以下依赖。

<dependency>
 <groupId>org.apache.skywalking</groupId>
 <artifactId>apm-toolkit-micrometer-1.10</artifactId>
</dependency>

3. 配置 ObservationRegistry

@Configuration
public class ObservationConfiguration {
 @Bean
 ApplicationModel applicationModel(ObservationRegistry observationRegistry) {
 ApplicationModel applicationModel = ApplicationModel.defaultModel();
 observationRegistry.observationConfig()
 .observationHandler(new ObservationHandler.FirstMatchingCompositeObservationHandler(
 new SkywalkingSenderTracingHandler(), new SkywalkingReceiverTracingHandler(),
 new SkywalkingDefaultTracingHandler()
 ));
 applicationModel.getBeanFactory().registerBean(observationRegistry);
 return applicationModel;
 }
}

4. 启动 Skywalking OAP

请参考这里了解如何设置 Skywalking OAP