MENU
  1. ホーム
  2. C#
  3. C#で始める分散トレーシング：基本から実践まで

C#で始める分散トレーシング：基本から実践まで

C#

分散トレーシングは、マイクロサービスアーキテクチャや分散システムにおいて重要な技術です。本記事では、C#で分散トレーシングを導入する方法を、基本的な概念から実際の実装手順まで詳しく解説します。分散トレーシングを使うことで、システムのパフォーマンスを最適化し、問題解決を迅速に行うための貴重な洞察を得ることができます。

目次

分散トレーシングとは

分散トレーシングは、分散システム内でリクエストがどのように流れるかを追跡する技術です。各サービス間の通信や処理時間を可視化し、ボトルネックの特定やパフォーマンスの最適化に役立ちます。特にマイクロサービスアーキテクチャにおいては、各サービスが独立して動作するため、トラブルシューティングが複雑になります。分散トレーシングを導入することで、これらの複雑性を解消し、システム全体の健全性を保つことができます。

分散トレーシングのメリット

分散トレーシングを導入することで得られる主なメリットは以下の通りです。

パフォーマンスの最適化

システム全体のパフォーマンスボトルネックを迅速に特定し、最適化することで、ユーザーエクスペリエンスを向上させることができます。

トラブルシューティングの効率化

各サービス間のリクエストの流れを追跡することで、問題発生時の原因特定が容易になり、迅速な問題解決が可能です。

リクエストの可視化

リクエストの流れを可視化することで、システムの動作を理解しやすくなり、開発者や運用担当者がシステムの挙動を把握しやすくなります。

サービス依存関係の把握

各サービス間の依存関係を明確にし、システム全体の構造を把握することで、より効率的な開発と運用が可能になります。

必要なツールとライブラリ

分散トレーシングをC#プロジェクトに導入するために必要なツールとライブラリを以下に紹介します。

OpenTelemetry

OpenTelemetryは、分散トレーシングのための標準ライブラリです。C#でも利用可能で、トレースデータの収集とエクスポートに必要な機能を提供します。

Jaeger

Jaegerは、トレースデータの収集、保存、可視化を行うためのオープンソースツールです。OpenTelemetryと連携して使用することができます。

Zipkin

ZipkinもJaeger同様、トレースデータの収集と可視化を行うためのツールで、簡単にセットアップでき、OpenTelemetryと連携して使用できます。

インストール方法

これらのツールやライブラリをインストールするためには、以下の手順を踏みます。

  1. NuGetパッケージマネージャーを使用して、OpenTelemetryパッケージをプロジェクトに追加します。
  2. JaegerまたはZipkinのサーバーをダウンロードし、ローカルまたはクラウド環境にデプロイします。
  3. OpenTelemetryを使用して、トレースデータをJaegerまたはZipkinにエクスポートする設定を行います。

C#プロジェクトへのライブラリの追加

C#プロジェクトに分散トレーシングライブラリを追加する手順を説明します。

NuGetパッケージの追加

まず、プロジェクトに必要なNuGetパッケージを追加します。以下のコマンドを使用して、OpenTelemetryライブラリをインストールします。

dotnet add package OpenTelemetry
dotnet add package OpenTelemetry.Extensions.Hosting
dotnet add package OpenTelemetry.Exporter.Jaeger
dotnet add package OpenTelemetry.Exporter.Zipkin

OpenTelemetryの設定

次に、Program.csまたはStartup.csファイルでOpenTelemetryを設定します。以下のようにサービスコレクションにOpenTelemetryを追加します。

using OpenTelemetry;
using OpenTelemetry.Trace;

var builder = WebApplication.CreateBuilder(args);

// Add OpenTelemetry Tracing
builder.Services.AddOpenTelemetryTracing(builder =>
{
    builder
        .AddAspNetCoreInstrumentation()
        .AddHttpClientInstrumentation()
        .AddJaegerExporter();  // Jaegerエクスポーターを使用する場合
        // .AddZipkinExporter();  // Zipkinエクスポーターを使用する場合
});

var app = builder.Build();

app.MapGet("/", () => "Hello World!");

app.Run();

JaegerまたはZipkinのエクスポート設定

最後に、JaegerまたはZipkinにトレースデータをエクスポートするための設定を行います。以下はJaegerエクスポーターを使用する場合の例です。

builder.Services.AddOpenTelemetryTracing(builder =>
{
    builder
        .AddJaegerExporter(jaegerOptions =>
        {
            jaegerOptions.AgentHost = "localhost"; // Jaegerサーバーのホスト名
            jaegerOptions.AgentPort = 6831; // Jaegerサーバーのポート番号
        });
});

これでC#プロジェクトにOpenTelemetryライブラリが追加され、トレースデータを収集し、JaegerまたはZipkinにエクスポートする準備が整いました。

トレースポイントの設定

コード内にトレースポイントを設定する方法を具体的に解説します。

トレースプロバイダーの設定

まず、トレースプロバイダーを設定します。これにより、コード内でトレースを開始および終了できます。

using OpenTelemetry.Trace;

// トレースプロバイダーの作成
var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource("MyCompany.MyProduct.MyLibrary")
    .AddJaegerExporter()
    .Build();

トレースの開始と終了

次に、コード内で特定の処理に対してトレースを設定します。以下の例では、特定のメソッドにトレースを設定しています。

using System.Diagnostics;

// トレースソースの作成
var source = new ActivitySource("MyCompany.MyProduct.MyLibrary");

void MyMethod()
{
    // トレースの開始
    using (var activity = source.StartActivity("MyMethod"))
    {
        // 実際の処理
        DoWork();

        // 必要に応じて属性を追加
        activity?.SetTag("key", "value");
    }
}

void DoWork()
{
    // ここで実際の作業を行います
}

トレース属性の追加

トレースに関連する属性を追加することで、より詳細な情報を収集できます。属性はキーと値のペアで追加されます。

using (var activity = source.StartActivity("MyMethod"))
{
    activity?.SetTag("http.method", "GET");
    activity?.SetTag("http.url", "https://example.com/resource");
    // 他の処理
}

カスタムイベントの追加

トレース中にカスタムイベントを追加することもできます。これにより、特定のポイントで追加情報を記録できます。

using (var activity = source.StartActivity("MyMethod"))
{
    activity?.AddEvent(new ActivityEvent("ProcessingStarted"));
    // 実際の処理
    activity?.AddEvent(new ActivityEvent("ProcessingCompleted"));
}

このようにして、コード内にトレースポイントを設定し、トレースデータを収集することができます。これにより、システムの動作を詳細に追跡し、問題解決やパフォーマンス最適化に役立てることができます。

トレースデータの収集

収集したトレースデータをどのように活用するか、具体例を交えて説明します。

トレースデータの収集方法

トレースデータは、トレースプロバイダーによって収集され、設定されたエクスポーター（例：JaegerやZipkin）に送信されます。これにより、各リクエストの詳細なトレースが記録されます。

トレースデータの送信

前述の設定を行うことで、トレースデータは自動的に設定されたエクスポーターに送信されます。以下は、Jaegerエクスポーターにデータを送信する例です。

var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .AddSource("MyCompany.MyProduct.MyLibrary")
    .AddJaegerExporter(options =>
    {
        options.AgentHost = "localhost";
        options.AgentPort = 6831;
    })
    .Build();

収集したデータの分析

トレースデータが収集されると、各リクエストの詳細な流れや、各サービス間の通信時間を分析できます。これにより、システム全体のパフォーマンスやボトルネックを特定することができます。

トレースの詳細表示

収集されたトレースデータは、JaegerやZipkinのインターフェースを使用して表示できます。以下の情報が確認できます。

  • 各リクエストの開始時間と終了時間
  • 各サービス間の通信時間
  • 各サービスでの処理時間
  • エラーの発生箇所と詳細

具体例：トレースデータの可視化

実際のトレースデータを使って、具体的な例を見てみましょう。以下は、Jaegerのインターフェースを使ってトレースデータを可視化する例です。

Trace ID: 1a2b3c4d5e6f7g8h9i0j
Span ID: 1234abcd5678efgh
Start Time: 2023-07-17T12:34:56Z
Duration: 1200ms
Service: MyService
Operation: MyOperation
Tags:
    http.method: GET
    http.url: https://example.com/resource

このデータをもとに、特定のリクエストの流れや、どの部分で時間がかかっているのかを分析し、最適化することができます。

分析と可視化ツールの活用

分散トレーシングデータを分析し、可視化するためのツールとその使い方を解説します。

Jaegerの活用

Jaegerは、分散トレーシングデータの収集、保存、検索、可視化を行うための強力なツールです。以下に、Jaegerの基本的な使い方を示します。

Jaegerのインストールとセットアップ

Jaegerをローカル環境にセットアップするには、以下のコマンドを使用します。

docker run -d --name jaeger \
  -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
  -p 5775:5775/udp \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 16686:16686 \
  -p 14268:14268 \
  -p 14250:14250 \
  -p 9411:9411 \
  jaegertracing/all-in-one:latest

Jaegerのインターフェースは、ブラウザでhttp://localhost:16686にアクセスすることで利用できます。

トレースデータの検索と可視化

Jaegerを使用してトレースデータを検索する手順は以下の通りです。

  1. Jaeger UIにアクセスします。
  2. サービス名、オペレーション名、タグなどを指定して検索を行います。
  3. 検索結果から特定のトレースを選択し、詳細を表示します。

表示されるトレースデータには、リクエストの流れや各サービス間の通信時間が可視化されます。

Zipkinの活用

Zipkinもまた、分散トレーシングデータの可視化に利用できるツールです。基本的なセットアップと使い方はJaegerと似ています。

Zipkinのインストールとセットアップ

Zipkinをローカル環境にセットアップするには、以下のコマンドを使用します。

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

Zipkinのインターフェースは、ブラウザでhttp://localhost:9411にアクセスすることで利用できます。

トレースデータの検索と可視化

Zipkinを使用してトレースデータを検索する手順は以下の通りです。

  1. Zipkin UIにアクセスします。
  2. サービス名やタグを指定して検索を行います。
  3. 検索結果から特定のトレースを選択し、詳細を表示します。

表示されるトレースデータには、各リクエストの詳細な流れや時間が示されます。

実践例：簡単なアプリケーションのトレーシング

具体的なアプリケーションを使ったトレーシングの実践例を紹介します。

簡単なWeb APIの作成

まず、C#で簡単なWeb APIを作成し、それに分散トレーシングを導入します。以下は、ASP.NET Coreを使用した簡単なWeb APIの例です。

using Microsoft.AspNetCore.Builder;
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using OpenTelemetry.Trace;

var builder = WebApplication.CreateBuilder(args);

// OpenTelemetryの設定
builder.Services.AddOpenTelemetryTracing(builder =>
{
    builder
        .AddAspNetCoreInstrumentation()
        .AddHttpClientInstrumentation()
        .AddJaegerExporter(jaegerOptions =>
        {
            jaegerOptions.AgentHost = "localhost";
            jaegerOptions.AgentPort = 6831;
        });
});

// Web APIの設定
builder.Services.AddControllers();

var app = builder.Build();

app.MapGet("/", () => "Hello World!");

app.MapControllers();

app.Run();

このコードは、簡単な「Hello World」エンドポイントを持つASP.NET Core Web APIを作成し、OpenTelemetryを使ってJaegerにトレースデータをエクスポートする設定を行っています。

コントローラーにトレーシングを追加

次に、APIのコントローラーにトレーシングを追加します。以下は、サンプルコントローラーの例です。

using Microsoft.AspNetCore.Mvc;
using OpenTelemetry.Trace;
using System.Diagnostics;

[ApiController]
[Route("[controller]")]
public class SampleController : ControllerBase
{
    private readonly ActivitySource _activitySource;

    public SampleController(ActivitySource activitySource)
    {
        _activitySource = activitySource;
    }

    [HttpGet]
    public IActionResult Get()
    {
        using (var activity = _activitySource.StartActivity("SampleController.Get"))
        {
            activity?.SetTag("custom-tag", "example");

            // 実際の処理
            return Ok("Traced response");
        }
    }
}

このコントローラーは、Getエンドポイントを持ち、トレーシングを行うためのActivityを作成しています。タグを追加することで、カスタムデータをトレースに含めることができます。

トレースデータの確認

アプリケーションを実行し、http://localhost:5000/sampleにアクセスしてAPIを呼び出します。その後、Jaeger UIにアクセスし、トレースデータを確認します。トレースデータには、SampleController.Getメソッドの呼び出しやカスタムタグが含まれています。

これにより、APIの各リクエストに対する詳細なトレースを収集し、問題の診断やパフォーマンスの分析が可能になります。

応用例：大規模システムでの利用

大規模システムにおける分散トレーシングの応用例とその効果を解説します。

マイクロサービスアーキテクチャのトレーシング

大規模なマイクロサービスアーキテクチャでは、多数のサービスが相互に通信し、リクエストを処理します。分散トレーシングを導入することで、以下の利点があります。

全体のリクエストフローの可視化

分散トレーシングにより、各サービス間のリクエストフローを可視化できます。これにより、どのサービスがボトルネックになっているかを迅速に特定できます。

エラーの早期検出と修正

トレースデータを分析することで、エラーが発生したサービスやその原因を早期に検出し、迅速に修正することができます。これにより、システムの信頼性が向上します。

具体例：オンラインショッピングプラットフォーム

オンラインショッピングプラットフォームを例に、大規模システムでの分散トレーシングの利用方法を紹介します。

サービス構成

  • ユーザーサービス：ユーザーの認証と情報管理を担当
  • 商品サービス：商品の情報と在庫管理を担当
  • 注文サービス：注文の処理と履歴管理を担当
  • 支払いサービス：支払い処理を担当

各サービス間でトレースデータを収集し、全体のリクエストフローを可視化します。

トレースの設定例

各サービスにOpenTelemetryを設定し、トレースデータをJaegerにエクスポートします。以下は、商品サービスの設定例です。

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddOpenTelemetryTracing(builder =>
{
    builder
        .AddAspNetCoreInstrumentation()
        .AddHttpClientInstrumentation()
        .AddJaegerExporter(jaegerOptions =>
        {
            jaegerOptions.AgentHost = "localhost";
            jaegerOptions.AgentPort = 6831;
        });
});

builder.Services.AddControllers();
var app = builder.Build();

app.MapControllers();
app.Run();

リクエストフローの可視化

Jaeger UIで、ユーザーが商品を購入する際のリクエストフローを確認します。以下のような情報が可視化されます。

  • ユーザーサービスでの認証処理
  • 商品サービスでの在庫確認
  • 注文サービスでの注文作成
  • 支払いサービスでの支払い処理

これにより、各リクエストがどのサービスでどのように処理されているかを詳細に把握できます。

大規模システムのメリット

大規模システムに分散トレーシングを導入することで、以下のメリットがあります。

  • システム全体のパフォーマンス向上
  • 問題の早期検出と迅速な修正
  • 開発・運用チーム間の連携強化
  • ユーザーエクスペリエンスの向上

トラブルシューティング

分散トレーシングの導入でよくある問題とその対策を説明します。

トレースデータが収集されない

トレースデータが収集されない場合、以下の点を確認してください。

ライブラリのインストールと設定

OpenTelemetryライブラリが正しくインストールされているか、設定が正しいか確認します。特に、トレースプロバイダーの設定やエクスポーターの設定を見直します。

builder.Services.AddOpenTelemetryTracing(builder =>
{
    builder
        .AddAspNetCoreInstrumentation()
        .AddHttpClientInstrumentation()
        .AddJaegerExporter(jaegerOptions =>
        {
            jaegerOptions.AgentHost = "localhost";
            jaegerOptions.AgentPort = 6831;
        });
});

ネットワーク設定

JaegerやZipkinサーバーが正しく起動しているか、ネットワーク設定に問題がないか確認します。Dockerコンテナを使用している場合は、ポートフォワーディングが正しく設定されているかも確認します。

docker run -d --name jaeger \
  -e COLLECTOR_ZIPKIN_HTTP_PORT=9411 \
  -p 5775:5775/udp \
  -p 6831:6831/udp \
  -p 6832:6832/udp \
  -p 5778:5778 \
  -p 16686:16686 \
  -p 14268:14268 \
  -p 14250:14250 \
  -p 9411:9411 \
  jaegertracing/all-in-one:latest

トレースデータが不完全

トレースデータが不完全な場合、以下の点を確認してください。

トレースポイントの設定

アプリケーション内のトレースポイントが適切に設定されているか確認します。すべての重要な処理に対してトレースが設定されているか見直します。

using (var activity = source.StartActivity("MyMethod"))
{
    activity?.SetTag("custom-tag", "value");
    // 実際の処理
}

依存サービスのトレース

依存する外部サービスやデータベース呼び出しに対してもトレースが設定されているか確認します。これにより、全体のリクエストフローが完全に追跡されます。

パフォーマンスへの影響

分散トレーシングの導入により、システムのパフォーマンスに影響が出る場合があります。以下の対策を検討してください。

サンプリングレートの調整

トレースデータのサンプリングレートを調整し、パフォーマンスへの影響を最小限に抑えます。サンプリングレートを低く設定することで、収集するトレースの数を減らすことができます。

builder.Services.AddOpenTelemetryTracing(builder =>
{
    builder
        .AddAspNetCoreInstrumentation()
        .AddHttpClientInstrumentation()
        .SetSampler(new TraceIdRatioBasedSampler(0.1)) // サンプリングレートを10%に設定
        .AddJaegerExporter();
});

トレースデータの最適化

必要なトレースデータのみを収集し、不要なデータは収集しないように設定を最適化します。これにより、パフォーマンスへの影響を軽減できます。

これらの対策を講じることで、分散トレーシングの導入に伴う問題を解決し、システムの信頼性とパフォーマンスを向上させることができます。

まとめ

本記事では、C#での分散トレーシングの導入方法について、基本概念から実践的な設定手順まで詳しく解説しました。分散トレーシングを導入することで、システム全体のパフォーマンスの最適化、トラブルシューティングの効率化、リクエストフローの可視化といった多くのメリットが得られます。特に大規模なマイクロサービスアーキテクチャにおいては、その効果は顕著です。OpenTelemetry、Jaeger、Zipkinといったツールを活用し、システムの健全性を維持しつつ、迅速な問題解決を図りましょう。これからも分散トレーシングを活用して、より信頼性の高いシステムを構築してください。

C#
パフォーマンス デバッグ マイクロサービス C# 分散トレーシング

コメント

コメントする

目次