Siapkan AWS X-Ray dengan API API Gateway REST API

Di bagian ini Anda dapat menemukan informasi terperinci tentang cara mengatur AWS X-Raydengan API API Gateway REST API.

Mode penelusuran X-Ray untuk API Gateway

Jalur permintaan melalui aplikasi Anda dilacak dengan ID jejak. Jejak mengumpulkan semua segmen yang dihasilkan oleh satu permintaan, biasanya permintaan HTTP GET atau POST permintaan.

Ada dua mode penelusuran untuk API Gateway API:

• Pasif: Ini adalah pengaturan default jika Anda belum mengaktifkan penelusuran X-Ray pada tahap API. Pendekatan ini berarti API Gateway API hanya dilacak jika X-Ray telah diaktifkan pada layanan upstream.

• Aktif: Saat tahap API Gateway API memiliki pengaturan ini, API Gateway secara otomatis mengambil sampel permintaan pemanggilan API, berdasarkan algoritma pengambilan sampel yang ditentukan oleh X-Ray.

  Saat penelusuran aktif diaktifkan di panggung, API Gateway akan membuat peran terkait layanan di akun Anda, jika peran tersebut belum ada. Peran tersebut diberi nama AWSServiceRoleForAPIGateway dan akan memiliki kebijakan APIGatewayServiceRolePolicy terkelola yang melekat padanya. Untuk informasi selengkapnya tentang peran terkait layanan, lihat Menggunakan Peran Tertaut Layanan.

  catatan

  X-Ray menerapkan algoritma sampling untuk memastikan bahwa penelusuran efisien, sambil tetap memberikan sampel representatif dari permintaan yang diterima API Anda. Algoritma pengambilan sampel default adalah 1 permintaan per detik, dengan 5 persen permintaan sampel melewati batas itu.

Anda dapat mengubah mode penelusuran untuk API Anda dengan menggunakan konsol manajemen API Gateway, API Gateway CLI, atau AWS SDK.

Izin untuk penelusuran X-Ray

Saat Anda mengaktifkan penelusuran X-Ray di panggung, API Gateway akan membuat peran terkait layanan di akun Anda, jika peran tersebut belum ada. Peran tersebut diberi nama AWSServiceRoleForAPIGateway dan akan memiliki kebijakan APIGatewayServiceRolePolicy terkelola yang melekat padanya. Untuk informasi selengkapnya tentang peran terkait layanan, lihat Menggunakan Peran Tertaut Layanan.

Mengaktifkan penelusuran X-Ray di konsol API Gateway

Anda dapat menggunakan konsol Amazon API Gateway untuk mengaktifkan penelusuran aktif pada tahap API.

Langkah-langkah ini mengasumsikan bahwa Anda telah menerapkan API ke suatu panggung.

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

2. Pilih API Anda, lalu di panel navigasi utama, pilih Tahapan.

3. Di panel Tahapan, pilih panggung.

4. Di bagian Log dan penelusuran, pilih Edit.

5. Untuk mengaktifkan penelusuran X-Ray aktif, pilih penelusuran X-Ray untuk mengaktifkan penelusuran X-Ray.

6. Pilih Simpan perubahan.

Setelah mengaktifkan X-Ray untuk tahap API, Anda dapat menggunakan konsol manajemen X-Ray untuk melihat jejak dan peta layanan.

Mengaktifkan AWS X-Ray penelusuran menggunakan API Gateway CLI

Untuk menggunakan AWS CLI cara mengaktifkan penelusuran X-Ray aktif untuk tahap API saat Anda membuat stage, panggil perintah create-stage seperti pada contoh berikut:

aws apigateway create-stage \
    --rest-api-id {rest-api-id} \
    --stage-name {stage-name} \
    --deployment-id {deployment-id} \
    --region {region} \
    --tracing-enabled=true

Berikut ini adalah contoh output untuk pemanggilan yang berhasil:

{
    "tracingEnabled": true, 
    "stageName": {stage-name}, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": {deployment-id}, 
    "lastUpdatedDate": 1533849811, 
    "createdDate": 1533849811, 
    "methodSettings": {}
}

Untuk menggunakan AWS CLI cara menonaktifkan penelusuran X-Ray aktif untuk tahap API saat Anda membuat stage, panggil perintah create-stage seperti pada contoh berikut:

aws apigateway create-stage \
    --rest-api-id {rest-api-id} \
    --stage-name {stage-name} \
    --deployment-id {deployment-id} \
    --region {region} \
    --tracing-enabled=false

Berikut ini adalah contoh output untuk pemanggilan yang berhasil:

{
    "tracingEnabled": false, 
    "stageName": {stage-name}, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": {deployment-id}, 
    "lastUpdatedDate": 1533849811, 
    "createdDate": 1533849811, 
    "methodSettings": {}
}

Untuk menggunakan AWS CLI untuk mengaktifkan penelusuran X-Ray aktif untuk API yang sudah digunakan, panggil perintah tahap pembaruan sebagai berikut:

aws apigateway update-stage \
    --rest-api-id {rest-api-id} \
    --stage-name {stage-name} \
    --patch-operations op=replace,path=/tracingEnabled,value=true

Untuk menggunakan fitur AWS CLI untuk menonaktifkan penelusuran X-Ray aktif untuk API yang sudah di-deploy, panggil perintah update-stage seperti pada contoh berikut:

aws apigateway update-stage \
    --rest-api-id {rest-api-id} \
    --stage-name {stage-name} \
    --region {region} \
    --patch-operations op=replace,path=/tracingEnabled,value=false

Berikut ini adalah contoh output untuk pemanggilan yang berhasil:

{
    "tracingEnabled": false, 
    "stageName": {stage-name}, 
    "cacheClusterEnabled": false, 
    "cacheClusterStatus": "NOT_AVAILABLE", 
    "deploymentId": {deployment-id}, 
    "lastUpdatedDate": 1533850033, 
    "createdDate": 1533849811, 
    "methodSettings": {}
}

Setelah Anda mengaktifkan X-Ray untuk tahap API Anda, gunakan X-Ray CLI untuk mengambil informasi jejak. Untuk informasi selengkapnya, lihat Menggunakan X-Ray API dengan AWS CLI.