CodeGym /コース /C# SELF /分散トレーシングとテレメトリ

分散トレーシングとテレメトリ

C# SELF
レベル 64, レッスン 4
使用可能

1. はじめに

現代のサービス指向アーキテクチャ(SOA)、マイクロサービス、クラウドソリューションの世界では、1つのユーザーリクエストが結果を返すまでに何十もの異なるサービスを「通過」することがあります。それぞれのノードはログを書きますが、ある場所でのエラーや遅延が特定のリクエストに本当に関連しているかどうかはどうやって分かるでしょうか?

分散トレーシング は物流の荷物追跡システムのようなものです:どの拠点を荷物が通ったか、どこで遅延したか、どこでトラブルが起きたかが見えます。プログラミングの世界では、1つのリクエストの「旅路」を全サービスにわたって追跡し、どこでどれだけ時間を費やしたか、どこでエラーや遅延が発生したかを理解するための手段です。

なぜトレーシングが必要なのか?

  • 障害の局所化:問題が起きたとき、どのサービスのどのステップ、さらにはどのメソッドが呼ばれたかをすぐに確認できます。
  • ボトルネックの検出:トレーシングはどのサービスが「遅く」なっているか、どのステップで最も時間を失っているかを示します。
  • ユーザーシナリオの分析:クライアントがサービスを実際にどう使っているかを理解し、最初にどこを最適化すべきかを判断できます。

仕組みはどうなっているのか?

各リクエストにはユニークなトレース識別子(TraceId)が付与され、フロントエンドからバックエンド、APIからデータベースまでサービスの全スタックを通じて「移動」します。各ステップで「スパン」(spans)が作られ、操作の実行時間や追加のイベントを記録します。結果として、操作のツリー(グラフ)とそれぞれの所要時間、相互関係が得られます。

分散トレーシングの主要なエンティティと用語

用語 説明
トレース (Trace) 1つのリクエストが複数のサービスを通る論理的な経路。TraceIdによって一意に識別されます。
スパン (Span) トレース内の操作またはサブ操作。それぞれのスパンは固有の識別子を持ちます。
TraceId トレース全体(リクエスト全体)を一意に識別するID。
SpanId 現在のスパン(操作)を一意に識別するID。
Parent SpanId 親スパンのId(このスパンが別の操作の一部である場合)。
Attributes スパンのためのユーザーメタデータのセット:メソッド名、パラメータ、ステータスなど。
Events/Logs スパンに関連する重要なイベント(例:エラー、完了)。
Context Propagation サービス間やスレッド間でトレース情報を渡す仕組み。

2. OpenTelemetry:観測のためのオープンスタンダード

OpenTelemetryについて簡単に

OpenTelemetry は、さまざまなアプリケーションからテレメトリ(トレーシング、メトリクス、ログ)を収集するためのオープンな標準とツール群です。Cloud Native Computing Foundation (CNCF) によってサポートされ、クラウドや分散アプリケーションの世界では事実上の標準になっています。

OpenTelemetry(略して OTel)は以下ができます:

  • トレース、メトリクス、ログを自動的に収集して送信する;
  • C#、Java、Python など主要なプログラミング言語をサポートする;
  • データを Jaeger、Zipkin、Azure Monitor、Grafana などの観測システムへエクスポートする;
  • プラグインで拡張したり、任意のスタックに合わせて設定できる。

なぜ OpenTelemetry を使うのか?

  • ベンダー非依存:OTel は特定企業のプロダクトではなく標準です。
  • 互換性:主要なトレースフォーマットをサポートし、APMシステムと簡単に統合できます。
  • 自動化:HTTPリクエストのトレーシングなど、多くの作業を最小限の設定で自動化できます。
  • スケーラビリティ:小規模から大規模なシステムまでうまく動作します。

OpenTelemetryのアーキテクチャ(ざっくり)

「レイヤー」で迷わないように、OTelにおける典型的なトレースデータの流れを可視化してみます。

flowchart LR
    subgraph アプリケーション
        A[OpenTelemetry SDK]
    end
    A -->|トレース、メトリクス、ログ| B[OpenTelemetry Collector]
    B -->|エクスポート先| C[Jaeger/Zipkin/Grafana/Azure/Application Insights など]
  1. OpenTelemetry SDK:アプリケーションに直接組み込む(例:.NET用のNuGetパッケージで導入)。
  2. OTel Collector:別の集約サービス(多くの場合 Docker コンテナとしてデプロイ)で、全アプリケーションからトレースデータを受け取り、指定先へエクスポートします。
  3. 観測のフロントエンド:きれいなグラフやツリーを見られるシステムで、フィルタやトレース解析を行います。

3. C#/.NETでトレーシングをすばやく始める

学習用アプリケーションに基本的な分散トレーシングを追加しましょう。主な手順はかなりシンプルです。

NuGetパッケージのインストール

dotnet add package OpenTelemetry
dotnet add package OpenTelemetry.Exporter.Console

OpenTelemetry — SDKの基本実装;
OpenTelemetry.Exporter.Console — トレースをコンソールにエクスポート(JaegerやZipkinなどに置き換え可能)。

最小限のトレーシング設定

Program.cs ファイル(コンソールアプリ向け):

using OpenTelemetry;
using OpenTelemetry.Trace;

class Program
{
    static void Main(string[] args)
    {
        // トレーシングを設定する
        using var tracerProvider = Sdk.CreateTracerProviderBuilder()
            .AddSource("DemoApp") // ソース名を指定
            .AddConsoleExporter() // トレースをコンソールへエクスポート
            .Build();

        var source = new System.Diagnostics.ActivitySource("DemoApp");

        // 新しいトレース(ルートスパン)を開始
        using (var activity = source.StartActivity("メイン操作"))
        {
            DoWork();
        }
    }

    static void DoWork()
    {
        // アプリのロジック...
        System.Threading.Thread.Sleep(300);
    }
}

ここで何が起きているか?

  • トレーサープロバイダを作成し、ソース("DemoApp")を登録し、コンソールエクスポータ AddConsoleExporter() を追加しています。
  • プログラムのルートで ActivitySource を使って新しいアクティビティ(span)を開始します。
  • その中でトレースしたい処理を実行します。

結果:

Activity.Id:          0b69e3e97ca5f14d
Activity.Operation:   メイン操作
Duration: 00:00:00.3001082
...

HTTPやデータベースの自動トレーシング

OpenTelemetry は一般的なライブラリの instrumentation(自動計測)をサポートしています。例えば、HttpClient 経由の呼び出しや(ADO.NETを使った)DBクエリは、あなたの明示的なコードなしに収集できます。

using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddHttpClientInstrumentation() // HTTPリクエスト
    .AddSqlClientInstrumentation()  // SQLリクエスト(使っている場合)
    .AddConsoleExporter()
    .Build();

これで HttpClient を使った全ての呼び出しや、SQL関連の処理が自動的にトレースに現れます。

4. トレーシングの可視化

コンソール出力は最初のステップにすぎません。本当に有益なのは可視化フロントエンドを使うことです。

Jaeger

Jaeger はトレーシングの可視化でよく使われるオープンソースのシステムです。

  1. Jaeger を展開する(例:Docker で起動)。
  2. AddConsoleExporter() の代わりに次を使います:
    .AddJaegerExporter(options =>
    {
        options.AgentHost = "localhost";
        options.AgentPort = 6831;
    })
    
  3. これで全てのトレースが Jaeger UI に表示され、TraceId でフィルタしたり、詳細なタイムチャートを確認できます。

完全な手順はこちら: OpenTelemetry Jaeger Exporter for .NET

5. 便利なポイント(ヌアンス)

手法の比較

OTel を使わない場合、TraceId を手動でログに付けてコピーしていき、次の人に渡すのを忘れないように祈る、という運用になります。OTel を使えばチェーンは自動で構築され、ワンクリックで可視化できます。

アプローチ 工数 信頼性 スケーラビリティ 互換性
TraceIdを手動ログに書く 高い 低い 継続的なメンテが必要 自分たちのアプリのみ
OpenTelemetry 導入後は最小限 保証される 広範(どの言語、スタックでも) ほとんどのAPMやログシステムと互換性あり

アーキテクチャの例

[ウェブクライアント] --> [APIサービス] --> [認証サービス] --> [データベースサービス]

ユーザーがボタンをクリックすると、リクエストはこれらのサービスを経由します。OTel を使えば、各サービスで TraceId を「紡いで」一つのトレースに自動的にまとめられます。

  • 各サービスの SDK が HTTP ヘッダから TraceId を自動的に認識してチェーンを継続します。
  • 結果として、1本のトレースを開くだけでミリ秒単位でどこに時間が使われたか、何が起きていたか、どこでエラーが起きたかが見られます。

実プロジェクトや面接での活用

  • マイクロサービスや分散アプリケーション(フィンテック、マーケットプレイス、SaaSなど)。
  • DevOps/SRE:障害の速い局所化。
  • SLAやサービスの応答性改善。
  • プロファイリングや最適化。
  • 面接でのアピール:成熟したエンジニアリングプラクティスを示せます。

6. よくあるミスと実装上の注意点

TraceContextを渡し忘れる。 サービス間で TraceId が渡らない(例えば必要なHTTPヘッダをプロキシし忘れた)と、トレースは分断され、個別の「点」として現れるだけで観測の利便性が失われます。

インストルメントされていないコード。 ライブラリやフレームワークが自動計測をサポートしていないと、一部の操作がトレースから抜け落ちます(その場合は ActivitySource と StartActivity() を使って手動でスパンを作ることができます)。

データの過剰収集。 すべてのリクエストをトレースするのはコストが高いです。プロダクションでは通常、サンプリング率を設定したり、一部のリクエストのみ(エラーやスローレスポンスなど)をトレースする運用を行います。

パフォーマンス。 非同期エクスポートを使えば OTel の導入はパフォーマンスに与える影響は最小化できますが、トラフィックが非常に多い場合はオーバーヘッドに注意し、サンプリングを調整してください。

1
アンケート/クイズ
ロギング、レベル 64、レッスン 4
使用不可
ロギング
Logging、モニタリングとトレーシング
コメント
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION