Service Bus メッセージングを介した分散トレースおよび相関付け

[アーティクル]
12/19/2024

マイクロサービス開発に共通する問題の 1 つは、クライアントからの操作を、処理に関係するすべてのサービスにおいてトレースする機能です。これは、デバッグ、パフォーマンス分析、A/B テスト、およびその他の一般的な診断シナリオで役立ちます。この問題の 1 つの部分は、メッセージ処理の結果と待機時間、外部依存関係の呼び出しを含む、作業の論理的な部分を追跡することです。もう 1 つの部分は、これらの診断イベントのプロセス境界を越えた相関付けです。

プロデューサーがキューを介してメッセージを送信すると、通常、そのメッセージは他の論理操作 (他のクライアントまたはサービスが開始した) のスコープ内で発生します。メッセージを受信すると、同じ操作がコンシューマーによって続行されます。プロデューサーとコンシューマーの両方 (および操作を処理する他のサービス) は、操作のフローと結果をトレースするためにテレメトリイベントを出力すると推定されます。このようなイベントを相関付けて、操作をエンドツーエンドでトレースするために、テレメトリをレポートする各サービスは、すべてのイベントにトレースコンテキストをスタンプする必要があります。

Microsoft Azure Service Bus メッセージングによってペイロードプロパティが定義され、プロデューサーとコンシューマーはこれを使用してトレースコンテキストを渡す必要があります。プロトコルは W3C トレースコンテキストに基づいています。

Azure.Messaging.ServiceBus SDK (最新)
Microsoft.Azure.ServiceBus SDK

プロパティ名	説明
`Diagnostic-Id`	プロデューサーからキューへの外部呼び出しの一意識別子。形式については、「W3C トレースコンテキスト traceparent ヘッダー」を参照してください

Service Bus .NET クライアントの自動トレース

.NET 用 Azure Messaging Service Bus クライアントの ServiceBusProcessor クラスにより、トレースインストルメンテーションポイントが提供され、トレーシングシステムまたはクライアントコードの一部でこれを受け取ることができます。インストルメンテーションによって、すべての呼び出しをクライアント側から Service Bus メッセージングサービスまで追跡できるようになります。メッセージの処理が ServiceBusProcessor の ProcessMessageAsync (メッセージハンドラーパターン) を使用して行われる場合は、メッセージの処理もインストルメント化されます。

Azure Application Insights で追跡する

Microsoft Application Insights では、自動的な要求と依存関係の追跡も含め、豊富なパフォーマンス監視機能が提供されます。

プロジェクトタイプに応じて次のいずれかの Application Insights SDK をインストールします。

ASP.NET - バージョン 2.5-beta2 以上をインストールします
ASP.NET Core - バージョン 2.2.0-beta2 以上をインストールします。これらのリンクには、SDK のインストール、リソースの作成、SDK の構成 (必要な場合) に関する説明があります。 ASP.NET 以外のアプリケーションについては、コンソールアプリケーションのための Azure Application Insights に関する記事をご覧ください。

ServiceBusProcessor の ProcessMessageAsync (メッセージハンドラーパターン) を使用してメッセージを処理する場合、メッセージの処理もインストルメント化されます。サービスによって実行されたすべての Service Bus の呼び出しは自動的に追跡され、他のテレメトリ項目と関連付けられます。それ以外の場合は、手動でのメッセージ追跡について次の例をご覧ください。

メッセージ処理のトレース

async Task ProcessAsync(ProcessMessageEventArgs args)
{
    ServiceBusReceivedMessage message = args.Message;
    if (message.ApplicationProperties.TryGetValue("Diagnostic-Id", out var objectId) && objectId is string diagnosticId)
    {
        var activity = new Activity("ServiceBusProcessor.ProcessMessage");
        activity.SetParentId(diagnosticId);
        // If you're using Microsoft.ApplicationInsights package version 2.6-beta or higher, you should call StartOperation<RequestTelemetry>(activity) instead
        using (var operation = telemetryClient.StartOperation<RequestTelemetry>("Process", activity.RootId, activity.ParentId))
        {
            telemetryClient.TrackTrace("Received message");
            try 
            {
            // process message
            }
            catch (Exception ex)
            {
                telemetryClient.TrackException(ex);
                operation.Telemetry.Success = false;
                throw;
            }

            telemetryClient.TrackTrace("Done");
        }
    }
}

この例では、処理されるメッセージごとに、タイムスタンプ、期間、結果 (成功) を含む要求テレメトリが報告されます。テレメトリには、相関関係プロパティのセットも含まれます。メッセージ処理中に報告された入れ子のトレースと例外にも、RequestTelemetry の "子" であることを表す相関関係プロパティがスタンプされます。

サポートされる外部コンポーネントへの呼び出しをメッセージ処理中に行った場合は、それも自動的に追跡されて相関付けられます。手動での追跡と相関付けについて詳しくは、「Application Insights .NET SDK でカスタム操作を追跡する」をご覧ください。

Application Insights SDK に加えて外部コードを実行している場合は、Application Insights ログを表示するときの所要時間が長くなることが予想されます。

Application Insights ログの期間が長くなる

これは、メッセージの受信で遅延があったことを意味するわけではありません。このシナリオでは、メッセージは SDK コードにパラメーターとして渡されるため、メッセージは既に受信されています。また、App Insights ログの name タグ (Process) は、メッセージが現在、外部イベント処理コードによって処理されていることを示しています。この問題は、Azure に関連したものではありません。メッセージが Service Bus から既に受信されていることを考えると、これらのメトリックは外部コードの効率を意味します。

OpenTelemetry を使用した追跡

Service Bus .NET クライアントライブラリバージョン 7.5.0 以降では、試験モードで OpenTelemetry がサポートされています。詳しくは、.NET SDK での分散トレースに関するページをご覧ください。

トレースシステムなしで追跡する

ご使用のトレーシングシステムで Service Bus 呼び出しの自動追跡がサポートされない場合は、トレーシングシステムまたはアプリケーションにそのようなサポートを追加することを検討してください。このセクションでは、Service Bus .NET クライアントによって送信される診断イベントについて説明します。

Service Bus .NET クライアントは、.NET トレースプリミティブ System.Diagnostics.Activity および System.Diagnostics.DiagnosticSource を使用してインストルメント化されます。

Activity はトレースコンテキストとして使用され、DiagnosticSource は通知メカニズムです。

DiagnosticSource イベントのリスナーがない場合は、インストルメント化はオフになり、インストルメンテーションコストは 0 のままになります。 DiagnosticSource はすべてのコントロールをリスナーに与えます。

リスナーは、リッスンするソースとイベントを制御します。
リスナーは、イベントレートおよびサンプリングを制御します。
イベントは、すべてのコンテキストを提供するペイロードと一緒に送信されるため、ユーザーがイベント中にメッセージオブジェクトにアクセスして変更できます。

実装を進める前に、DiagnosticSource ユーザーガイドを読むことをお勧めします。

Microsoft.Extension.Logger でログを書き込む ASP.NET Core アプリに、Service Bus イベントのリスナーを作成します。これは System.Reactive.Core ライブラリを使用して DiagnosticSource をサブスクライブします (このライブラリなしでも簡単に DiagnosticSource をサブスクライブできます)。

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory factory, IApplicationLifetime applicationLifetime)
{
    // configuration...

    var serviceBusLogger = factory.CreateLogger("Azure.Messaging.ServiceBus");

    IDisposable innerSubscription = null;
    IDisposable outerSubscription = DiagnosticListener.AllListeners.Subscribe(delegate (DiagnosticListener listener)
    {
        // subscribe to the Service Bus DiagnosticSource
        if (listener.Name == "Azure.Messaging.ServiceBus")
        {
            // receive event from Service Bus DiagnosticSource
            innerSubscription = listener.Subscribe(delegate (KeyValuePair<string, object> evnt)
            {
                // Log operation details once it's done
                if (evnt.Key.EndsWith("Stop"))
                {
                    Activity currentActivity = Activity.Current;
                    serviceBusLogger.LogInformation($"Operation {currentActivity.OperationName} is finished, Duration={currentActivity.Duration}, Id={currentActivity.Id}, StartTime={currentActivity.StartTimeUtc}");
                }
            });
        }
    });

    applicationLifetime.ApplicationStopping.Register(() =>
    {
        outerSubscription?.Dispose();
        innerSubscription?.Dispose();
    });
}

この例では、リスナーが、Service Bus の各操作の期間、結果、一意識別子、開始時刻を記録します。

events

すべてのイベントには、公開されているテレメトリ仕様 (https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/trace/api.md ) に準拠する次のプロパティがあります。

message_bus.destination – キュー/トピック/サブスクリプションのパス
peer.address – 完全修飾名前空間
kind – producer、consumer、または client のいずれか。メッセージを送信する場合は producer、受信する場合は consumer、設定する場合は client を使用します。
component – servicebus

すべてのイベントには、Entity と Endpoint プロパティもあります。

Entity - エンティティ (キュー、トピックなど) の名前
- Endpoint - Service Bus エンドポイント URL

インストルメント化された操作

インストルメント化された操作の全一覧を次に示します。

操作の名前	追跡される API
ServiceBusSender.Send	ServiceBusSender.SendMessageAsync ServiceBusSender.SendMessagesAsync
ServiceBusSender.Schedule	ServiceBusSender.ScheduleMessageAsync ServiceBusSender.ScheduleMessagesAsync
ServiceBusSender.Cancel	ServiceBusSender.CancelScheduledMessageAsync ServiceBusSender.CancelScheduledMessagesAsync
ServiceBusReceiver.Receive	ServiceBusReceiver.ReceiveMessageAsync ServiceBusReceiver.ReceiveMessagesAsync
ServiceBusReceiver.ReceiveDeferred	ServiceBusReceiver.ReceiveDeferredMessagesAsync
ServiceBusReceiver.Peek	ServiceBusReceiver.PeekMessageAsync ServiceBusReceiver.PeekMessagesAsync
ServiceBusReceiver.Abandon	ServiceBusReceiver.AbandonMessagesAsync
ServiceBusReceiver.Complete	ServiceBusReceiver.CompleteMessagesAsync
ServiceBusReceiver.DeadLetter	ServiceBusReceiver.DeadLetterMessagesAsync
ServiceBusReceiver.Defer	ServiceBusReceiver.DeferMessagesAsync
ServiceBusReceiver.RenewMessageLock	ServiceBusReceiver.RenewMessageLockAsync
ServiceBusSessionReceiver.RenewSessionLock	ServiceBusSessionReceiver.RenewSessionLockAsync
ServiceBusSessionReceiver.GetSessionState	ServiceBusSessionReceiver.GetSessionStateAsync
ServiceBusSessionReceiver.SetSessionState	ServiceBusSessionReceiver.SetSessionStateAsync
ServiceBusProcessor.ProcessMessage	ServiceBusProcessor で設定されるプロセッサコールバック。 ProcessMessageAsync プロパティ
ServiceBusSessionProcessor.ProcessSessionMessage	ServiceBusSessionProcessor で設定されるプロセッサコールバック。 ProcessMessageAsync プロパティ

フィルター処理およびサンプリング

場合によっては、パフォーマンスのオーバーヘッドや記憶域の消費量を抑えるためにイベントの一部分のみを記録する必要があります。 'Stop' イベントのみを記録するか (前の例と同様)、イベントの一定の割合をサンプリングします。 DiagnosticSource では、IsEnabled 術後を使用してこれを実現する方法が提供されます。詳しくは、DiagnosticSource でのコンテキストに基づくフィルター処理に関する記事をご覧ください。

IsEnabled を 1 つの操作で複数回呼び出して、パフォーマンスへの影響を最小限にすることができる可能性があります。

IsEnabled は次のように呼び出します。

IsEnabled(<OperationName>, string entity, null) を、たとえば IsEnabled("ServiceBusSender.Send", "MyQueue1") と指定します。最後に 'Start' も 'Stop' もないことに注意してください。これを使用して、特定の操作またはキューをフィルター処理で除外します。コールバックメソッドから false が返されると、その操作のイベントは送信されません。
- 'Process' 操作および 'ProcessSession' 操作では IsEnabled(<OperationName>, string entity, Activity activity) コールバックも受け取ります。これを使用して、activity.Id または Tags プロパティに基づいてイベントをフィルター処理します。
IsEnabled(<OperationName>.Start) を、たとえば IsEnabled("ServiceBusSender.Send.Start") と指定します。 'Start' イベントが起動されるかどうかを確認します。この結果は 'Start' イベントのみに影響し、それ以降のインストルメンテーションがそれに依存することはありません。

'Stop' イベントに対する IsEnabled はありません。

一部の操作の結果が例外になると、IsEnabled("ServiceBusSender.Send.Exception") が呼び出されます。 'Exception' イベントをサブスクライブするだけで、その後のインストルメンテーションを防ぐことができます。このケースでは、例外も処理する必要があります。他のインストルメンテーションが無効になっているため、トレースコンテキストがメッセージと一緒にコンシューマーからプロデューサーに送られることを期待しないでください。

IsEnabled を使用して、サンプリング戦略を実装することもできます。 Activity.Id または Activity.RootId に基づくサンプリングにより、すべての層で一貫性のあるサンプリングが保証されます (トレーシングシステムまたはユーザー独自のコードによって伝達される場合)。

同じソースに対して複数の DiagnosticSource リスナーが存在するとき、イベントを受け取るには 1 つのリスナーだけで十分です。したがって、IsEnabled の呼び出しは保証されません。

2026 年 9 月 30 日に、Azure SDK ガイドラインに準拠していない Azure Service Bus SDK ライブラリ WindowsAzure.ServiceBus、Microsoft.Azure.ServiceBus、および com.microsoft.azure.servicebus は廃止されます。 SBMP プロトコルのサポートも終了するため、2026 年 9 月 30 日以降はこのプロトコルを使用できなくなります。この日付より前に、重要なセキュリティ更新プログラムと強化された機能が提供される、最新の Azure SDK ライブラリに移行してください。

古いライブラリは 2026 年 9 月 30 日以降も引き続き使用できますが、Microsoft から公式のサポートと更新プログラムは提供されなくなります。詳細については、サポート廃止のお知らせに関するページを参照してください。

プロパティ名	説明
`Diagnostic-Id`	プロデューサーからキューへの外部呼び出しの一意識別子。論理的根拠、考慮事項、形式について詳しくは、HTTP プロトコルの Request-Id に関するページをご覧ください。
`Correlation-Context`	操作の処理に関連するすべてのサービスに伝達される操作コンテキスト。詳しくは、HTTP プロトコルの Correlation-Context に関するページをご覧ください。

Service Bus .NET クライアントの自動トレース

バージョン 3.0.0 以降の Microsoft Azure ServiceBus Client for .NET ではトレースインストルメンテーションポイントが提供され、トレーシングシステムまたはクライアントコードの一部でこれを受け取ることができます。インストルメンテーションによって、すべての呼び出しをクライアント側から Service Bus メッセージングサービスまで追跡できるようになります。メッセージの処理がメッセージハンドラーパターンを使用して行われる場合は、メッセージの処理もインストルメント化されます。

Azure Application Insights で追跡する

Microsoft Application Insights では、自動的な要求と依存関係の追跡も含め、豊富なパフォーマンス監視機能が提供されます。

プロジェクトタイプに応じて次のいずれかの Application Insights SDK をインストールします。

ASP.NET - バージョン 2.5-beta2 以上をインストールします
ASP.NET Core - バージョン 2.2.0-beta2 以上をインストールします。これらのリンクには、SDK のインストール、リソースの作成、SDK の構成 (必要な場合) に関する説明があります。 ASP.NET 以外のアプリケーションについては、コンソールアプリケーションのための Azure Application Insights に関する記事をご覧ください。

メッセージハンドラーパターンを使用してメッセージを処理すると完了です。サービスによって実行されたすべての Service Bus の呼び出しは自動的に追跡され、他のテレメトリ項目と関連付けられます。それ以外の場合は、手動でのメッセージ追跡について次の例をご覧ください。

メッセージ処理のトレース

private readonly TelemetryClient telemetryClient;

async Task ProcessAsync(Message message)
{
    var activity = message.ExtractActivity();
    
    // If you're using Microsoft.ApplicationInsights package version 2.6-beta or higher, you should call StartOperation<RequestTelemetry>(activity) instead
    using (var operation = telemetryClient.StartOperation<RequestTelemetry>("Process", activity.RootId, activity.ParentId))
    {
        telemetryClient.TrackTrace("Received message");
        try 
        {
           // process message
        }
        catch (Exception ex)
        {
             telemetryClient.TrackException(ex);
             operation.Telemetry.Success = false;
             throw;
        }

        telemetryClient.TrackTrace("Done");
   }
}

この例では、処理されるメッセージごとに、タイムスタンプ、期間、結果 (成功) を含む RequestTelemetry が報告されます。テレメトリには、相関関係プロパティのセットも含まれます。メッセージ処理中に報告された入れ子のトレースと例外にも、RequestTelemetry の "子" であることを表す相関関係プロパティがスタンプされます。

Application Insights SDK に加えて外部コードを実行している場合は、Application Insights ログを表示するときの所要時間が長くなることが予想されます。

Application Insights ログの期間が長くなる

トレースシステムなしで追跡する

Activity はトレースコンテキストとして使用され、DiagnosticSource は通知メカニズムです。

リスナーは、リッスンするソースとイベントを制御します。
リスナーは、イベントレートおよびサンプリングを制御します。
イベントは、すべてのコンテキストを提供するペイロードと一緒に送信されるため、ユーザーがイベント中にメッセージオブジェクトにアクセスして変更できます。

実装を進める前に、DiagnosticSource ユーザーガイドを読むことをお勧めします。

public void Configure(IApplicationBuilder app, IHostingEnvironment env, ILoggerFactory factory, IApplicationLifetime applicationLifetime)
{
    // configuration...

    var serviceBusLogger = factory.CreateLogger("Microsoft.Azure.ServiceBus");

    IDisposable innerSubscription = null;
    IDisposable outerSubscription = DiagnosticListener.AllListeners.Subscribe(delegate (DiagnosticListener listener)
    {
        // subscribe to the Service Bus DiagnosticSource
        if (listener.Name == "Microsoft.Azure.ServiceBus")
        {
            // receive event from Service Bus DiagnosticSource
            innerSubscription = listener.Subscribe(delegate (KeyValuePair<string, object> evnt)
            {
                // Log operation details once it's done
                if (evnt.Key.EndsWith("Stop"))
                {
                    Activity currentActivity = Activity.Current;
                    TaskStatus status = (TaskStatus)evnt.Value.GetProperty("Status");
                    serviceBusLogger.LogInformation($"Operation {currentActivity.OperationName} is finished, Duration={currentActivity.Duration}, Status={status}, Id={currentActivity.Id}, StartTime={currentActivity.StartTimeUtc}");
                }
            });
        }
    });

    applicationLifetime.ApplicationStopping.Register(() =>
    {
        outerSubscription?.Dispose();
        innerSubscription?.Dispose();
    });
}

この例では、リスナーが、Service Bus の各操作の期間、結果、一意識別子、開始時刻を記録します。

Events

どの操作でも、Start と Stop の 2 つのイベントが送信されます。おそらく、ユーザーにとって関心があるのは Stop イベントのみです。これにより、操作の結果、および開始時刻と所要時間が Activity プロパティとして提供されます。

イベントペイロードは、操作のコンテキストをリスナーに提供します。 API 受信パラメーターと戻り値がレプリケートされます。 'Stop' イベントのペイロードは、'Start' イベントのペイロードのプロパティをすべて含んでいるため、'Start' イベントは完全に無視することができます。

すべてのイベントには、"Entity" と "Endpoint" プロパティもあります。

string Entity - エンティティ (キュー、トピックなど) の名前
- Uri Endpoint - Service Bus エンドポイント URL

各 'Stop'イベントには、非同期操作の完了に関する TaskStatus を含む Status プロパティがあります。これも、わかりやすくするために次の表では省略しています。

インストルメント化された操作の全一覧を次に示します。

操作の名前	追跡される API	固有のペイロードプロパティ
Microsoft.Azure.ServiceBus.Send	MessageSender.SendAsync	`IList<Message> Messages` - 送信されるメッセージの一覧
Microsoft.Azure.ServiceBus.ScheduleMessage	MessageSender.ScheduleMessageAsync	`Message Message` - 処理されるメッセージ `DateTimeOffset ScheduleEnqueueTimeUtc` - スケジュールされたメッセージのオフセット `long SequenceNumber` - スケジュールされたメッセージのシーケンス番号 ('Stop' イベントペイロード)
Microsoft.Azure.ServiceBus.Cancel	MessageSender.CancelScheduledMessageAsync	`long SequenceNumber` - 取り消すメッセージのシーケンス番号
Microsoft.Azure.ServiceBus.Receive	MessageReceiver.ReceiveAsync	`int RequestedMessageCount` - 受信できたメッセージの最大数 `IList<Message> Messages` - 受信したメッセージの一覧 ('Stop' イベントペイロード)
Microsoft.Azure.ServiceBus.Peek	MessageReceiver.PeekAsync	`int FromSequenceNumber` - メッセージのバッチの参照を開始する始点 `int RequestedMessageCount` - 取得するメッセージの最大数 `IList<Message> Messages` - 受信したメッセージの一覧 ('Stop' イベントペイロード)
Microsoft.Azure.ServiceBus.ReceiveDeferred	MessageReceiver.ReceiveDeferredMessageAsync	`IEnumerable<long> SequenceNumbers` - 受信するシーケンス番号を含む一覧 `IList<Message> Messages` - 受信したメッセージの一覧 ('Stop' イベントペイロード)
Microsoft.Azure.ServiceBus.Complete	MessageReceiver.CompleteAsync	`IList<string> LockTokens` - 完了させるメッセージに対応するロックトークンを含む一覧
Microsoft.Azure.ServiceBus.Abandon	MessageReceiver.AbandonAsync	`string LockToken` - 中止するメッセージに対応するロックトークン
Microsoft.Azure.ServiceBus.Defer	MessageReceiver.DeferAsync	`string LockToken` - 保留するメッセージに対応するロックトークン
Microsoft.Azure.ServiceBus.DeadLetter	MessageReceiver.DeadLetterAsync	`string LockToken` - 配信不能に対応するメッセージのロックトークン
Microsoft.Azure.ServiceBus.RenewLock	MessageReceiver.RenewLockAsync	`string LockToken` - ロックの更新に対応するメッセージのロックトークン `DateTime LockedUntilUtc` - 新しいロックトークンの有効期限の日時 (UTC 形式) ('Stop' イベントペイロード)
Microsoft.Azure.ServiceBus.Process	IReceiverClient.RegisterMessageHandler で提供されるメッセージハンドラーのラムダ関数	`Message Message` - 処理されるメッセージ
Microsoft.Azure.ServiceBus.ProcessSession	IQueueClient.RegisterSessionHandler で提供されるメッセージせしょんハンドラーのラムダ関数	`Message Message` - 処理されるメッセージ `IMessageSession Session` - 処理されるセッション
Microsoft.Azure.ServiceBus.AddRule	SubscriptionClient.AddRuleAsync	`RuleDescription Rule` - 追加するルールを提供するルールの説明
Microsoft.Azure.ServiceBus.RemoveRule	SubscriptionClient.RemoveRuleAsync	`string RuleName`- 削除するルールの名前
Microsoft.Azure.ServiceBus.GetRules	SubscriptionClient.GetRulesAsync	`IEnumerable<RuleDescription> Rules`- サブスクリプションに関連付けられているすべてのルール ('Stop' ペイロードのみ)
Microsoft.Azure.ServiceBus.AcceptMessageSession	ISessionClient.AcceptMessageSessionAsync	`string SessionId` - メッセージ内に存在する sessionId
Microsoft.Azure.ServiceBus.GetSessionState	IMessageSession.GetStateAsync	`string SessionId` - メッセージ内に存在する sessionId `byte [] State` - セッション状態 ('Stop' イベントペイロード)
Microsoft.Azure.ServiceBus.SetSessionState	IMessageSession.SetStateAsync	`string SessionId` - メッセージ内に存在する sessionId `byte [] State` - セッションの状態
Microsoft.Azure.ServiceBus.RenewSessionLock	IMessageSession.RenewSessionLockAsync	`string SessionId` - メッセージ内に存在する sessionId
Microsoft.Azure.ServiceBus.Exception	インストルメント化された任意の API	`Exception Exception` - 例外インスタンス

すべてのイベントで、現在の操作コンテキストを保持する Activity.Current にアクセスできます。

その他のプロパティのログ記録

Activity.Current は、現在の操作とその親について詳しいコンテキストを提供します。詳細については、Activity のドキュメントを参照してください。 Service Bus インストルメンテーションによって、追加の情報が Activity.Current.Tags で提供されます。MessageId と SessionId がある場合、これらは常に含まれます。

Receive、Peek、ReceiveDeferred の各イベントを追跡するアクティビティには、RelatedTo タグが含まれることもあります。これは、結果として受信されたメッセージの Diagnostic-Id が重複しないリストを保持します。そのような操作の結果として、関係しないいくつかのメッセージが受信される場合があります。また、操作の開始時には Diagnostic-Id は不明です。そのため、'Receive' 操作を 'Process' 操作に関連付けるには、このタグを使用するしかありません。パフォーマンスの問題を分析するときは、メッセージの受信にどれだけ時間がかかったかを調べると役立ちます。

タグを記録する効率的な方法は反復処理することです。タグを前の例に追加すると次のようになります。

Activity currentActivity = Activity.Current;
TaskStatus status = (TaskStatus)evnt.Value.GetProperty("Status");

var tagsList = new StringBuilder();
foreach (var tags in currentActivity.Tags)
{
    tagsList.Append($", {tags.Key}={tags.Value}");
}

serviceBusLogger.LogInformation($"{currentActivity.OperationName} is finished, Duration={currentActivity.Duration}, Status={status}, Id={currentActivity.Id}, StartTime={currentActivity.StartTimeUtc}{tagsList}");

フィルター処理およびサンプリング

IsEnabled を 1 つの操作で複数回呼び出して、パフォーマンスへの影響を最小限にすることができる可能性があります。

IsEnabled は次のように呼び出します。

IsEnabled(<OperationName>, string entity, null) を、たとえば IsEnabled("Microsoft.Azure.ServiceBus.Send", "MyQueue1") と指定します。最後に 'Start' も 'Stop' もないことに注意してください。これを使用して、特定の操作またはキューをフィルター処理で除外します。コールバックメソッドから false が返されると、その操作のイベントは送信されません。
- 'Process' 操作および 'ProcessSession' 操作では IsEnabled(<OperationName>, string entity, Activity activity) コールバックも受け取ります。これを使用して、activity.Id または Tags プロパティに基づいてイベントをフィルター処理します。
IsEnabled(<OperationName>.Start) を、たとえば IsEnabled("Microsoft.Azure.ServiceBus.Send.Start") と指定します。 'Start' イベントが起動されるかどうかを確認します。この結果は 'Start' イベントのみに影響し、それ以降のインストルメンテーションがそれに依存することはありません。

'Stop' イベントに対する IsEnabled はありません。

一部の操作の結果が例外になると、IsEnabled("Microsoft.Azure.ServiceBus.Exception") が呼び出されます。 'Exception' イベントをサブスクライブするだけで、その後のインストルメンテーションを防ぐことができます。このケースでは、例外も処理する必要があります。他のインストルメンテーションが無効になっているため、トレースコンテキストがメッセージと一緒にコンシューマーからプロデューサーに送られることを期待しないでください。

開発者が既定でこのテレメトリをすべて出力できるようにするライブラリの 1 つが NServiceBus です。
Application Insights の相関付け
Application Insights .NET SDK でカスタム操作を追跡する

次の方法で共有

Service Bus メッセージングを介した分散トレースおよび相関付け

Service Bus .NET クライアントの自動トレース

Azure Application Insights で追跡する

メッセージ処理のトレース

OpenTelemetry を使用した追跡

トレースシステムなしで追跡する

events

インストルメント化された操作

フィルター処理およびサンプリング

Service Bus .NET クライアントの自動トレース

Azure Application Insights で追跡する

メッセージ処理のトレース

トレースシステムなしで追跡する

Events

その他のプロパティのログ記録

フィルター処理およびサンプリング

フィードバック

その他のリソース

次の方法で共有

Service Bus メッセージングを介した分散トレースおよび相関付け

Service Bus .NET クライアントの自動トレース

Azure Application Insights で追跡する

メッセージ処理のトレース

OpenTelemetry を使用した追跡

トレース システムなしで追跡する

events

インストルメント化された操作

フィルター処理およびサンプリング

関連するコンテンツ

フィードバック

その他のリソース

トレースシステムなしで追跡する