[Zipkin] 使用 OpenTelemetry 來追蹤 ASP.NET Core 上的 gRPC 呼叫

之前筆記 [Zipkin] 使用 OpenTelemetry 來追蹤 ASP.NET Core 紀錄到使用 OpenTelemetry 搭配 Zipkin 來追蹤 ASP.NET Core 也曾在 .NET Core 上使用 Jaeger 追蹤 gRPC 呼叫紀錄使用 OpenTracing 來追蹤 gRPC 呼叫，之前筆記 [Jaeger] 使用 OpenTelemetry 來追蹤 ASP.NET Core 上的 gRPC 呼叫已經紀錄了 OpenTelemetry 搭配 Jaeger 追蹤 gRPC，今天就快速紀錄一下如何使用 OpenTelemetry 搭配 Zipkin 來追蹤 ASP.NET Core 上的 gRPC 吧

基本環境說明

macOS Big Sur 11.2.3
docker desktop 3.2.2 (61853)
- openzipkin/zipkin-slim:2
NuGet packages
- GrpcService
  - Google.Protobuf 3.15.7
  - Grpc.Tools 2.36.4
  - Grpc.Core 2.36.4
- Zipkin_gRPCClient
  - Grpc.Net.Client 2.36.0
  - Microsoft.Extensions.Configuration.Json 5.0.0
  - OpenTelemetry.Instrumentation.GrpcNetClient 1.0.0-rc3
  - OpenTelemetry.Exporter.Zipkin 1.1.0-beta1
- Zipkin_gRPCService
  - OpenTelemetry.Extensions.Hosting 1.0.0-rc3
  - OpenTelemetry.Instrumentation.AspNetCore 1.0.0-rc3
  - OpenTelemetry.Exporter.Zipkin 1.1.0-beta1

Zipkin 環境

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

設定方式

GrpcService
用來儲放共用的 proto 檔及產生的 grpc 實作 (proto 檔的處理不是固定做法)
1. 安裝 NuGet 套件
  - Google.Protobuf 3.15.7
  - Grpc.Tools 2.36.4
  - Grpc.Core 2.36.4
2. 設定 .ptoto build action
  將 .proto 產生 service 的對象設為 Both
```
<ItemGroup>
    <Protobuf Include="Protos\greet.proto" GrpcServices="Both" />
</ItemGroup>
```

Zipkin_gRPCClient

這邊以 console 專案 (ASP.NET Core 的建立方式以 Zipkin_gRPCService 相似) 來建立 gRPC client

安裝 NuGet 套件
- Grpc.Net.Client 2.36.0
- Microsoft.Extensions.Configuration.Json 5.0.0
- OpenTelemetry.Instrumentation.GrpcNetClient 1.0.0-rc3
- OpenTelemetry.Exporter.Zipkin 1.1.0-beta1

加入 Zipkin 設定值

{
    "Zipkin": {
        "ServiceName": "zipkin-grpc-client",
        "Endpoint": "http://localhost:9411/api/v2/spans"
    }
}

註冊 Zipkin

using var tracerProvider = Sdk.CreateTracerProviderBuilder()
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService(config.GetValue<string>("Zipkin:ServiceName")))
        .AddGrpcClientInstrumentation()
        .AddZipkinExporter(zipkinOptions =>
        {
            zipkinOptions.Endpoint = new Uri(config.GetValue<string>("Zipkin:Endpoint"));
        })
        .Build();

Zipkin_gRPCService

安裝 NuGet 套件
- OpenTelemetry.Extensions.Hosting 1.0.0-rc3
- OpenTelemetry.Instrumentation.AspNetCore 1.0.0-rc3
- OpenTelemetry.Exporter.Zipkin 1.1.0-beta1

加入 Zipkin 設定值

{
    "Zipkin": {
        "ServiceName": "zipkin-grpc-server",
        "Endpoint": "http://localhost:9411/api/v2/spans"
    }
}

註冊 Zipkin

services.AddOpenTelemetryTracing((builder) => builder
        .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService(this.Configuration.GetValue<string>("Zipkin:ServiceName")))
        .AddAspNetCoreInstrumentation()
        .AddZipkinExporter(zipkinOptions =>
        {
            zipkinOptions.Endpoint = new Uri(Configuration.GetValue<string>("Zipkin:Endpoint"));
        }));