Mengonfigurasi aturan AWS X-Ray pengambilan sampel untuk API Gateway API

Anda dapat menggunakan AWS X-Ray konsol atau SDK untuk mengonfigurasi aturan pengambilan sampel untuk Amazon API Gateway API. Aturan sampling menentukan permintaan X-Ray mana yang harus direkam untuk API Anda. Dengan menyesuaikan aturan pengambilan sampel, Anda dapat mengontrol jumlah data yang Anda catat, dan mengubah perilaku pengambilan sampel dengan cepat tanpa mengubah atau men-deploy ulang kode Anda.

Sebelum Anda menentukan aturan pengambilan sampel X-Ray, baca topik berikut di Panduan Pengembang X-Ray:

• Mengkonfigurasi Aturan Pengambilan Sampel di Konsol AWS X-Ray

• Menggunakan Aturan Sampling dengan X-Ray API

Nilai opsi aturan pengambilan sampel X-Ray untuk API Gateway API

Opsi pengambilan sampel X-Ray berikut relevan untuk API Gateway. Nilai string dapat menggunakan wildcard untuk mencocokkan satu karakter (?) atau nol atau lebih karakter (*). Untuk detail selengkapnya, termasuk penjelasan rinci tentang cara pengaturan Reservoir dan Rate digunakan, Mengonfigurasi Aturan Pengambilan Sampel di AWS X-Ray Konsol.

• Nama aturan (string) - Nama unik untuk aturan.

• Prioritas (integer antara 1 dan 9999) — Prioritas aturan sampling. Layanan mengevaluasi aturan dalam urutan prioritas naik, dan membuat keputusan pengambilan sampel dengan aturan pertama yang cocok.

• Reservoir (bilangan bulat nonnegatif) — Sejumlah permintaan pencocokan yang tetap ke instrumen per detik, sebelum menerapkan tarif tetap. Reservoir tidak digunakan secara langsung oleh layanan, tetapi berlaku untuk semua layanan yang menggunakan aturan secara kolektif.

• Tarif (angka antara 0 dan 100) — Persentase permintaan yang cocok dengan instrumen, setelah reservoir habis.

• Nama layanan (string) - nama tahap API, dalam bentuk{api-name}/{stage-name}. Misalnya, jika Anda menerapkan API PetStoresampel ke tahap bernamatest, nilai nama Layanan yang akan ditentukan dalam aturan pengambilan sampel Anda adalah. pets/test

• Jenis layanan (string) - Untuk API Gateway API, baik AWS::ApiGateway::Stage atau AWS::ApiGateway::* dapat ditentukan.

• Host (string) — Nama host dari header host HTTP. Setel ini * agar cocok dengan semua nama host. Atau Anda dapat menentukan nama host penuh atau sebagian untuk dicocokkan, misalnya, api.example.com atau*.example.com.

• Resource ARN (string) — ARN dari tahap API, misalnya,. arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

  Nama panggung dapat diperoleh dari konsol atau API Gateway CLI atau API. Untuk informasi selengkapnya tentang format ARN, lihat. Referensi Umum Amazon Web Services

• Metode HTTP (string) — Metode yang akan diambil sampelnya, misalnya,GET.

• Jalur URL (string) — Jalur URL permintaan.

• (opsional) Atribut (kunci dan nilai) — Header dari permintaan HTTP asli, misalnya,, ConnectionContent-Length, atauContent-Type. Setiap nilai atribut dapat mencapai 32 karakter.

Contoh aturan pengambilan sampel X-Ray

Contoh aturan pengambilan sampel #1

Aturan ini mengambil sampel semua GET permintaan untuk testxray API pada test tahap tersebut.

• Nama aturan - test-sampling

• Prioritas - 17

• Ukuran reservoir — 10

• Tarif tetap - 10

• Nama layanan - testxray/test

• Jenis layanan - AWS::ApiGateway::Stage

• Metode HTTP - GET

• Sumber daya ARN — *

• Tuan rumah — *

Contoh aturan pengambilan sampel #2

Aturan ini mengambil sampel semua permintaan untuk testxray API pada prod tahap tersebut.

• Nama aturan - prod-sampling

• Prioritas - 478

• Ukuran reservoir — 1

• Tarif tetap - 60

• Nama layanan - testxray/prod

• Jenis layanan - AWS::ApiGateway::Stage

• Metode HTTP - *

• Sumber daya ARN — *

• Tuan rumah — *

• Atribut — {}