Menginstrumentasikan permintaan HTTP yang masuk dengan X-Ray SDK for .NET

Anda dapat menggunakan SDK X-Ray untuk melacak permintaan HTTP masuk yang dilayani aplikasi Anda pada instans EC2 di Amazon EC2, AWS Elastic Beanstalk, atau Amazon ECS.

Gunakan pengendali pesan untuk menginstrumentasi permintaan HTTP yang masuk. Saat Anda menambahkan pengendali pesan X-Ray ke aplikasi Anda, X-Ray SDK for .NET membuat segmen untuk setiap permintaan yang dibuat sampel. Segmen ini meliputi waktu, metode, dan disposisi permintaan HTTP. Instrumentasi tambahan membuat subsegmen pada segmen ini.

catatan

Untuk fungsi AWS Lambda, Lambda membuat segmen untuk setiap permintaan sampel. Lihat AWS Lambda dan AWS X-Ray untuk informasi selengkapnya.

Setiap segmen memiliki nama yang mengidentifikasi aplikasi Anda dalam peta layanan. Segmen dapat diberi nama secara statis, atau Anda dapat mengonfigurasi SDK untuk nama itu secara dinamis berdasarkan header host dalam permintaan masuk. Penamaan dinamis memungkinkan Anda mengelompokkan pelacakan berdasarkan nama domain dalam permintaan, dan menerapkan nama default jika nama tersebut tidak cocok dengan pola yang diharapkan (misalnya, jika header host ditiru).

Permintaan yang Diteruskan

Jika penyeimbang beban atau perantara lainnya meneruskan permintaan ke aplikasi Anda, X-Ray akan mengambil IP klien dari header X-Forwarded-For dalam permintaan bukan dari sumber IP dalam paket IP. IP klien yang tercatat untuk permintaan yang diteruskan dapat dipalsukan, jadi tidak boleh dipercaya.

Pengendali pesan membuat segmen untuk setiap permintaan yang masuk dengan blok http yang berisi informasi berikut:

• Metode HTTP – DAPATKAN, POSTING, LETAKKAN, HAPUS, dll.

• Alamat klien – Alamat IP klien yang mengirim permintaan.

• Kode respons – Kode respons HTTP untuk permintaan yang selesai.

• Timing – Waktu mulai (saat permintaan diterima) dan waktu akhir (saat respons dikirim).

• Agen pengguna — user-agent dari permintaan.

• Panjang konten — content-length dari respons.

Menginstrumentasikan permintaan masuk (.NET)

Untuk menginstrumentasi permintaan yang dilayani oleh aplikasi Anda, panggil RegisterXRay di dalam metode Init dari file global.asax Anda.

contoh global.asax - pengendali pesan

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");
    }
  }
}

Menginstrumentasikan permintaan yang masuk (.NET Core)

Untuk menginstrumentasi permintaan yang dilayani oleh aplikasi Anda, panggil metode UseXRay sebelum middleware lain dalam metode Configure kelas Startup Anda, karena middleware X-Ray idealnya harus menjadi middleware pertama yang memproses permintaan dan middleware terakhir yang memproses respons dalam alur.

catatan

.NET Core 2.0, jika Anda memiliki metode UseExceptionHandler dalam aplikasi, pastikan untuk memanggil UseXRay setelah metode UseExceptionHandler guna memastikan bahwa pengecualian tercatat.

contoh 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
    ...
  }

Metode UseXRay juga dapat mengambil objek konfigurasi sebagai argumen kedua.

app.UseXRay("MyApp", configuration);

Mengonfigurasi strategi penamaan segmen

AWS X-Ray menggunakan nama layanan untuk mengidentifikasi aplikasi Anda dan membedakannya dari aplikasi lain, database, API eksternal, dan sumber daya AWS yang menggunakan aplikasi Anda. Saat SDK X-Ray membuat segmen untuk permintaan masuk, SDK akan mencatat nama layanan aplikasi Anda di kolom nama.

SDK X-Ray dapat memberi nama segmen setelah nama host di header permintaan HTTP. Namun, header ini dapat ditiru, yang dapat mengakibatkan simpul tak terduga di peta layanan Anda. Untuk mencegah SDK dari penamaan segmen salah karena permintaan dengan header host palsu, Anda harus menentukan nama default untuk permintaan masuk.

Jika aplikasi Anda menyuguhkan permintaan untuk beberapa domain, Anda dapat mengonfigurasi SDK untuk menggunakan strategi penamaan dinamis untuk mencerminkan ini dalam nama segmen. Strategi penamaan dinamis mengizinkan SDK menggunakan nama host untuk permintaan yang sesuai dengan pola yang diharapkan, dan menerapkan nama default untuk permintaan yang tidak sesuai.

Misalnya, Anda boleh memiliki satu aplikasi yang melayani permintaan untuk tiga subdomain– www.example.com, api.example.com, dan static.example.com. Anda dapat menggunakan strategi penamaan dinamis dengan pola *.example.com untuk mengidentifikasi segmen untuk setiap subdomain dengan nama yang berbeda, mengakibatkan tiga simpul layanan pada peta layanan. Jika aplikasi Anda menerima permintaan dengan nama host yang tidak cocok dengan polanya, Anda akan melihat simpul keempat di peta layanan dengan nama cadangan yang Anda tentukan.

Untuk menggunakan nama yang sama untuk semua segmen permintaan, tentukan nama aplikasi Anda saat menginisialisasi pengendali pesan, seperti yang ditunjukkan di bagian sebelumnya. Tindakan ini memiliki efek yang sama seperti membuat FixedSegmentNamingStrategy dan meneruskannya ke metode RegisterXRay.

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

catatan

Anda dapat mengganti nama layanan default yang Anda tentukan dalam kode dengan variabel lingkungan AWS_XRAY_TRACING_NAME.

Strategi penamaan dinamis menentukan pola yang harus cocok dengan nama host, dan nama default yang digunakan jika nama host dalam permintaan HTTP tidak cocok dengan pola tersebut. Untuk memberi nama segmen secara dinamis, buat DynamicSegmentNamingStrategy dan teruskan ke metode RegisterXRay.

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