Dukungan penelusuran aktif Amazon API Gateway untuk AWS X-Ray - AWS X-Ray

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

Dukungan penelusuran aktif Amazon API Gateway untuk AWS X-Ray

Anda dapat menggunakan X-Ray untuk menelusuri dan menganalisis permintaan pengguna saat mereka melakukan perjalanan melalui API Amazon API Gateway ke layanan yang mendasarinya. API Gateway mendukung penelusuran X-Ray untuk semua tipe titik akhir API Gateway: Regional, edge-optimized, dan privat. Anda dapat menggunakan X-Ray dengan Amazon API Gateway di semua Wilayah AWS tempat X-Ray tersedia. Untuk informasi selengkapnya, lihat Menelusuri Eksekusi API dari API Gateway dengan AWS X-Ray di Panduan Developer Amazon API Gateway.

catatan

X-Ray hanya mendukung penelusuran untuk API REST melalui API Gateway.

Amazon API Gateway menyediakan dukungan penelusuran aktif untuk AWS X-Ray. Aktifkan penelusuran aktif pada tahap API Anda untuk mengambil sampel permintaan masuk dan mengirim penelusuran ke X-Ray.

Untuk mengaktifkan penelusuran aktif pada tahap API

  1. Buka konsol API Gateway di https://console.aws.amazon.com/apigateway/.

  2. Pilih API.

  3. Memilih tahapan.

  4. Pada tab Logs/Tracing, pilih Aktifkan X-Ray Tracing dan kemudian pilih Simpan Perubahan.

  5. Pilih Sumber Daya pada panel navigasi sebelah kiri.

  6. Untuk menerapkan ulang API dengan pengaturan baru, pilih dropdown Tindakan, lalu pilih Deploy API.

API Gateway menggunakan aturan pengambilan sampel yang Anda tetapkan di konsol X-Ray untuk menentukan permintaan mana yang akan dicatat. Anda dapat membuat aturan yang hanya berlaku untuk API, atau yang hanya berlaku untuk permintaan yang berisi header tertentu. API Gateway mencatat header dalam atribut pada segmen, bersama dengan detail tentang tahap dan permintaan. Untuk informasi selengkapnya, lihat Mengonfigurasi aturan pengambilan sampel.

catatan

Saat melacak REST API dengan integrasi HTTP API Gateway, nama layanan setiap segmen disetel ke jalur URL permintaan dari API Gateway ke titik akhir integrasi HTTP Anda, menghasilkan node layanan pada peta jejak X-Ray untuk setiap jalur URL unik. Sejumlah besar jalur URL dapat menyebabkan peta jejak melebihi batas 10.000 node, yang mengakibatkan kesalahan.

Untuk meminimalkan jumlah node layanan yang dibuat oleh API Gateway, pertimbangkan untuk meneruskan parameter dalam string kueri URL atau di badan permintaan melalui POST. Pendekatan mana pun akan memastikan parameter bukan bagian dari jalur URL, yang dapat menghasilkan lebih sedikit jalur URL dan node layanan yang berbeda.

Untuk semua permintaan yang masuk, API Gateway menambahkan header pelacakan ke permintaan HTTP masuk yang belum memilikinya.

X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793
Format ID jejak X-Ray

trace_idX-Ray terdiri dari tiga angka yang dipisahkan oleh tanda hubung. Contohnya, 1-58406520-a006649127e371903a2de979. Hal ini mencakup:

  • Nomor versi, yaitu1.

  • Waktu permintaan asli dalam waktu epoch Unix menggunakan 8 digit heksadesimal.

    Misalnya, 10:00 AM 1 Desember 2016 PST dalam waktu epoch adalah 1480615200 detik atau 58406520 dalam digit heksadesimal.

  • Pengidentifikasi 96-bit yang unik secara global untuk jejak dalam 24 digit heksadesimal.

Jika penelusuran aktif dinonaktifkan, tahapan masih mencatat segmen jika permintaan berasal dari layanan yang mengambil sampel permintaan dan mulai penelusuran. Misalnya, aplikasi web yang diinstrumentasi dapat memanggil API dari API Gateway dengan klien HTTP. Ketika Anda instrumen klien HTTP dengan SDK X-Ray, hal tersebut akan menambahkan header penelusuran ke permintaan keluar yang berisi keputusan pengambilan sampel. API Gateway membaca header penelusuran dan membuat segmen untuk permintaan sampel.

Jika Anda menggunakan API Gateway untuk membuat Java SDK untuk API Anda, Anda dapat menginstrumentasikan klien SDK dengan menambahkan penangan permintaan dengan pembuat klien, dengan cara yang sama seperti Anda akan secara manual AWS menginstruksikan klien SDK. Lihat Menelusuri panggilan AWS SDK dengan X-Ray SDK for Java untuk instruksi.