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

# Siapkan AWS X-Ray dengan API Gateway REST APIs
<a name="apigateway-enabling-xray"></a>

Di bagian ini Anda dapat menemukan informasi terperinci tentang cara mengatur [AWS X-Ray](https://docs.aws.amazon.com/xray/latest/devguide/xray-services-apigateway.html)dengan API Gateway REST APIs.

**Topics**
+ [Mode penelusuran X-Ray untuk API Gateway](#apigateway-tracing-modes)
+ [Izin untuk penelusuran X-Ray](#set-up-xray-tracing-permissions)
+ [Mengaktifkan penelusuran X-Ray di konsol API Gateway](#apigateway-xray-console-setup)
+ [Mengaktifkan AWS X-Ray penelusuran menggunakan API Gateway CLI](#apigateway-xray-cli-setup)

## Mode penelusuran X-Ray untuk API Gateway
<a name="apigateway-tracing-modes"></a>

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](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html).
**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
<a name="set-up-xray-tracing-permissions"></a>

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](https://docs.aws.amazon.com/IAM/latest/UserGuide/using-service-linked-roles.html).

## Mengaktifkan penelusuran X-Ray di konsol API Gateway
<a name="apigateway-xray-console-setup"></a>

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](https://console.aws.amazon.com/apigateway).

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

1. Di panel **Tahapan**, pilih panggung.

1. Di bagian **Log dan penelusuran**, pilih **Edit**.

1. Untuk mengaktifkan penelusuran X-Ray aktif, pilih penelusuran **X-Ray untuk mengaktifkan penelusuran** X-Ray.

1. 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
<a name="apigateway-xray-cli-setup"></a>

Perintah [create-stage](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-stage.html) 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](https://docs.aws.amazon.com/cli/latest/reference/apigateway/create-stage.html) 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](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-stage.html) 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](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-stage.html) 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](https://docs.aws.amazon.com/xray/latest/devguide/aws-xray-interface-api.html#xray-api-tutorial).