.NETでの非同期サポート

エージェントは、これらのHttpClient非同期メソッドをインストルメントします。

• SendAsync
• GetAsync
• PostAsync
• PutAsync
• DeleteAsync
• GetStringAsync
• GetStreamAsync
• GetByteArrayAsync

エージェントは、これらのRestClient非同期メソッドをインストルメントします。

• ExecuteTaskAsync
• ExecuteGetTaskAsync
• ExecutePostTaskAsync

エージェントは、これらのSqlCommand非同期メソッドをインストルメントします。

• ExecuteReaderAsync
• ExecuteNonQueryAsync
• ExecuteScalarAsync
• ExecuteXmlReaderAsync

エージェントは、これらのSqlDataReader非同期メソッドをインストルメントします。

• NextResultAsync
• ReadAsync

エージェントはこれらのNpgsqlCommand非同期メソッドをインストルメントします（Postgres）：

• ExecuteReaderAsync
• ExecuteNonQueryAsync
• ExecuteScalarAsync

.NETエージェントは、独自の非同期メソッドの カスタムインスツルメンテーションをサポートしています。

応答時間は、 async - await使用シーンで費やされた合計時間よりも短いと予想されます。Webエンドポイントの次のコード例を検討してください。

async Task<string> WebEndpointExample() 
{
    await DoSomethingForSomeSecondsAsync(5); //kick off a 5-second-work to be done.
    return "Complete";
}

[Trace]
[MethodImpl(MethodImplOptions.NoInlining)]
private static async Task DoSomethingForSomeSecondsAsync(int seconds)
{
    await Task.Delay(TimeSpan.FromSeconds(seconds));
}

このコード例では、 WebEndpointExampleが完了するまでに約5秒かかるため、 WebEndpointExampleエンドポイントへのリクエストを表すトランザクションの応答時間は約5秒になります。

エージェントは、トランザクションを構成する個々のセグメントの「ビジー」時間（インストルメントされたメソッドが実際に実行されている時間）もキャプチャします。それらはWebEndpointExampleとDoSomethingForSomeSecondsAsyncです。理想的には、2つのセグメントの合計実行時間は応答時間（約5秒）に等しくなります。

DoSomethingForSomeSecondsAsyncの実行時間は5秒であることが簡単にわかります。ただし、 WebEndpointExampleの実行時間は0秒に近い必要があります。（これは何の作業も行いません。 DoSomethingForSomeSecondsAsyncが完了するのはawait秒です。）

ただし、エージェントは実行時間を約5秒と測定します。これは、メソッドが別のメソッドをawaitしているときに、エージェントがブロックされた時間（CPU時間ではない）を検出できないためです。したがって、合計時間は10秒として報告されます。これは、応答時間（約5秒）よりも長くなります。

同時に、エージェントはasyncメソッドの呼び出しが常に呼び出し元をブロックすることを想定できません。次の例はこれを示しています。

async Task<string> WebEndpointExample()
{
    var task = DoSomethingForSomeSecondsAsync(5); //kick off a 5-second-work to be done.

    //Do something less than 5 seconds here.

    await task;
    return "Complete";
}

[Trace]
[MethodImpl(MethodImplOptions.NoInlining)]
private static async Task DoSomethingForSomeSecondsAsync(int seconds)
{
    await Task.Delay(TimeSpan.FromSeconds(seconds));
}

この例では、応答時間はまだ約5秒ですが、 WebEndpointExampleの実際の実行時間は約0ではなくなりました。

レガシーASPパイプラインが存在する場合、.NETエージェントが非同期メソッドを計測しないという問題がありました。この問題は、.NET Framework 4.0以下で作成されたアプリケーションを.NET Framework 4.5以上に移行した場合にのみ発生しますが、非同期メソッドが導入される前にMicrosoft社がレガシーASPパイプラインを置き換えたため、この問題が発生します。

この問題がお客様のアプリケーションに影響するかどうか、また、影響する場合の解決方法については、 トラブルシューティングの手順を確認してください。

.NETエージェントは、 TaskまたはTask<T>以外の戻り型を持つ非同期メソッドのインストルメンテーションをサポートしていません。エージェントはasync voidメソッドをサポートしていません。

詳しくは、 async return typeについてのMicrosoftのドキュメントを参照してください 。

• Task<TResult>リターンタイプ
• 非同期ボイド
• 一般化された非同期リターンタイプ

.NETエージェントは、 WCFアプリケーションを除いて、 begin*およびend*スタイルを使用する.NETメソッドをインストルメントしません。この例外を除いて、アプリケーションがこれらのタイプのメソッドを呼び出す場合、エージェントはそれらのセグメントを作成しません。ただし、残りのトランザクションとセグメントは正しく作成されます。

.NETエージェントは、スコープ付きのメトリクスや、アプリケーションが手動で作成したスレッド内のセグメントをキャプチャしません。

アプリケーションがインストルメント化された非同期メソッドを呼び出す場合は、 Task.Result()などのTask関連メソッドではなくawaitを使用して結果を待ちます。そうしないと、インストルメンテーションが正しく機能しない場合があります。

一般に、非同期メソッドを呼び出す場合は、 Task.Result()の使用を避けてください。デッドロックが発生する可能性があります。

インストルメント化された非同期メソッドによって返されるpromiseに独自のContinueWith({})ブロックを追加すると、インストルメンテーションによって報告されるタイミング測定に影響を与える可能性があります。たとえば、時間にはContinueWithの実行にかかる時間が含まれる場合があります。

IISでホストされているWCFサービスは、 ExecuteRequestHandlerセグメントの下にWCFセグメントを適切にネストしません。報告された合計時間は正確ですが、2つのセグメントはトランザクショントレース内の兄弟であるように見えます。

トランザクショントレースのセグメントは、 transaction_tracer.stack_trace_thresholdより長く実行されている場合でも、スタックトレースを自動的に生成しません。