代码跟踪 on Dapr 文档库

分布式追踪概述

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

Dapr 通过 Open Telemetry (OTEL) 和 Zipkin 协议来实现分布式追踪。OTEL 是行业标准，并且是推荐使用的追踪协议。

大多数可观测性工具支持 OTEL，包括：

下图展示了 Dapr（使用 OTEL 和 Zipkin 协议）如何与多个可观测性工具集成。

场景

追踪用于服务调用和发布/订阅（pubsub）API。您可以在使用这些 API 的服务之间传递追踪上下文。追踪的使用有两种场景：

Dapr 生成追踪上下文，您将追踪上下文传递到另一个服务。
您生成追踪上下文，Dapr 将追踪上下文传递到服务。

场景 1：Dapr 生成追踪上下文头

顺序服务调用的传递

Dapr 负责创建追踪头。然而，当有两个以上的服务时，您需要负责在它们之间传递追踪头。让我们通过示例来了解这些场景：

单一服务调用

例如，服务 A -> 服务 B。

Dapr 在 服务 A 中生成追踪头，然后从 服务 A 传递到 服务 B。不需要进一步的传递。

多个顺序服务调用

例如，服务 A -> 服务 B -> 传递追踪头到 -> 服务 C，以及其他启用 Dapr 的服务。

W3C 跟踪上下文概述

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

Dapr 采用 Open Telemetry 协议，该协议利用 W3C 跟踪上下文来实现服务调用和发布/订阅消息的分布式跟踪。Dapr 生成并传播跟踪上下文信息，可以将其发送到可观测性工具进行可视化和查询。

背景

分布式跟踪是一种由跟踪工具实现的方法，用于跟踪、分析和调试跨多个软件组件的事务。

通常，分布式跟踪会跨越多个服务，因此需要一个唯一的标识符来标识每个事务。跟踪上下文传播就是传递这种唯一标识符的过程。

过去，不同的跟踪供应商各自实现自己的跟踪上下文传播方式。在多供应商环境中，这会导致互操作性的问题，例如：

不同供应商收集的跟踪数据无法关联，因为没有共享的唯一标识符。
跨越不同供应商边界的跟踪无法传播，因为没有统一的标识符集。
中间商可能会丢弃供应商特定的元数据。
云平台供应商、中间商和服务提供商无法保证支持跟踪上下文传播，因为没有标准可循。

以前，大多数应用程序由单一的跟踪供应商监控，并保持在单一平台提供商的边界内，因此这些问题没有显著影响。

如今，越来越多的应用程序是分布式的，并利用多个中间件服务和云平台。这种现代应用程序的转变需要一个分布式跟踪上下文传播标准。

W3C 跟踪上下文规范定义了一种通用格式，用于交换跟踪上下文数据（称为跟踪上下文）。通过提供以下内容，跟踪上下文解决了上述问题：

为单个跟踪和请求提供唯一标识符，允许将多个供应商的跟踪数据链接在一起。
提供一种机制来转发供应商特定的跟踪数据，避免在单个事务中多个跟踪工具参与时出现断裂的跟踪。
一个中间商、平台和硬件供应商可以支持的行业标准。

这种统一的跟踪数据传播方法提高了对分布式应用程序行为的可见性，促进了问题和性能分析。

W3C 跟踪上下文和头格式

W3C 跟踪上下文

Dapr 使用标准的 W3C 跟踪上下文头。

对于 HTTP 请求，Dapr 使用 traceparent 头。
对于 gRPC 请求，Dapr 使用 grpc-trace-bin 头。

当请求到达时没有跟踪 ID，Dapr 会创建一个新的。否则，它会沿调用链传递跟踪 ID。

W3C 跟踪头

这些是 Dapr 为 HTTP 和 gRPC 生成和传播的特定跟踪上下文头。

在从 HTTP 响应传播跟踪上下文头到 HTTP 请求时复制这些头：

配置 Dapr 发送分布式追踪数据

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

注意

建议在任何生产环境中启用 Dapr 的追踪功能。您可以根据运行环境配置 Dapr，将追踪和遥测数据发送到多种可观测性工具，无论是在云端还是本地。

配置

在 Configuration 规范中的 tracing 部分包含以下属性：

spec:
 tracing:
 samplingRate: "1"
 otel: 
 endpointAddress: "myendpoint.cluster.local:4317"
 zipkin:
 endpointAddress: "https://..."

下表列出了追踪的属性：

属性	类型	描述
`samplingRate`	string	设置追踪的采样率来启用或禁用追踪。
`stdout`	bool	如果为真，则会将更详细的信息写入追踪。
`otel.endpointAddress`	string	设置 Open Telemetry (OTEL) 目标主机名和可选端口。如果使用此项，则无需指定 ‘zipkin’ 部分。
`otel.isSecure`	bool	指定连接到端点地址的连接是否加密。
`otel.protocol`	string	设置为 `http` 或 `grpc` 协议。
`zipkin.endpointAddress`	string	设置 Zipkin 服务器 URL。如果使用此项，则无需指定 `otel` 部分。

要启用追踪，请使用配置文件（在 selfhost 模式下）或 Kubernetes 配置对象（在 Kubernetes 模式下）。例如，以下配置对象将采样率设置为 1（每个 span 都被采样），并使用 OTEL 协议将追踪发送到本地的 OTEL 服务器 localhost:4317。

操作指南：配置 New Relic 进行分布式追踪

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

前提条件

需要一个 New Relic 账户，该账户永久免费，每月可免费处理 100 GB 的数据，包含 1 个完全访问用户和无限数量的基本用户。

配置 Dapr 追踪

Dapr 可以直接将其捕获的指标和追踪数据发送到 New Relic。最简单的方式是通过配置 Dapr，将追踪数据以 Zipkin 格式发送到 New Relic 的 Trace API。

为了将数据集成到 New Relic 的 Telemetry Data Platform，您需要一个 New Relic Insights Insert API key。

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
 name: appconfig
 namespace: default
spec:
 tracing:
 samplingRate: "1"
 zipkin:
 endpointAddress: "https://trace-api.newrelic.com/trace/v1?Api-Key=<NR-INSIGHTS-INSERT-API-KEY>&Data-Format=zipkin&Data-Format-Version=2"

查看追踪

New Relic 分布式追踪概览

New Relic 分布式追踪详情

操作指南：设置 Zipkin 进行分布式追踪

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

配置自托管模式

在自托管模式下，运行 dapr init 时：

系统会默认创建一个 YAML 文件，路径为 $HOME/.dapr/config.yaml（Linux/Mac）或 %USERPROFILE%\.dapr\config.yaml（Windows）。在执行 dapr run 时，系统会默认引用该文件，除非您指定了其他配置：

config.yaml

apiVersion: dapr.io/v1alpha1
kind: Configuration
metadata:
 name: daprConfig
 namespace: default
spec:
 tracing:
 samplingRate: "1"
 zipkin:
 endpointAddress: "http://localhost:9411/api/v2/spans"

运行 dapr init 时，openzipkin/zipkin 的 Docker 容器会自动启动。您也可以手动启动：

使用 Docker 启动 Zipkin：

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

使用 dapr run 启动应用程序时，默认会引用 $HOME/.dapr/config.yaml 或 %USERPROFILE%\.dapr\config.yaml 中的配置文件。您可以通过 Dapr CLI 的 --config 参数来指定其他配置：

dapr run --app-id mynode --app-port 3000 node app.js

查看追踪

要查看追踪数据，请在浏览器中访问 http://localhost:9411，您将看到 Zipkin 的用户界面。

操作指南：为分布式追踪设置 Datadog

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

Dapr 捕获的指标和追踪信息可以通过 OpenTelemetry Collector 的 Datadog 导出器直接发送到 Datadog。

使用 OpenTelemetry Collector 和 Datadog 配置 Dapr 追踪

您可以使用 OpenTelemetry Collector 的 Datadog 导出器来配置 Dapr，为 Kubernetes 集群中的每个应用程序创建追踪，并将这些追踪信息收集到 Datadog 中。

在开始之前，请先设置 OpenTelemetry Collector。

在 datadog 导出器的配置部分，将您的 Datadog API 密钥添加到 ./deploy/opentelemetry-collector-generic-datadog.yaml 文件中：
```
data:
 otel-collector-config:
 ...
 exporters:
 ...
 datadog:
 api:
 key: <YOUR_API_KEY>
```

运行以下命令以应用 opentelemetry-collector 的配置。

kubectl apply -f ./deploy/open-telemetry-collector-generic-datadog.yaml

设置一个 Dapr 配置文件以启用追踪，并部署一个使用 OpenTelemetry Collector 的追踪导出器组件。