X-Ray SDK for .NET

X-Ray SDK を使用して、アプリケーションが Amazon EC2、AWS Elastic Beanstalk、または Amazon ECS の EC2 インスタンスで処理する受信 HTTP リクエストをトレースできます。

メッセージハンドラーを使用して受信 HTTP リクエストを計測します。X-Ray メッセージハンドラーをアプリケーションに追加すると、サンプリングされた各リクエストに X-Ray SDK for .NET によってセグメントが作成されます。このセグメントには、時間、メソッド、HTTP リクエストの処理などが含まれます。追加の計測により、このセグメントでサブセグメントが作成されます。

注記

AWS Lambda関数では、Lambda は、サンプリングされた各リクエストのセグメントを作成します。詳細については、「AWS Lambda および AWS X-Ray」を参照してください。

各セグメントには、サービスマップ内のアプリケーションを識別する名前があります。セグメントの名前は静的に指定することも、受信リクエストのホストヘッダーに基づいて動的に名前を付けるように SDK を設定することもできます。動的ネーミングでは、リクエスト内のドメイン名に基づいてトレースをグループ化でき、名前が予想されるパターンと一致しない場合（たとえば、ホストヘッダーが偽造されている場合）、デフォルト名を適用できます。

転送されたリクエスト

ロードバランサーまたは他の仲介者がアプリケーションにリクエストを転送する場合、X-Ray は、クライアントの IP をIP パケットの送信元 IP からではなく、リクエストのX-Forwarded-Forヘッダーから取得します。転送された要求に対して記録されたクライアント IP は偽造される可能性があるため、信頼されるべきではありません。

メッセージハンドラーは、次の情報が含まれる http ブロックを使用して、各受信リクエスト用にセグメントを作成します。

• HTTP メソッド – GET、POST、PUT、DELETE、その他。

• クライアントアドレス – リクエストを送信するクライアントの IP アドレス。

• レスポンスコード – 完了したリクエストの HTTP レスポンスコード。

• タイミング – 開始時間 (リクエストが受信された時間) および終了時間 (レスポンスが送信された時間)。

• ユーザーエージェント — リクエストからのuser-agent

• コンテンツの長さ — レスポンスからのcontent-length

受信リクエストの計測 (.NET)

アプリケーションによって処理されるリクエストを計測するには、RegisterXRay ファイルの Init メソッドで global.asax を呼び出します。

例 global.asax - メッセージハンドラー

using System.Web.Http;
using Amazon.XRay.Recorder.Handlers.AspNet;

namespace SampleEBWebApplication
{
  public class MvcApplication : System.Web.HttpApplication
  {
    public override void Init()
    {
      base.Init();
      AWSXRayASPNET.RegisterXRay(this, "MyApp");
    }
  }
}

受信リクエストの計測 (.NET Core)

アプリケーションによって処理されるリクエストを計測するには、UseXRay他のミドルウェアより前のメソッドConfigureStartup クラスのメソッドは、理想的にはX-Rayミドルウェアがリクエストを処理する最初のミドルウェアであり、パイプラインでレスポンスを処理する最後のミドルウェアにする必要があります。

注記

.NET Core 2.0 の場合、UseExceptionHandlerアプリケーションのメソッドで、必ず呼び出してくださいUseXRay後UseExceptionHandlerメソッドを使用して、例外が記録されるようにします。

例 Startup.cs

.NET Core 2.1 and above

using Microsoft.AspNetCore.Builder;

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
  {
    app.UseXRay("MyApp");
    // additional middleware
    ...
  }

.NET Core 2.0

using Microsoft.AspNetCore.Builder;

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
  {
    app.UseExceptionHandler("/Error");
    app.UseXRay("MyApp");
    // additional middleware
    ...
  }

この UseXRay メソッドは、2 番目の引数として設定オブジェクトを受け取ることもできます。

app.UseXRay("MyApp", configuration);

セグメント命名ルールの設定

AWS X-Rayはサービス名を使用してアプリケーションを識別し、他のアプリケーション、データベース、外部 API、およびAWSアプリケーションが使用するリソースと区別します。X-Ray SDK が受信リクエストのセグメントを生成すると、アプリケーションのサービス名がセグメントの名前フィールドに記録されます。

X-Ray SDK では、HTTP リクエストヘッダーのホスト名の後にセグメントの名前を指定できます。ただし、このヘッダーは偽造され、サービスマップに予期しないノードが発生する可能性があります。偽造されたホストヘッダーを持つリクエストによって SDK がセグメントの名前を間違えないようにするには、受信リクエストのデフォルト名を指定する必要があります。

アプリケーションが複数のドメインのリクエストを処理する場合、動的ネーミングストラテジーを使用してセグメント名にこれを反映するように SDK を設定できます。動的ネーミングストラテジーにより、SDK は予想されるパターンに一致するリクエストにホスト名を使用し、そうでないリクエストにデフォルト名を適用できます。

たとえば、3 つのサブドメイン（www.example.com,api.example.com,およびstatic.example.com）に対してリクエストを処理する単一のアプリケーションがあるとします。動的ネーミングストラテジーをパターン *.example.com で使用して、異なる名前を持つ各サブドメインのセグメントを識別することができます。結果的にはサービスマップ上に 3 つのサービスノードを作成することになります。アプリケーションがパターンと一致しないホスト名のリクエストを受信すると、指定したフォールバック名を持つ 4 番目のノードがサービスマップに表示されます。

すべてのリクエストセグメントに対して同じ名前を使用するには、前のセクションで示すとおり、メッセージハンドラを初期化するときに、アプリケーションの名前を指定します。これは、FixedSegmentNamingStrategy を作成して、RegisterXRay メソッドに渡すのと同じ効果があります。

AWSXRayASPNET.RegisterXRay(this, new FixedSegmentNamingStrategy("MyApp"));

注記

コードで定義したデフォルトのサービス名は、AWS_XRAY_TRACING_NAME 環境変数で上書きできます。

動的な命名戦略は、ホスト名と一致するようパターンを定義し、HTTP リクエストのホスト名がパターンと一致しない場合はデフォルトの名前を使用します。動的にセグメントに命名するには、DynamicSegmentNamingStrategy を作成して、RegisterXRay メソッドに渡します。

AWSXRayASPNET.RegisterXRay(this, new DynamicSegmentNamingStrategy("MyApp", "*.example.com"));