Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
# Pantau eksekusi REST API dengan CloudWatch metrik Amazon
Anda dapat memantau eksekusi API dengan menggunakan CloudWatch, yang mengumpulkan dan memproses data mentah dari API Gateway menjadi metrik yang dapat dibaca. near-real-time Statistik ini dicatat untuk jangka waktu 15 bulan sehingga Anda dapat mengakses informasi historis dan mendapatkan perspektif yang lebih baik tentang kinerja aplikasi atau layanan web Anda. Secara default, data metrik API Gateway dikirim secara otomatis CloudWatch dalam periode satu menit. Untuk informasi selengkapnya, lihat [Apa itu Amazon CloudWatch?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) di *Panduan CloudWatch Pengguna Amazon*.
Metrik yang dilaporkan oleh API Gateway memberikan informasi yang dapat Anda analisis dengan berbagai cara. Daftar berikut menunjukkan beberapa kegunaan umum untuk metrik yang merupakan saran untuk Anda mulai:
+ Pantau **IntegrationLatency**metrik untuk mengukur respons backend.
+ Pantau metrik **Latensi** untuk mengukur respons panggilan API Anda secara keseluruhan.
+ Pantau **CacheHitCount**dan **CacheMissCount**metrik untuk mengoptimalkan kapasitas cache untuk mencapai kinerja yang diinginkan.
**Topics**
+ [Dimensi dan metrik Amazon API Gateway](api-gateway-metrics-and-dimensions.md)
+ [Lihat CloudWatch metrik dengan dasbor API di API Gateway](how-to-api-dashboard.md)
+ [Lihat metrik API Gateway di konsol CloudWatch](metrics_dimensions_view_in_cloud_watch.md)
+ [Melihat peristiwa log API Gateway di CloudWatch konsol](view-cloudwatch-log-events-in-cloudwatch-console.md)
+ [Alat pemantauan AWS untuk API Gateway](monitoring_automated_manual.md)
# Dimensi dan metrik Amazon API Gateway
Metrik dan dimensi yang dikirimkan API Gateway ke Amazon CloudWatch tercantum di bawah ini. Untuk informasi selengkapnya, lihat [Pantau eksekusi REST API dengan CloudWatch metrik Amazon](monitoring-cloudwatch.md).
## Metrik API Gateway
Amazon API Gateway mengirimkan data metrik ke CloudWatch setiap menit.
Namespace `AWS/ApiGateway` mencakup metrik berikut.
| Metrik | Deskripsi |
| --- | --- |
| 4XXError | Jumlah kesalahan sisi klien yang ditangkap dalam periode tertentu. API Gateway menghitung kode status respons gateway yang dimodifikasi sebagai 4 XXError kesalahan. `Sum`Statistik mewakili metrik ini, yaitu, jumlah total 4XXError kesalahan dalam periode tertentu. `Average`Statistik mewakili tingkat 4XXError kesalahan, yaitu, jumlah total 4XXError kesalahan dibagi dengan jumlah total permintaan selama periode tersebut. Penyebut sesuai dengan Count metrik (di bawah). Unit: Count |
| 5XXError | Jumlah kesalahan sisi server yang ditangkap dalam periode tertentu. `Sum`Statistik mewakili metrik ini, yaitu, jumlah total 5XXError kesalahan dalam periode tertentu. `Average`Statistik mewakili tingkat 5XXError kesalahan, yaitu, jumlah total 5XXError kesalahan dibagi dengan jumlah total permintaan selama periode tersebut. Penyebut sesuai dengan Count metrik (di bawah). Unit: Count |
| CacheHitCount | Jumlah permintaan yang disajikan dari cache API dalam periode tertentu. `Sum`Statistik mewakili metrik ini, yaitu, jumlah total hit cache pada periode tertentu. `Average`Statistik mewakili tingkat hit cache, yaitu, jumlah total klik cache dibagi dengan jumlah total permintaan selama periode tersebut. Penyebut sesuai dengan Count metrik (di bawah). Unit: Count |
| CacheMissCount | Jumlah permintaan yang disajikan dari backend dalam periode tertentu, saat caching API diaktifkan. `Sum`Statistik mewakili metrik ini, yaitu, jumlah total cache yang hilang dalam periode tertentu. `Average`Statistik mewakili tingkat kehilangan cache, yaitu, jumlah total cache yang hilang dibagi dengan jumlah total permintaan selama periode tersebut. Penyebut sesuai dengan Count metrik (di bawah). Unit: Count |
| Count | Jumlah total permintaan API dalam periode tertentu. `SampleCount`Statistik mewakili metrik ini. Unit: Count |
| IntegrationLatency | Waktu antara saat API Gateway menyampaikan permintaan ke backend dan saat menerima respons dari backend. Unit: Millisecond |
| Latency | Waktu antara saat API Gateway menerima permintaan dari klien dan saat mengembalikan respons ke klien. Latensi mencakup latensi integrasi dan overhead API Gateway lainnya. Unit: Millisecond |
## Dimensi untuk metrik
Anda dapat menggunakan dimensi dalam tabel berikut untuk memfilter metrik API Gateway.
**catatan**
API Gateway menghapus karakter non-ASCII dari ApiName dimensi sebelum mengirim metrik ke. CloudWatch Jika tidak APIName mengandung karakter ASCII, API ID digunakan sebagai. ApiName
| Dimensi | Deskripsi |
| --- | --- |
| ApiName | Memfilter metrik API Gateway untuk REST API dengan nama API yang ditentukan. |
| ApiName, Method, Resource, Stage | Memfilter metrik API Gateway untuk metode API dengan nama API, tahapan, sumber daya, dan metode yang ditentukan. API Gateway tidak akan mengirimkan metrik ini kecuali Anda telah mengaktifkan metrik terperinci secara eksplisit. CloudWatch Di konsol, pilih panggung, lalu untuk **Log dan penelusuran**, pilih **Edit**. Pilih **Metrik terperinci**, lalu pilih **Simpan perubahan**. Atau, Anda dapat memanggil AWS CLI perintah [update-stage](https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-stage.html) untuk memperbarui properti ke. `metricsEnabled` `true` Mengaktifkan metrik ini akan dikenakan biaya tambahan ke akun Anda. Untuk informasi harga, lihat [ CloudWatchHarga Amazon](https://aws.amazon.com/cloudwatch/pricing/). |
| ApiName, Stage | Memfilter metrik API Gateway untuk sumber daya tahap API dengan nama dan tahapan API yang ditentukan. |
# Lihat CloudWatch metrik dengan dasbor API di API Gateway
Anda dapat menggunakan dasbor API di API Gateway Console untuk menampilkan CloudWatch metrik API yang Anda gunakan di API Gateway. Ini ditampilkan sebagai ringkasan aktivitas API dari waktu ke waktu.
**Topics**
+ [Prasyarat](#how-to-api-dashboard-prerequisites)
+ [Periksa aktivitas API di dasbor](#how-to-api-dashboard-console)
## Prasyarat
1. Anda harus memiliki API yang dibuat di API Gateway. Ikuti petunjuk dalam [Kembangkan REST APIs di API Gateway](rest-api-develop.md).
1. Anda harus memiliki API yang diterapkan setidaknya sekali. Ikuti petunjuk dalam [Menerapkan REST APIs di API Gateway](how-to-deploy-api.md).
## Periksa aktivitas API di dasbor
1. Masuk ke konsol API Gateway di [https://console.aws.amazon.com/apigateway](https://console.aws.amazon.com/apigateway).
1. Pilih API.
1. Di panel navigasi utama, pilih **Dasbor**.
1. Untuk **Panggung**, pilih tahap yang diinginkan.
1. Pilih **Rentang tanggal** untuk menentukan rentang tanggal.
1. ****Segarkan, jika diperlukan, dan lihat metrik individual yang ditampilkan dalam grafik terpisah berjudul **Panggilan API**, Latensi, Latensi **integrasi, **Latensi**, kesalahan 4xx**, dan **kesalahan 5xx**.****
**Tip**
Untuk memeriksa CloudWatch metrik tingkat metode, pastikan Anda telah mengaktifkan CloudWatch Log pada tingkat metode. Untuk informasi selengkapnya tentang cara mengatur logging tingkat metode, lihat. [Ganti pengaturan tingkat panggung](set-up-stages.md#how-to-method-override)
# Lihat metrik API Gateway di konsol CloudWatch
Metrik dikelompokkan terlebih dahulu berdasarkan namespace layanan, lalu berdasarkan berbagai kombinasi dimensi dalam setiap namespace. Untuk melihat metrik di tingkat metode untuk API Anda, aktifkan metrik terperinci. Untuk informasi selengkapnya, lihat [Ubah pengaturan panggung](set-up-stages.md#how-to-stage-settings).
**Untuk melihat metrik API Gateway menggunakan konsol CloudWatch**
1. Buka CloudWatch konsol di [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. Jika perlu, ubah Wilayah AWS. Dari bilah navigasi, pilih Wilayah tempat AWS sumber daya Anda berada.
1. Pada panel navigasi, silakan pilih **Metrik**.
1. Di tab **Semua metrik**, pilih **API Gateway**.
1. Untuk melihat metrik berdasarkan tahap, pilih panel **Berdasarkan Tahap**. Kemudian, pilih nama Anda APIs dan metrik.
1. Untuk melihat metrik berdasarkan API tertentu, pilih panel **By Api Name**. Kemudian, pilih nama Anda APIs dan metrik.
**Untuk melihat metrik menggunakan CLI AWS**
1. Gunakan perintah [daftar-metrik berikut untuk membuat daftar metrik](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/list-metrics.html):
```
aws cloudwatch list-metrics --namespace "AWS/ApiGateway"
```
Setelah Anda membuat metrik, biarkan hingga 15 menit agar metrik muncul. Untuk melihat statistik metrik lebih cepat, gunakan [get-metric-data](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/update-domain-name.html)atau [get-metric-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/update-domain-name.html).
1. Gunakan [get-metrics-statistics](https://docs.aws.amazon.com/cli/latest/reference/cloudwatch/get-metric-statistics.html)perintah berikut untuk melihat rata-rata selama periode waktu menggunakan interval 5 menit:
```
aws cloudwatch get-metric-statistics --namespace AWS/ApiGateway --metric-name Count --start-time 2011-10-03T23:00:00Z --end-time 2017-10-05T23:00:00Z --period 300 --statistics Average
```
# Melihat peristiwa log API Gateway di CloudWatch konsol
Bagian berikut menjelaskan prasyarat yang diperlukan dan cara melihat peristiwa log API Gateway di konsol. CloudWatch
## Prasyarat
1. Anda harus memiliki API yang dibuat di API Gateway. Ikuti petunjuk dalam [Kembangkan REST APIs di API Gateway](rest-api-develop.md).
1. Anda harus memiliki API yang diterapkan dan dipanggil setidaknya sekali. Ikuti instruksi di [Menerapkan REST APIs di API Gateway](how-to-deploy-api.md) dan[Panggil REST APIs di API Gateway](how-to-call-api.md).
1. Anda harus mengaktifkan CloudWatch Log untuk sebuah panggung. Ikuti petunjuk dalam [Siapkan CloudWatch logging untuk REST APIs di API Gateway](set-up-logging.md).
## Untuk melihat permintaan dan tanggapan API yang dicatat menggunakan CloudWatch konsol
1. Buka CloudWatch konsol di [https://console.aws.amazon.com/cloudwatch/](https://console.aws.amazon.com/cloudwatch/).
1. Jika perlu, ubah Wilayah AWS. Dari bilah navigasi, pilih Wilayah tempat AWS sumber daya Anda berada. Untuk informasi selengkapnya, lihat [Wilayah dan Titik Akhir](https://docs.aws.amazon.com/general/latest/gr/rande.html).
1. Di panel navigasi, pilih **Log**, **Grup log**.
1. Di bawah tabel **Grup Log, pilih grup log** dari nama **API-gateway-Execution-logs\$1** \$1\$1/\$1stage-name\$1. rest-api-id
1. Di bawah tabel **Aliran Log**, pilih aliran log. Anda dapat menggunakan stempel waktu untuk membantu menemukan aliran log yang Anda minati.
1. Pilih **Teks** untuk melihat teks mentah atau pilih **Baris** untuk melihat acara baris demi baris.
**penting**
CloudWatch memungkinkan Anda menghapus grup log atau aliran. Jangan menghapus grup atau aliran log API Gateway API secara manual; biarkan API Gateway mengelola sumber daya ini. Menghapus grup log atau aliran secara manual dapat menyebabkan permintaan dan tanggapan API tidak dicatat. Jika itu terjadi, Anda dapat menghapus seluruh grup log untuk API dan menerapkan ulang API. Ini karena API Gateway membuat grup log atau aliran log untuk tahap API pada saat digunakan.
# Alat pemantauan AWS untuk API Gateway
AWS menyediakan berbagai alat yang dapat Anda gunakan untuk memantau API Gateway. Anda dapat mengonfigurasi beberapa alat ini untuk melakukan pemantauan untuk Anda secara otomatis, sementara alat lain memerlukan intervensi manual. Sebaiknya Anda mengotomatisasi tugas pemantauan sebanyak mungkin.
## Alat pemantauan otomatis di AWS
Anda dapat menggunakan alat pemantauan otomatis berikut untuk menonton API Gateway dan melaporkan bila ada sesuatu yang salah:
+ ** CloudWatch Alarm Amazon** — Tonton satu metrik selama periode waktu yang Anda tentukan, dan lakukan satu atau beberapa tindakan berdasarkan nilai metrik relatif terhadap ambang batas tertentu selama beberapa periode waktu. Tindakannya adalah pemberitahuan yang dikirim ke topik Amazon Simple Notification Service (Amazon SNS) atau kebijakan Amazon EC2 Auto Scaling. CloudWatch alarm tidak memanggil tindakan hanya karena mereka berada dalam keadaan tertentu; negara harus telah berubah dan dipertahankan untuk sejumlah periode tertentu. Untuk informasi selengkapnya, lihat [Pantau eksekusi REST API dengan CloudWatch metrik Amazon](monitoring-cloudwatch.md).
+ **Amazon CloudWatch Logs** — Pantau, simpan, dan akses file log Anda dari AWS CloudTrail atau sumber lain. Untuk informasi selengkapnya, lihat [Apa itu CloudWatch Log?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) di *Panduan CloudWatch Pengguna Amazon*.
+ **Amazon EventBridge (sebelumnya disebut CloudWatch Acara)** — Cocokkan peristiwa dan arahkan ke satu atau beberapa fungsi atau aliran target untuk membuat perubahan, menangkap informasi status, dan mengambil tindakan korektif. Untuk informasi selengkapnya, lihat [Apa itu Amazon EventBridge?](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-what-is.html) dalam *EventBridge User Guide*.
+ **AWS CloudTrail Pemantauan Log** - Bagikan file log antar akun, pantau file CloudTrail log secara real time dengan mengirimkannya ke CloudWatch Log, menulis aplikasi pemrosesan log di Java, dan validasi bahwa file log Anda tidak berubah setelah pengiriman oleh CloudTrail. Untuk informasi selengkapnya, lihat [Bekerja dengan File CloudTrail Log](https://docs.aws.amazon.com/awscloudtrail/latest/userguide/cloudtrail-working-with-log-files.html) di *Panduan AWS CloudTrail Pengguna*.
## Alat pemantauan manual
Bagian penting lainnya dari pemantauan API Gateway melibatkan pemantauan secara manual item yang tidak CloudWatch tercakup oleh alarm. API Gateway CloudWatch,, dan dasbor AWS konsol lainnya memberikan at-a-glance tampilan status AWS lingkungan Anda. Kami menyarankan Anda juga memeriksa file log pada eksekusi API.
+ Dasbor API Gateway menampilkan statistik berikut untuk tahap API tertentu selama periode waktu tertentu:
+ **Panggilan API**
+ **Cache Hit**, hanya ketika caching API diaktifkan.
+ **Cache Miss**, hanya ketika caching API diaktifkan.
+ **Latensi**
+ **Latensi Integrasi**
+ **Kesalahan 4XX**
+ **Kesalahan 5XX**
+ CloudWatch Halaman beranda menunjukkan:
+ Alarm dan status saat ini
+ Grafik alarm dan sumber daya
+ Status kesehatan layanan
Selain itu, Anda dapat menggunakan CloudWatch untuk melakukan hal berikut:
+ Membuat [dasbor yang disesuaikan](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Dashboards.html) untuk memantau layanan yang penting bagi Anda
+ Data metrik grafik untuk memecahkan masalah dan mengungkap tren
+ Cari dan telusuri semua metrik AWS sumber daya Anda
+ Membuat dan mengedit alarm untuk menerima notifikasi terkait masalah
## Membuat CloudWatch alarm untuk memantau API Gateway
Anda dapat membuat CloudWatch alarm yang mengirimkan pesan Amazon SNS saat alarm berubah status. Alarm mengawasi satu metrik selama jangka waktu yang Anda tentukan, dan melakukan satu atau beberapa tindakan berdasarkan nilai metrik relatif terhadap ambang batas tertentu selama jangka waktu tertentu. Tindakan ini adalah notifikasi yang dikirim ke topik Amazon SNS atau kebijakan Penskalaan Otomatis. Alarm memanggil tindakan untuk perubahan status berkelanjutan saja. CloudWatch alarm tidak memanggil tindakan hanya karena mereka berada dalam keadaan tertentu; negara harus telah berubah dan dipertahankan untuk sejumlah periode tertentu.