DocsICP FilingConsole
官方文档
首页

Report .NET application data using Zipkin

更新时间：
复制 MD 格式
产品详情
我的收藏

You can instrument your .NET application to report traces to Managed Service for OpenTelemetry using Zipkin. After the traces are reported, Managed Service for OpenTelemetry starts to monitor your application. You can then view monitoring data, such as application topology, call traces, abnormal transactions, slow transactions, and SQL analysis. This topic describes how to use the ASP.NET Core or Owin component for automatic instrumentation and how to perform manual instrumentation.

Important

We recommend that you connect your application to Managed Service for OpenTelemetry by using OpenTelemetry Protocol (OTLP). In this case, you are provided with more features, more advanced tracing capabilities, and the best user experience.

Alibaba Cloud provides detailed instructions on how to integrate OpenTelemetry with an application and the best practices of using OpenTelemetry to help you quickly get started with Managed Service for OpenTelemetry. For more information, see Preparations.

Prerequisites

Obtain an endpoint

New console

  1. Log on to the Managed Service for OpenTelemetry console. In the left-side navigation pane, click Integration Center.

  2. On the Integration Center page, click the Zipkin card in the Open Source Frameworks section.

  3. In the Zipkin panel, click the Start Integration tab, and then select a region in which you want to report data.

    Note

    When you access a region for the first time, resources are automatically initialized there.

  4. Configure the Connection Type parameter and copy an endpoint.

    Note

    • If your service is deployed on Alibaba Cloud and resides in the region that you selected, we recommend that you set this parameter to Alibaba Cloud VPC Network. Otherwise, set this parameter to Public Network.

    • In most cases, we recommend that you use a V2 endpoint. If you are familiar with Zipkin, we recommend that you use a V1 endpoint.

    image.png

Old console

  1. Log on to the Managed Service for OpenTelemetry console.

  2. In the left-side navigation pane, click Cluster Configurations. On the page that appears, click the Access point information tab.

  3. In the top navigation bar, select a region in which you want to report data. In the Cluster Information section, turn on Show Token.

  4. Set the Client parameter to Zipkin.

    Note

    • If your application is deployed in an Alibaba Cloud production environment, use a VPC endpoint. Otherwise, use a public endpoint.

    • In most cases, we recommend that you use a V2 endpoint. If you are familiar with Zipkin, we recommend that you use a V1 endpoint.

    In the Related Information column of the table, copy an endpoint.zipkin旧中国.jpg

Background information

Zipkin is an open-source, distributed, real-time data tracking system developed by Twitter. It aggregates real-time monitoring data from various heterogeneous systems.

The following figure shows how to report data by using Zipkin.

image

Automatic instrumentation using the ASP.NET Core component

Follow these steps to perform instrumentation using the ASP.NET Core component.

Note

You can download the demo source code and run the program by following the instructions in the Readme file.

  1. Install the NuGet package.

    // Add the following components.
// zipkin4net.middleware.aspnetcore (ASP.NET Core middleware)
// zipkin4net (tracker)

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

  2. Register and start Zipkin.

    lifetime.ApplicationStarted.Register(() => {
    TraceManager.SamplingRate = 1.0f;
    var logger = new TracingLogger(loggerFactory, "zipkin4net");
    // Obtain the Zipkin endpoint from the Managed Service for OpenTelemetry console. The endpoint does not contain "/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);

  3. Add a tracing handler to the HttpClient that sends GET or POST requests.

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

Automatic instrumentation using the Owin component

Follow these steps to perform instrumentation using the Owin component.

Note

You can download the demo source code and run the program by following the instructions in the Readme file.

  1. Install the NuGet package.

    // Add the following components.
// zipkin4net.middleware.aspnetcore (ASP.NET Core middleware)
// zipkin4net (tracker)

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

  2. Register and start Zipkin.

    // Set up tracing.
TraceManager.SamplingRate = 1.0f;
var logger = new ConsoleLogger();
// Obtain the Zipkin endpoint from the Managed Service for OpenTelemetry console. The endpoint does not contain "/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"]);

  3. Add a tracing handler to the HttpClient that sends GET or POST requests.

    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);
    }

Manual instrumentation

To report .NET application data to the Managed Service for OpenTelemetry console using Zipkin, you can use existing plugins or perform manual instrumentation.

Note

You can download the demo source code and run the program by following the instructions in the Readme file.

  1. Install the NuGet package.

    // Add zipkin4net (tracker).

dotnet add  package zipkin4net

  2. Register and start Zipkin.

    TraceManager.SamplingRate = 1.0f;
var logger = new ConsoleLogger();
// Obtain the Zipkin endpoint from the Managed Service for OpenTelemetry console. The endpoint does not contain "/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);

  3. Record request data.

    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());
    Note

    The preceding code records the root operation of a request. To record child operations, call the `ChildOf` method. Example:

    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());

  4. Optional: To quickly troubleshoot issues, add custom tags to a record. For example, you can record whether an error occurred or the return value of a request.

    tracer.activeSpan().setTag("http.status_code", "200");

  5. When you send an RPC request in a distributed system, you must propagate the trace context. The trace context includes data such as TraceId, ParentSpanId, SpanId, and Sampled. Use the `Extract` and `Inject` methods to propagate the trace context through HTTP request headers. The process is as follows:

       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      │ │
│ └──────────────┘ │          └───────────────────┘        │ └──────────────┘ │
│                  │                                       │                  │
└──────────────────┘                                       └──────────────────┘

    1. On the client, call the `Inject` method to inject the trace context.

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

    2. On the server-side, call the `Extract` method to extract the trace context.

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

FAQ

Q: The demo program runs successfully, but no data is reported to the console. Why?

A: Verify that the endpoint in `senderConfiguration` is correct.

// Obtain the Zipkin endpoint from the Managed Service for OpenTelemetry console. The endpoint does not contain "/api/v2/spans".
var httpSender = new HttpZipkinSender("http://tracing-analysis-dc-hz.aliyuncs.com/adapt_your_token", "application/json");

Previous：Report .NET trace data with JaegerNext：Report .NET application data with SkyWalking