Memantau penggunaan API

Halaman ini menjelaskan cara menggunakan metrik API untuk melacak dan memahami penggunaan Google API dan Google Cloud API oleh Anda.

Google API menghasilkan metrik penggunaan mendetail yang dapat membantu Anda:

Melacak dan memahami penggunaan Google API Anda.
Pantau performa aplikasi Anda dan Google API.
Temukan masalah antara aplikasi Anda dan Google API.

Hal ini dapat mempercepat waktu penyelesaian secara signifikan saat Anda memecahkan masalah atau memerlukan dukungan teknis dari Google.

Metrik yang dihasilkan Google API adalah sinyal standar yang digunakan Site Reliability Engineer Google untuk menilai kondisi layanan. Metrik ini mencakup jumlah permintaan, tingkat error, total latensi, latensi backend, ukuran permintaan, dan ukuran respons. Untuk definisi metrik API, baca dokumentasi Cloud Monitoring.

Anda dapat melihat metrik API di dua tempat: Dasbor API dan Cloud Monitoring. Metrik yang Anda lihat bersifat spesifik untuk project Anda, dan tidak mencerminkan status layanan secara keseluruhan.

Menggunakan Dasbor API

Cara paling sederhana untuk melihat metrik API Anda adalah dengan menggunakan Dasbor API konsol Google Cloud. Anda dapat melihat ringkasan semua penggunaan API, atau melihat perincian penggunaan API tertentu.

Untuk melihat ringkasan penggunaan API Anda:

Buka bagian APIs and Services di Cloud Console. Dasbor API utama ditampilkan secara default. Di halaman ini, Anda dapat melihat semua API yang saat ini telah diaktifkan untuk project Anda, serta diagram ringkasan untuk metrik berikut:
- Traffic: jumlah permintaan per detik yang dibuat oleh atau tentang project Anda ke API yang diaktifkan
- Error: persentase permintaan ke API yang diaktifkan yang mengakibatkan error
- Latensi median: latensi median untuk permintaan ke API yang diaktifkan, jika tersedia".

Untuk melihat detail penggunaan untuk API tertentu:

Pilih API yang ingin Anda lihat di daftar Dasbor API utama dari API. Halaman Ringkasan API menampilkan diagram traffic yang lebih mendetail dengan perincian berdasarkan kode respons.
Untuk informasi penggunaan yang lebih mendetail, pilih Lihat metrik. Secara default, diagram bawaan berikut akan ditampilkan, meskipun ada lebih banyak lagi yang tersedia:
- Traffic menurut kode respons
- Error menurut metode API
- Latensi keseluruhan pada persentil ke-50, ke-95, dan ke-99
- Latensi menurut metode API (median)
Jika ingin menambahkan lebih banyak diagram, Anda dapat memilih diagram siap pakai lainnya dari menu drop-down Select Graphs.

Menggunakan Cloud Monitoring

Jika menggunakan Cloud Monitoring, Anda dapat mempelajari data metrik yang tersedia lebih dalam menggunakan Metrics Explorer untuk memberikan insight yang lebih luas tentang penggunaan API Anda. Cloud Monitoring mendukung berbagai metrik, yang dapat Anda gabungkan dengan filter dan agregasi untuk melihat tampilan baru dan bermanfaat tentang performa aplikasi Anda. Misalnya, Anda dapat menggabungkan metrik jumlah permintaan dengan filter pada class Kode Respons HTTP untuk membuat dasbor yang menampilkan tingkat error dari waktu ke waktu, atau Anda dapat melihat latensi persentil ke-95 permintaan ke Cloud Pub/Sub API.

Metrik yang tersedia

Tabel berikut mencantumkan metrik serviceruntime yang tersedia. Metrik penggunaan API adalah metrik yang menyertakan consumed_api sebagai resource yang dipantau.

String "jenis metrik" dalam tabel ini harus diawali dengan serviceruntime.googleapis.com/. Awalan tersebut telah dihilangkan dari entri dalam tabel. Saat membuat kueri label, gunakan awalan metric.labels.; misalnya, metric.labels.LABEL="VALUE".

Jenis metrik ^{Tahap peluncuran} Nama tampilan
Jenis, Tipe, Unit Resource yang dimonitor	Deskripsi Label
`api/request_count` ^GA Jumlah permintaan
`DELTA`, `INT64`, `1` api consumed_api produced_api	Jumlah permintaan yang diselesaikan. Diambil sampelnya setiap 1800 detik. Setelah mengambil sampel, data tidak akan terlihat selama maksimal 1800 detik. `protocol`: Protokol permintaan, misalnya "http", "grpc". `response_code`: Kode respons HTTP untuk permintaan HTTP, atau kode HTTP yang setara untuk permintaan gRPC. Lihat pemetaan kode di https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto. `response_code_class`: Class kode respons untuk permintaan HTTP, atau class setara HTTP untuk permintaan gRPC, misalnya "2xx", "4xx". `grpc_status_code`: Kode respons gRPC numerik untuk permintaan gRPC, atau kode yang setara dengan gRPC untuk permintaan HTTP. Lihat pemetaan kode di https://github.com/googleapis/googleapis/blob/master/google/rpc/code.proto.
`api/request_latencies` ^GA Latensi permintaan
`DELTA`, `DISTRIBUTION`, `s` api consumed_api produced_api	Distribusi latensi dalam hitungan detik untuk permintaan non-streaming. Diambil sampelnya setiap 1800 detik. Setelah mengambil sampel, data tidak akan terlihat selama maksimal 1800 detik.
`api/request_latencies_backend` ^GA Meminta latensi backend
`DELTA`, `DISTRIBUTION`, `s` api produced_api	Distribusi latensi backend dalam hitungan detik untuk permintaan non-streaming. Diambil sampelnya setiap 1800 detik. Setelah mengambil sampel, data tidak akan terlihat selama maksimal 1800 detik.
`api/request_latencies_overhead` ^GA Meminta latensi overhead
`DELTA`, `DISTRIBUTION`, `s` api produced_api	Distribusi latensi permintaan dalam hitungan detik untuk permintaan non-streaming yang tidak mencakup backend. Diambil sampelnya setiap 1800 detik. Setelah mengambil sampel, data tidak akan terlihat selama maksimal 1800 detik.
`api/request_sizes` ^GA Ukuran permintaan
`DELTA`, `DISTRIBUTION`, `By` api consumed_api produced_api	Distribusi ukuran permintaan dalam byte yang dicatat saat penyelesaian permintaan. Diambil sampelnya setiap 1800 detik. Setelah mengambil sampel, data tidak akan terlihat selama maksimal 1800 detik.
`api/response_sizes` ^GA Ukuran respons
`DELTA`, `DISTRIBUTION`, `By` api consumed_api produced_api	Distribusi ukuran respons dalam byte yang dicatat saat penyelesaian permintaan. Diambil sampelnya setiap 1800 detik. Setelah mengambil sampel, data tidak akan terlihat selama maksimal 1800 detik.
`quota/allocation/usage` ^GA Penggunaan kuota alokasi
`GAUGE`, `INT64`, `1` consumer_quota producer_quota	Total kuota alokasi yang dipakai. Nilai yang dilaporkan lebih dari 1/mnt akan dihapus. Jika tidak ada perubahan yang diterima dalam penggunaan kuota, nilai terakhir akan diulangi setidaknya setiap 24 jam. Diambil sampelnya setiap 60 detik. `quota_metric`: Nama metrik kuota atau grup kuota.
`quota/concurrent/exceeded` ^ALFA Kuota Serentak Terlampaui
`DELTA`, `INT64`, `1` consumer_quota	Jumlah percobaan yang melebihi kuota serentak. Diambil sampelnya setiap 86.400 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 180 detik. `limit_name`: Nama batas kuota, misalnya "Permintaan per hari" atau "Alamat IP yang sedang digunakan". `quota_metric`: Nama metrik kuota atau grup kuota. `time_window`: Ukuran jendela untuk batas operasi serentak.
`quota/concurrent/limit` ^ALFA Batas Kuota Serentak
`GAUGE`, `INT64`, `1` consumer_quota producer_quota	Batas kuota serentak. Diambil sampelnya setiap 86.400 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 180 detik. `limit_name`: Nama batas kuota, misalnya "Permintaan per hari" atau "Alamat IP yang sedang digunakan". `quota_metric`: Nama metrik kuota atau grup kuota. `time_window`: Ukuran jendela untuk batas operasi serentak.
`quota/concurrent/usage` ^ALFA Penggunaan Kuota Serentak
`GAUGE`, `INT64`, `1` consumer_quota producer_quota	Penggunaan kuota secara serentak. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 180 detik. `limit_name`: Nama batas kuota, misalnya "Permintaan per hari" atau "Alamat IP yang sedang digunakan". `quota_metric`: Nama metrik kuota atau grup kuota. `time_window`: Ukuran jendela untuk batas operasi serentak.
`quota/exceeded` ^GA Error kuota terlampaui
`GAUGE`, `BOOL`, `1` consumer_quota	Error terjadi saat batas kuota terlampaui. Diambil sampelnya setiap 60 detik. `limit_name`: Nama batas kuota, misalnya "Permintaan per hari" atau "Alamat IP yang sedang digunakan". `quota_metric`: Nama metrik kuota atau grup kuota.
`quota/limit` ^GA Batas kuota
`GAUGE`, `INT64`, `1` consumer_quota producer_quota	Batas kuota. Diambil sampelnya setiap 86.400 detik. `limit_name`: Nama batas kuota, misalnya "Permintaan per hari" atau "Alamat IP yang sedang digunakan". `quota_metric`: Nama metrik kuota atau grup kuota.
`quota/rate/net_usage` ^GA Penggunaan kuota tarif
`DELTA`, `INT64`, `1` consumer_quota producer_quota	Total kuota tarif yang terpakai. Dibuat sampelnya setiap 60 detik. Setelah mengambil sampel, data tidak akan terlihat selama maksimal 240 detik. `method`: Nama metode API, seperti "disks.list". `quota_metric`: Nama metrik kuota atau grup kuota.
`reserved/metric1` ^EARLY_ACCESS Tidak digunakan lagi
`DELTA`, `INT64`, `1` deprecated_resource	Tidak digunakan lagi. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 180 detik. `quota_name`: Tidak digunakan lagi. `credential_id`: Tidak digunakan lagi. `quota_location`: Tidak digunakan lagi.

Tabel dihasilkan pada 11-04-2024 19.12.46 UTC.

Untuk melihat metrik API di Metrics Explorer, pilih Consumed API sebagai jenis resource, lalu pilih salah satu metrik serviceruntime. Kemudian gunakan opsi filter dan agregasi untuk menyaring data Anda. Setelah menemukan informasi penggunaan API yang diinginkan, Anda dapat menggunakan Cloud Monitoring untuk membuat pemberitahuan dan dasbor kustom yang akan membantu Anda terus memantau dan memelihara aplikasi yang andal. Anda dapat mengetahui cara melakukannya di halaman berikut:

Untuk informasi selengkapnya, lihat Metrics Explorer.

Pemecahan masalah dengan metrik API

Metrik API dapat sangat berguna jika Anda perlu menghubungi Google saat terjadi masalah, dan bahkan dapat menunjukkan bahwa Anda tidak perlu menghubungi dukungan sama sekali. Contoh:

Jika semua panggilan ke layanan gagal untuk satu ID kredensial, tetapi bukan yang lain, kemungkinan ada yang salah dengan akun tersebut sehingga Anda dapat dengan mudah memperbaikinya tanpa harus membuka tiket.
Anda sedang memecahkan masalah terkait aplikasi Anda, dan melihat korelasi antara penurunan performa aplikasi Anda dan peningkatan berkelanjutan pada latensi persentil ke-50 dari layanan GCP penting. Hubungi kami dan arahkan kami ke data ini sehingga kami dapat mulai menyelesaikan masalah ini secepat mungkin.
Latensi untuk laporan layanan GCP terlihat bagus dan tidak berubah dari sebelumnya, tetapi metrik dalam aplikasi Anda melaporkan bahwa latensi pada panggilan ke layanan biasanya tinggi. Ini memberitahu Anda bahwa ada beberapa masalah dalam jaringan. Panggil penyedia jaringan Anda (dalam beberapa kasus, Google) untuk memulai proses debug.

Praktik terbaik

Meskipun metrik API adalah alat yang sangat berguna, ada masalah yang perlu Anda pertimbangkan untuk memastikan metrik tersebut memberikan informasi yang berguna, terutama saat menyiapkan pemberitahuan berdasarkan nilai metrik. Praktik terbaik berikut akan membantu Anda mendapatkan hasil maksimal dari data metrik API.

Apakah latensi menyebabkan masalah?

Meskipun beberapa layanan sangat sensitif terhadap latensi, skala dan keandalan bagi layanan lainnya lebih penting. Misalnya, beberapa API, Cloud Storage atau BigQuery, dapat memiliki latensi tinggi selama beberapa detik tanpa sepengetahuan pelanggan. Dengan data dari metrik API, Anda dapat mempelajari hal yang dibutuhkan pengguna dari layanan tertentu.

Cari perubahan dari kebiasaan

Sebelum memutuskan untuk memperingatkan nilai metrik tertentu, pertimbangkan hal-hal yang sebenarnya dianggap sebagai perilaku yang tidak biasa. Dengan melihat metrik API, Anda dapat menunjukkan bahwa hasil latensi untuk sebagian besar layanan berada dalam distribusi normal: punuk besar di tengah, dan pencilan di kedua sisi. Metrik ini akan membantu Anda memahami distribusi normal sehingga Anda dapat merekayasa aplikasi agar berfungsi dengan baik dalam kurva distribusi. Metrik juga dapat membantu Anda menghubungkan perubahan distribusi dengan waktu saat aplikasi Anda tidak berfungsi sebagaimana mestinya, untuk membantu Anda menemukan akar penyebab masalah. Kami memperkirakan persentil ke-99 akan terlihat sangat berbeda dengan median — yang tidak kami harapkan adalah perubahan dramatis pada persentil tersebut dari waktu ke waktu.

Anda juga mungkin melihat bahwa beberapa jenis permintaan memerlukan waktu lebih lama dibandingkan yang lain. Jika ukuran median foto yang diupload ke Google Foto adalah 4 MB, tetapi Anda biasanya mengupload file RAW 20 MB, waktu rata-rata Anda untuk mengupload 20 foto mungkin akan lebih buruk dibandingkan sebagian besar pengguna, tetapi masih perilaku Anda normal.

Artinya, tidak terlalu berguna untuk memberi tahu saat pertama kali panggilan RPC atau HTTP 5xx berdurasi dua detik terdeteksi. Sebagai gantinya, saat menyelidiki layanan Google sebagai kemungkinan penyebab masalah yang dialami aplikasi Anda, bandingkan kode pengembalian dan tingkat latensi dari waktu ke waktu serta cari perubahan berkelanjutan dari norma yang berkorelasi dengan masalah yang diamati di aplikasi Anda.

Rasio traffic

Metrik API akan sangat berguna jika Anda memiliki volume traffic yang tinggi yang mengarah ke API. Jika Anda hanya sesekali memanggil layanan, metrik API tidak akan valid secara statistik dan tidak akan memberi Anda informasi triase yang berarti.

Misalnya, jika Anda ingin melacak latensi persentil ke-99,5 untuk suatu layanan, dan Anda hanya melakukan 100 panggilan per jam, mengamati pengukuran selama periode dua jam hanya akan memberi Anda satu titik data untuk mewakili persentil ke-99,5. Hal ini tidak akan memberi tahu Anda banyak hal tentang perilaku normal API atau aplikasi Anda. Pastikan rasio traffic, persentil yang Anda lacak, dan periode waktu yang Anda pertimbangkan untuk menghasilkan banyak lokasi menarik data atau data pemantauan tidak akan membantu Anda.

API yang didukung

Semua Google API dan Google Cloud API, serta API yang di-build berdasarkan Endpoint Cloud dan Gateway API, mendukung metrik API. Jika Anda adalah konsumen API, Anda dapat melihat metrik Consumed API di Dasbor API. Jika Anda adalah produser API, Anda dapat melihat metrik yang dihasilkan API di Dasbor Endpoint.