メトリクスを始める - コンソール
このガイドでは、.NET コンソールアプリケーションで OpenTelemetry .NET メトリクスを数分で始める方法を紹介します。
前提条件
- .NET SDK がコンピューターにインストールされていること
コンソールアプリケーションの作成
新しいコンソールアプリケーションを作成して実行します。
dotnet new console --output getting-started
cd getting-started
dotnet run
以下のような出力が表示されるはずです。
Hello World!
OpenTelemetry メトリクスの追加
OpenTelemetry Console Exporter パッケージをインストールします。
dotnet add package OpenTelemetry.Exporter.Console
Program.cs ファイルを以下のコードで更新します。
using System;
using System.Diagnostics.Metrics;
using OpenTelemetry;
using OpenTelemetry.Metrics;
// メーターを定義する
private static readonly Meter MyMeter = new("MyCompany.MyProduct.MyLibrary", "1.0");
// カウンター計装を作成する
private static readonly Counter<long> MyFruitCounter = MyMeter.CreateCounter<long>("MyFruitCounter", "fruit", "Counts fruit by name and color");
// OpenTelemetry MeterProvider を設定する
var meterProvider = Sdk.CreateMeterProviderBuilder()
.AddMeter("MyCompany.MyProduct.MyLibrary")
.AddConsoleExporter()
.Build();
// いくつかの計測を記録する
MyFruitCounter.Add(1, new("name", "apple"), new("color", "red"));
MyFruitCounter.Add(2, new("name", "lemon"), new("color", "yellow"));
MyFruitCounter.Add(1, new("name", "lemon"), new("color", "yellow"));
MyFruitCounter.Add(2, new("name", "apple"), new("color", "green"));
MyFruitCounter.Add(5, new("name", "apple"), new("color", "red"));
MyFruitCounter.Add(4, new("name", "lemon"), new("color", "yellow"));
Console.WriteLine("Press any key to exit");
Console.ReadKey();
// アプリケーションが終了する前に MeterProvider を破棄する。
// これにより、残りのメトリクスがフラッシュされ、メトリクスパイプラインがシャットダウンされる。
meterProvider.Dispose();
アプリケーションを再度実行すると（dotnet run を使用）、コンソールからメトリクスの出力が確認できます（メトリクスはプログラム終了時に表示されます）。
以下のような出力になります。
Export MyFruitCounter, Meter: MyCompany.MyProduct.MyLibrary/1.0
(2021-09-23T22:00:08.4399776Z, 2021-09-23T22:00:08.4510115Z) color:red name:apple LongSum
Value: 6
(2021-09-23T22:00:08.4399776Z, 2021-09-23T22:00:08.4510115Z) color:yellow name:lemon LongSum
Value: 7
(2021-09-23T22:00:08.4399776Z, 2021-09-23T22:00:08.4510115Z) color:green name:apple LongSum
Value: 2
おめでとうございます！ これで OpenTelemetry を使用してメトリクスを収集できるようになりました。
仕組み
Meter
プログラムは「MyCompany.MyProduct.MyLibrary」という名前の Meter インスタンスを作成します。 Meter はメトリクス計装を作成するためのエントリーポイントです。
private static readonly Meter MyMeter = new("MyCompany.MyProduct.MyLibrary", "1.0");
カウンター計装
次に、Meter から Counter 計装を作成します。 カウンターは、減少しない値を計測するために使用されます。
private static readonly Counter<long> MyFruitCounter = MyMeter.CreateCounter<long>("MyFruitCounter");
計測の記録
カウンターは、異なる属性の組み合わせで複数のメトリクス計測を報告するために使用されます。
MyFruitCounter.Add(1, new("name", "apple"), new("color", "red"));
MeterProvider の設定
OpenTelemetry MeterProvider は以下のように設定されます。
- 指定した Meter からの計装をサブスクライブする
- メトリクスをコンソールにエクスポートする
var meterProvider = Sdk.CreateMeterProviderBuilder()
.AddMeter("MyCompany.MyProduct.MyLibrary")
.AddConsoleExporter()
.Build();
MeterProvider は計測をメモリ内で集約し、デフォルトのカーディナリティ上限は属性の組み合わせ2000件です。
高カーディナリティメトリクスの処理
デフォルトの上限である2000を超えるカーディナリティのメトリクスを収集する必要がある場合は、カーディナリティの上限をカスタマイズできます。
var meterProvider = Sdk.CreateMeterProviderBuilder()
.AddMeter("MyCompany.MyProduct.MyLibrary")
.AddView(instrumentName: "MyFruitCounter", new MetricStreamConfiguration { CardinalityLimit = 10 })
.AddConsoleExporter()
.Build();
メトリクスパイプライン
OpenTelemetry .NET のメトリクスパイプラインは以下のフローに従います。
- 計装が計測を記録する
- MeterProvider が計測を受信し集約する
- MetricReader が集約されたメトリクスを読み取る
- エクスポーターがメトリクスをバックエンドにエクスポートする
OpenTelemetry .NET に関する特記事項
OpenTelemetry .NET のメトリクスはやや独特な実装です。
Metrics API の大部分が .NET ランタイム自体によって実装されているためです。
大まかに言えば、System.Diagnostics.DiagnosticSource パッケージに依存するだけで、アプリケーションを計装できるということです。
さらに学ぶ
フィードバック
このページは役に立ちましたか?
Thank you. Your feedback is appreciated!
Please let us know how we can improve this page. Your feedback is appreciated!