チュートリアル: .NET Core で EventCounters を使用してパフォーマンスを測定する

[アーティクル]
06/23/2023

この記事の対象: ✔️ .NET Core 3.0 SDK 以降のバージョン

このチュートリアルでは、EventCounter を使用して、イベントの頻度が高い状態でパフォーマンスを測定する方法について説明します。さまざまな公式 .NET Core パッケージまたはサードパーティプロバイダーによって発行された使用可能なカウンターを使用することも、監視用に独自のメトリックを作成することもできます。

このチュートリアルでは、次のことについて説明します。

EventSource の実装。
dotnet-counters を使用したカウンターの監視。

必須コンポーネント

このチュートリアルでは次のものを使用します。

.NET Core 3.1 SDK 以降のバージョン。
イベントカウンターを監視するための dotnet-counters。
診断するサンプルデバッグターゲットアプリ。

ソースを入手する

監視のための基礎としてサンプルアプリケーションを使用します。サンプルの ASP.NET Core リポジトリをサンプルブラウザーから利用できます。 zip ファイルをダウンロードし、ダウンロード後に展開して、普段使用している IDE で開きます。アプリケーションをビルドして実行し、正常に動作することを確実にしてから、アプリケーションを停止します。

EventSource を実装する

数ミリ秒ごとに発生するイベントの場合は、イベントごとのオーバーヘッドを低くする必要があります (ミリ秒未満)。そうしないと、パフォーマンスへの影響が大きくなります。イベントをログに記録すると、ディスクに何かが書き込まれることになります。ディスクの速度が十分でない場合は、イベントが失われます。イベント自体をログに記録する以外の解決策が必要です。

多数のイベントを処理する場合、イベントごとの測定値を知ることも役に立ちません。ほとんどの場合、必要なのはそれから得られる統計情報だけです。そのため、プロセス自体に含まれる統計情報を取得し、ときどきイベントを書き込んで統計情報を報告することができます。それが EventCounter で行われることです。

System.Diagnostics.Tracing.EventSource を実装する方法の例を次に示します。 MinimalEventCounterSource.cs という名前の新しいファイルを作成し、そのソースとして次のコードスニペットを使用します。

using System.Diagnostics.Tracing;

[EventSource(Name = "Sample.EventCounter.Minimal")]
public sealed class MinimalEventCounterSource : EventSource
{
    public static readonly MinimalEventCounterSource Log = new MinimalEventCounterSource();

    private EventCounter _requestCounter;

    private MinimalEventCounterSource() =>
        _requestCounter = new EventCounter("request-time", this)
        {
            DisplayName = "Request Processing Time",
            DisplayUnits = "ms"
        };

    public void Request(string url, long elapsedMilliseconds)
    {
        WriteEvent(1, url, elapsedMilliseconds);
        _requestCounter?.WriteMetric(elapsedMilliseconds);
    }

    protected override void Dispose(bool disposing)
    {
        _requestCounter?.Dispose();
        _requestCounter = null;

        base.Dispose(disposing);
    }
}

EventSource.WriteEvent の行は EventSource パーツであり、EventCounter のパーツではありません。イベントカウンターと共にメッセージをログに記録できることを示すために記述されています。

アクションフィルターを追加する

サンプルのソースコードは、ASP.NET Core プロジェクトです。要求の合計時間をログに記録するアクションフィルターをグローバルに追加できます。 LogRequestTimeFilterAttribute.cs という名前の新しいファイルを作成し、次のコードを使用します。

using System.Diagnostics;
using Microsoft.AspNetCore.Http.Extensions;
using Microsoft.AspNetCore.Mvc.Filters;

namespace DiagnosticScenarios
{
    public class LogRequestTimeFilterAttribute : ActionFilterAttribute
    {
        readonly Stopwatch _stopwatch = new Stopwatch();

        public override void OnActionExecuting(ActionExecutingContext context) => _stopwatch.Start();

        public override void OnActionExecuted(ActionExecutedContext context)
        {
            _stopwatch.Stop();

            MinimalEventCounterSource.Log.Request(
                context.HttpContext.Request.GetDisplayUrl(), _stopwatch.ElapsedMilliseconds);
        }
    }
}

アクションフィルターによって要求の開始時に Stopwatch を開始し、完了後に停止して、経過時間をキャプチャします。合計時間 (ミリ秒) は MinimalEventCounterSource シングルトンインスタンスに記録されます。このフィルターを適用するには、フィルターコレクションに追加する必要があります。 Startup.cs ファイルで、このフィルターを含めるように ConfigureServices メソッドを更新します。

public void ConfigureServices(IServiceCollection services) =>
    services.AddControllers(options => options.Filters.Add<LogRequestTimeFilterAttribute>())
            .AddNewtonsoftJson();

イベントカウンターを監視する

EventSource の実装とカスタムアクションフィルターを使用して、アプリケーションをビルドして起動します。 EventCounter にメトリックを記録しましたが、それから得られる統計情報にアクセスしない限り、それは役に立ちません。統計を取得するには、イベントをキャプチャするリスナーだけでなく、必要な頻度で起動するタイマーを作成して、EventCounter を有効にする必要があります。これを行うために、dotnet-counters を使用できます。

dotnet-counters ps コマンドを使用して、監視できる .NET プロセスの一覧を表示します。

dotnet-counters ps

dotnet-counters ps コマンドの出力にあるプロセス識別子を使用し、次の dotnet-counters monitor コマンドを使ってイベントカウンターの監視を開始できます。

dotnet-counters monitor --process-id 2196 --counters Sample.EventCounter.Minimal,Microsoft.AspNetCore.Hosting[total-requests,requests-per-second],System.Runtime[cpu-usage]

dotnet-counters monitor コマンドの実行中に、https://localhost:5001/api/values エンドポイントへの継続的な要求の発行を開始するために、ブラウザーで F5 キーを押します。数秒後に q キーを押して終了します。

Press p to pause, r to resume, q to quit.
    Status: Running

[Microsoft.AspNetCore.Hosting]
    Request Rate / 1 sec                               9
    Total Requests                                   134
[System.Runtime]
    CPU Usage (%)                                     13
[Sample.EventCounter.Minimal]
    Request Processing Time (ms)                      34.5

dotnet-counters monitor コマンドは、アクティブな監視に適しています。ただし、これらの診断メトリックを収集して、後処理や分析を行うこともできます。そのためには、dotnet-counters collect コマンドを使用します。 collect スイッチコマンドは、monitor コマンドに似ていますが、いくつかの追加パラメーターを受け取ります。目的の出力ファイル名と形式を指定できます。 diagnostics.json という名前の JSON ファイルの場合、次のコマンドを使用します。

dotnet-counters collect --process-id 2196 --format json -o diagnostics.json --counters Sample.EventCounter.Minimal,Microsoft.AspNetCore.Hosting[total-requests,requests-per-second],System.Runtime[cpu-usage]

コマンドの実行中に再度ブラウザーで F5 キーを押して、https://localhost:5001/api/values エンドポイントへの継続的な要求の発行を開始します。数秒後に q キーを押します。 diagnostics.json ファイルが書き込まれます。ただし、書き込まれた JSON ファイルはインデントされません。ここでは読みやすくするためにインデントしています。

{
  "TargetProcess": "DiagnosticScenarios",
  "StartTime": "8/5/2020 3:02:45 PM",
  "Events": [
    {
      "timestamp": "2020-08-05 15:02:47Z",
      "provider": "System.Runtime",
      "name": "CPU Usage (%)",
      "counterType": "Metric",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:47Z",
      "provider": "Microsoft.AspNetCore.Hosting",
      "name": "Request Rate / 1 sec",
      "counterType": "Rate",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:47Z",
      "provider": "Microsoft.AspNetCore.Hosting",
      "name": "Total Requests",
      "counterType": "Metric",
      "value": 134
    },
    {
      "timestamp": "2020-08-05 15:02:47Z",
      "provider": "Sample.EventCounter.Minimal",
      "name": "Request Processing Time (ms)",
      "counterType": "Metric",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:47Z",
      "provider": "System.Runtime",
      "name": "CPU Usage (%)",
      "counterType": "Metric",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:48Z",
      "provider": "Microsoft.AspNetCore.Hosting",
      "name": "Request Rate / 1 sec",
      "counterType": "Rate",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:48Z",
      "provider": "Microsoft.AspNetCore.Hosting",
      "name": "Total Requests",
      "counterType": "Metric",
      "value": 134
    },
    {
      "timestamp": "2020-08-05 15:02:48Z",
      "provider": "Sample.EventCounter.Minimal",
      "name": "Request Processing Time (ms)",
      "counterType": "Metric",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:48Z",
      "provider": "System.Runtime",
      "name": "CPU Usage (%)",
      "counterType": "Metric",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:50Z",
      "provider": "Microsoft.AspNetCore.Hosting",
      "name": "Request Rate / 1 sec",
      "counterType": "Rate",
      "value": 0
    },
    {
      "timestamp": "2020-08-05 15:02:50Z",
      "provider": "Microsoft.AspNetCore.Hosting",
      "name": "Total Requests",
      "counterType": "Metric",
      "value": 134
    },
    {
      "timestamp": "2020-08-05 15:02:50Z",
      "provider": "Sample.EventCounter.Minimal",
      "name": "Request Processing Time (ms)",
      "counterType": "Metric",
      "value": 0
    }
  ]
}

次のステップ

EventCounters

次の方法で共有

チュートリアル: .NET Core で EventCounters を使用してパフォーマンスを測定する

必須コンポーネント

ソースを入手する

EventSource を実装する

アクションフィルターを追加する

イベントカウンターを監視する

次のステップ

その他のリソース

次の方法で共有

チュートリアル: .NET Core で EventCounters を使用してパフォーマンスを測定する

必須コンポーネント

ソースを入手する

EventSource を実装する

アクション フィルターを追加する

イベント カウンターを監視する

次のステップ

その他のリソース

アクションフィルターを追加する

イベントカウンターを監視する