通过Zipkin为.Net应用埋点并上报链路数据 - 可观测链路 OpenTelemetry 版

通过Zipkin为应用埋点并上报链路数据至可观测链路 OpenTelemetry 版后，可观测链路 OpenTelemetry 版即可开始监控应用，您可以查看应用拓扑、调用链路、异常事务、慢事务和SQL分析等一系列监控数据。本文介绍如何使用ASP.NET Core/Owin组件进行自动埋点或直接进行手动埋点。

重要

为获得更丰富的功能、更先进的链路追踪能力，以及最佳使用体验，建议您使用OpenTelemetry协议将应用接入可观测链路 OpenTelemetry 版。

我们为您提供了详细的OpenTelemetry接入指南和最佳实践，帮助您快速上手可观测链路 OpenTelemetry 版。更多信息，请参见接入应用。

前提条件

获取接入点信息

新版控制台

登录可观测链路 OpenTelemetry 版控制台，在左侧导航栏单击接入中心。
在开源框架区域单击Zipkin卡片。
在弹出的Zipkin面板中选择数据需要上报的地域。
说明
初次接入的地域将会自动进行资源初始化。
选择连接方式，然后复制接入点信息。
说明
- 若您的服务部署在阿里云上，且所属地域与选择的接入地域一致，推荐使用阿里云内网方式，否则选择公网方式。
- 一般情况下请使用v2版本接入点，v1版本接入点推荐对Zipkin十分了解的高阶用户使用。

旧版控制台

登录可观测链路 OpenTelemetry 版控制台。
在左侧导航栏单击集群配置，然后在右侧页面单击接入点信息页签。
在页面顶部选择需要接入的地域，然后在集群信息区域打开显示Token开关。
在客户端采集工具区域单击Zipkin。
说明
- 如果应用部署于阿里云生产环境，则选择阿里云VPC网络接入点，否则选择公网接入点。
- 一般情况下请使用v2版本接入点，v1版本接入点推荐对Zipkin十分了解的高阶用户使用。
在相关信息列中，获取接入点信息。

背景信息

Zipkin是一款开源的分布式实时数据追踪系统（Distributed Tracking System），由Twitter公司开发和贡献。其主要功能是聚合来自各个异构系统的实时监控数据。

通过Zipkin上报数据的原理

通过ASP.NET Core组件自动埋点

请按照以下步骤通过ASP.NET Core组件埋点。

说明

下载Demo源码，并按照Readme的说明运行程序。

安装NuGet包。

// 添加以下组件。
// zipkin4net.middleware.aspnetcore（aspnetcore中间件）
// zipkin4net（追踪器）

dotnet add  package zipkin4net.middleware.aspnetcore
dotnet add  package zipkin4net

注册和启动Zipkin。

lifetime.ApplicationStarted.Register(() => {
    TraceManager.SamplingRate = 1.0f;
    var logger = new TracingLogger(loggerFactory, "zipkin4net");
    // 在可观测链路 OpenTelemetry 版控制台获取Zipkin Endpoint,注意Endpoint中不包含“/api/v2/spans”。
    var httpSender = new HttpZipkinSender("http://tracing-analysis-dc-hz.aliyuncs.com/adapt_your_token", "application/json");

    var tracer = new ZipkinTracer(httpSender, new JSONSpanSerializer());
    TraceManager.RegisterTracer(tracer);
    TraceManager.Start(logger);
 });
lifetime.ApplicationStopped.Register(() => TraceManager.Stop());
app.UseTracing(applicationName);

在发送Get/Post请求的HttpClient中添加tracinghandler（追踪处理者）。

public override void ConfigureServices(IServiceCollection services)
{
    services.AddHttpClient("Tracer").AddHttpMessageHandler(provider =>
        TracingHandler.WithoutInnerHandler(provider.GetService<IConfiguration>()["applicationName"]));
}

通过Owin组件自动埋点

请按照以下步骤通过Owin组件埋点。

说明

下载Demo源码，并按照Readme的说明运行程序。

安装NuGet包。

// 添加以下组件。
// zipkin4net.middleware.aspnetcore（aspnetcore中间件）
// zipkin4net（追踪器）

dotnet add  package zipkin4net.middleware.aspnetcore
dotnet add  package zipkin4net

注册和启动Zipkin。

// 设置Tracing。
TraceManager.SamplingRate = 1.0f;
var logger = new ConsoleLogger();
// 在可观测链路 OpenTelemetry 版控制台获取Zipkin Endpoint,注意Endpoint中不包含“/api/v2/spans”。
var httpSender = new HttpZipkinSender("http://tracing-analysis-dc-hz.aliyuncs.com/adapt_your_token", "application/json");

var tracer = new ZipkinTracer(httpSender, new JSONSpanSerializer());
TraceManager.RegisterTracer(tracer);
TraceManager.Start(logger);

//Stop TraceManager on app dispose
var properties = new AppProperties(appBuilder.Properties);
var token = properties.OnAppDisposing;

if (token != CancellationToken.None)
{
token.Register(() =>
{
TraceManager.Stop();
});
}

// Setup Owin Middleware
appBuilder.UseZipkinTracer(System.Configuration.ConfigurationManager.AppSettings["applicationName"]);

在发送Get/Post请求的HttpClient中添加tracinghandler（追踪处理者）。

using (var httpClient = new HttpClient(new TracingHandler(applicationName)))
    {
       var response = await httpClient.GetAsync(callServiceUrl);
       var content = await response.Content.ReadAsStringAsync();

       await context.Response.WriteAsync(content);
    }

手动埋点

要通过Zipkin将.Net应用数据上报至可观测链路 OpenTelemetry 版控制台，除了利用各种现有插件实现埋点的目的，也可以手动埋点。

说明

下载Demo源码，并按照Readme的说明运行程序。

安装NuGet包。

// 添加zipkin4net（追踪器）。

dotnet add  package zipkin4net

注册和启动Zipkin。

TraceManager.SamplingRate = 1.0f;
var logger = new ConsoleLogger();
// 在可观测链路 OpenTelemetry 版控制台获取Zipkin Endpoint,注意Endpoint中不包含“/api/v2/spans”。
var httpSender = new HttpZipkinSender("http://tracing-analysis-dc-hz.aliyuncs.com/adapt_your_token", "application/json");

var tracer = new ZipkinTracer(httpSender, new JSONSpanSerializer());
TraceManager.RegisterTracer(tracer);
TraceManager.Start(logger);

记录请求数据。

var trace = Trace.Create();

Trace.Current = trace;
trace.Record(Annotations.ClientSend());

trace.Record(Annotations.Rpc("client"));
trace.Record(Annotations.Tag("mytag", "spanFrist"));
trace.Record(Annotations.ServiceName("dotnetManual"));
// ...do something
testCall();

trace.Record(Annotations.ClientRecv());

说明

以上代码用于记录请求的根操作，如果需要记录请求的上一步和下一步操作，则需要调用ChildOf方法。示例：

var trace = Trace.Current.Child();
Trace.Current = trace;
trace.Record(Annotations.ServerRecv());
trace.Record(Annotations.Rpc("server"));
trace.Record(Annotations.Tag("mytag", "spanSecond"));
trace.Record(Annotations.ServiceName("dotnetManual"));
// ...do something
trace.Record(Annotations.ServerSend());

可选：为了快速排查问题，您可以为某个记录添加一些自定义标签，例如记录是否发生错误、请求的返回值等。
```
tracer.activeSpan().setTag("http.status_code", "200");
```

在分布式系统中发送RPC请求时会带上Tracing数据，包括TraceId、ParentSpanId、SpanId、Sampled等。您可以在HTTP请求中使用Extract/Inject方法在HTTP Request Headers上透传数据。总体流程如下：

   Client Span                                                Server Span
┌──────────────────┐                                       ┌──────────────────┐
│                  │                                       │                  │
│   TraceContext   │           Http Request Headers        │   TraceContext   │
│ ┌──────────────┐ │          ┌───────────────────┐        │ ┌──────────────┐ │
│ │ TraceId      │ │          │ X-B3-TraceId      │        │ │ TraceId      │ │
│ │              │ │          │                   │        │ │              │ │
│ │ ParentSpanId │ │ Inject   │ X-B3-ParentSpanId │Extract │ │ ParentSpanId │ │
│ │              ├─┼─────────>│                   ├────────┼>│              │ │
│ │ SpanId       │ │          │ X-B3-SpanId       │        │ │ SpanId       │ │
│ │              │ │          │                   │        │ │              │ │
│ │ Sampled      │ │          │ X-B3-Sampled      │        │ │ Sampled      │ │
│ └──────────────┘ │          └───────────────────┘        │ └──────────────┘ │
│                  │                                       │                  │
└──────────────────┘                                       └──────────────────┘

在客户端调用Inject方法传入Context信息。

_injector.Inject(clientTrace.Trace.CurrentSpan, request.Headers);

在服务端调用Extract方法解析Context信息。

Ivar traceContext = traceExtractor.Extract(context.Request.Headers);
var trace = traceContext == null ? Trace.Create() : Trace.CreateFromId(traceContext);

常见问题

问：Demo程序执行成功，为什么控制台上没有上报数据？

答：请检查senderConfiguration配置中的Endpoint是否填写正确。

// 在可观测链路 OpenTelemetry 版控制台获取Zipkin Endpoint,注意Endpoint中不包含“/api/v2/spans”。
var httpSender = new HttpZipkinSender("http://tracing-analysis-dc-hz.aliyuncs.com/adapt_your_token", "application/json");