Siapkan AWS X-Ray dengan API Gateway REST APIs

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

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

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

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 HTTP GETatau POST permintaan.

Ada dua mode penelusuran untuk API Gateway API:

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.

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

Perintah create-stage berikut membuat tahapan dengan penelusuran X-Ray aktif:

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

Outputnya akan terlihat seperti berikut:

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

Perintah create-stage berikut membuat panggung tanpa penelusuran X-Ray aktif:

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

Outputnya akan terlihat seperti berikut:

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

Tahap pembaruan berikut mengaktifkan penelusuran X-Ray aktif untuk API yang diterapkan:

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

Tahap pembaruan berikut menonaktifkan penelusuran X-Ray aktif untuk API yang diterapkan:

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

Outputnya akan terlihat seperti berikut:

{
    "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.