當 .NET 5 遇上OpenTelemetry，會碰撞出怎樣的火花？
阿新 • • 發佈：2021-02-03
# OpenTelemetry 介紹
我在之前的幾篇文章都介紹了 OpenTelemetry, 你可以在這裡找到
[OpenTelemetry - 雲原生下可觀測性的新標準](https://www.cnblogs.com/myshowtime/p/14267705.html "OpenTelemetry - 雲原生下可觀測性的新標準")
[深入研究 .NET 5 的開放式遙測](https://www.cnblogs.com/myshowtime/p/14312984.html "深入研究 .NET 5 的開放式遙測")
OpenTelemetry是谷歌和微軟共同推進的雲原生監控的新規範， 相容OpenTracing和OpenCensus
OpenTelemetry的終極目標是：實現Metrics、Tracing、Logging的融合及大一統，作為APM的資料採集終極解決方案。
> 因為現在正式版本還沒有釋出，我們現在只能使用rc版本，所以在Nuget開啟 包括預發行版,你可以在這裡看到里程碑，[https://github.com/open-telemetry/opentelemetry-dotnet/milestones](https://github.com/open-telemetry/opentelemetry-dotnet/milestones "https://github.com/open-telemetry/opentelemetry-dotnet/milestones")
# 在webapi中接入OpenTelemetry服務
建立一個webapi專案，.NET 版本選5.0, 建立完成後，需要安裝下邊幾個包，選最新版本就好
`OpenTelemetry.Extensions.Hosting` 提供服務擴充套件
`OpenTelemetry.Instrumentation.AspNetCore` 採集AspNetCore診斷資料
`OpenTelemetry.Instrumentation.Http` 採集Http診斷資料
安裝完成後，修改Startup.cs的 ConfigureServices() 方法
```csharp
public void ConfigureServices(IServiceCollection services)
{
services.AddOpenTelemetryTracing((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
);
....
}
```
接下來，修改 WeatherForecastController, 來模擬簡單的介面呼叫
```csharp
[HttpGet]
public async Task Get()
{
HttpClient client = new HttpClient();
await Task.Delay(new Random().Next(1000, 3000));
_ = await client.GetStringAsync("http://www.baidu.com");
await Task.Delay(new Random().Next(1000, 3000));
_ = await client.GetStringAsync("http://www.baidu.com");
return Ok();
}
```
上面的工作完成以後，我們還需要一個匯出 Exporter 的元件，把資料匯出到外部平臺，比如Jaeger, Zipkin, Prometheus 等，然後這些平臺會處理資料，然後展示出來。
# ConsoleExporter
ConsoleExporter 是最簡單的匯出資料的實現，它會把診斷資料輸出到控制檯
安裝包 `OpenTelemetry.Exporter.Console`，然後修改 ConfigureServices 如下：
```csharp
services.AddOpenTelemetryTracing((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddConsoleExporter()
);
```
然後啟動我們的專案，訪問 http://localhost:5000/WeatherForecast 介面，控制檯會輸出下面的資訊：
這些是診斷資料的基礎格式，如果你瞭解OpenTracing，你會發現，為什麼這裡是 Activity，而不是 Span，這不符合規範。 確實是這樣，因為.NET 中已經有了 Activity 型別，所以.NET 團隊決定重用它，並且在 .NET 5增強為 ActivitySource, 所以在.NET 中，你可以把 Span 和 Activity 概念互換。
# JaegerExporter
Jaeger 是Uber推出的一款開源分散式追蹤系統。
安裝包 `OpenTelemetry.Exporter.Jaeger`，然後修改 ConfigureServices 如下：
```csharp
services.AddOpenTelemetryTracing((builder) => builder
.SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("webapi-demo"))
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddJaegerExporter(options => {
options.AgentHost = "localhost";
options.AgentPort = 6831;
})
);
```
在Docker中，執行下邊的命令，安裝Jaeger
```csharp
docker run -d --name jaeger \
-p 5775:5775/udp \
-p 6831:6831/udp \
-p 6832:6832/udp \
-p 5778:5778 \
-p 16686:16686 \
-p 14268:14268 \
-p 14250:14250 \
jaegertracing/all-in-one:1.21
```
稍等片刻，安裝完成以後，訪問 http://localhost:16686 可以看到Jaeger的頁面
然後啟動我們的專案，訪問幾次 http://localhost:5000/WeatherForecast 介面，然後再訪問Jaeger的頁面，選擇我們的服務查詢，可以看到下邊的請求資訊：
# ZipkinExporter
Zipkin 是Twitter推出的一款開源分散式追蹤系統。
安裝包 `OpenTelemetry.Exporter.Zipkin`，然後修改 ConfigureServices 如下：
```csharp
services.AddOpenTelemetryTracing((builder) => builder
.AddAspNetCoreInstrumentation()
.AddHttpClientInstrumentation()
.AddZipkinExporter(options => {
options.ServiceName = "webapi-demo";
options.Endpoint = new Uri("http://localhost:9411/api/v2/spans");
})
);
```
在Docker中，執行下邊的命令，安裝Zipkin
```csharp
docker run -d -p 9411:9411 openzipkin/zipkin
```
安裝完成後，訪問 http://localhost:9411 可以看到Zipkin的首頁：
然後啟動我們的專案，訪問幾次 http://localhost:5000/WeatherForecast 介面，然後再回到Zipkin的頁面， 可以看到下面的請求資訊：
trace的頁面：
# 總結
本文嘗試在.NET 5 中引入了 OpenTelemetry，可以看到使用起來非常的方便，對接第三方的分散式追蹤平臺，我們只需要改動極少的程式碼，這就是OpenTelemetry大一統的標準。
## 最後
歡迎掃碼關注我們的公眾號 【全球技術精選】，可以加入到.NET APM Group 微信群, 一起來交流APM和監控相關的技術。
