Memantau penggunaan API

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

Google API menghasilkan metrik penggunaan mendetail yang dapat membantu Anda:

• Melacak dan memahami penggunaan Google API Anda.
• Memantau performa aplikasi dan Google API Anda.
• 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, rasio error, latensi total, latensi backend, ukuran permintaan, dan ukuran respons. Untuk definisi metrik API, lihat dokumentasi Cloud Monitoring.

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

Menggunakan Dasbor API

Cara termudah untuk melihat metrik API adalah menggunakan Dasbor API di Konsol Google Cloud. Anda dapat melihat ringkasan semua penggunaan API, atau Anda dapat melihat perincian penggunaan API tertentu.

Untuk melihat ringkasan penggunaan API Anda:

1. Buka bagian API dan Layanan di Cloud Console. Dasbor API utama ditampilkan secara default. Di halaman ini, Anda dapat melihat semua API yang saat ini 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
   • Errors: persentase permintaan ke API yang diaktifkan yang mengakibatkan error
   • Median latensi: latensi median untuk permintaan ke API yang diaktifkan, jika tersedia".

Catatan: Izin IAM "Project Viewer" sudah cukup untuk melihat dasbor ini.

Untuk melihat detail penggunaan API tertentu:

1. Pilih API yang ingin Anda lihat di daftar API Dasbor API utama. Halaman Ringkasan API menampilkan diagram traffic yang lebih mendetail dengan perincian menurut kode respons.

2. Untuk informasi penggunaan yang lebih mendetail, pilih Lihat metrik. Secara default, diagram bawaan berikut akan ditampilkan, meskipun ada lebih banyak diagram yang tersedia:

   • Traffic menurut kode respons
   • Error menurut metode API
   • Latensi secara keseluruhan pada persentil ke-50, ke-95, dan ke-99
   • Latensi menurut metode API (median)

3. Jika ingin menambahkan diagram lainnya, Anda dapat memilih diagram bawaan tambahan dari menu drop-down Select Graphs.

Menggunakan Cloud Monitoring

Jika menggunakan Cloud Monitoring, Anda dapat mempelajari data metrik yang tersedia lebih mendalam menggunakan Metrics Explorer untuk memberikan insight yang lebih besar tentang penggunaan API Anda. Cloud Monitoring mendukung berbagai metrik, yang dapat digabungkan dengan filter dan agregasi untuk tampilan baru yang bermakna terkait performa aplikasi Anda. Misalnya, Anda dapat menggabungkan metrik jumlah permintaan dengan filter di class Kode Respons HTTP untuk membuat dasbor yang menampilkan rasio 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 (Tingkat hierarki resource) Nama tampilan
Jenis, Tipe, Unit Resource yang dimonitor	Deskripsi Label
api/request_count ^GA  (project) Jumlah permintaan
DELTA, INT64, 1 api consumed_api produced_api	Jumlah permintaan yang diselesaikan. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 1.800 detik. protocol: Protokol permintaan, misalnya "http", "grpc". response_code: Kode respons HTTP untuk permintaan HTTP, atau kode yang setara dengan HTTP 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 yang setara dengan 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  (project) Latensi permintaan
DELTA, DISTRIBUTION, s api consumed_api produced_api	Distribusi latensi dalam detik untuk permintaan non-streaming. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 1.800 detik.
api/request_latencies_backend ^GA  (project) Meminta latensi backend
DELTA, DISTRIBUTION, s api produced_api	Distribusi latensi backend dalam detik untuk permintaan non-streaming. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 1.800 detik.
api/request_latencies_overhead ^GA  (project) Latensi overhead permintaan
DELTA, DISTRIBUTION, s api produced_api	Distribusi latensi permintaan dalam hitungan detik untuk permintaan non-streaming yang tidak menyertakan backend. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 1.800 detik.
api/request_sizes ^GA  (project) Ukuran permintaan
DELTA, DISTRIBUTION, By api consumed_api produced_api	Distribusi ukuran permintaan dalam byte yang dicatat saat permintaan selesai. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 1.800 detik.
api/response_sizes ^GA  (project) Ukuran respons
DELTA, DISTRIBUTION, By api consumed_api produced_api	Distribusi ukuran respons dalam byte yang dicatat saat permintaan selesai. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 1.800 detik.
quota/allocation/usage ^GA  (project, folder, organization) Penggunaan kuota alokasi
GAUGE, INT64, 1 consumer_quota producer_quota	Total kuota alokasi yang digunakan. Nilai yang dilaporkan lebih dari 1/menit akan dihapus. Jika tidak ada perubahan yang diterima dalam penggunaan kuota, nilai terakhir akan diulang setidaknya setiap 24 jam. Diambil sampelnya setiap 60 detik. quota_metric: Nama metrik kuota atau grup kuota.
quota/concurrent/exceeded ^ALPHA  (project, folder, organization) Kuota Serentak Melebihi Batas
DELTA, INT64, 1 consumer_quota	Jumlah percobaan untuk melampaui kuota serentak. Dibuat sampelnya setiap 86.400 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 180 detik. limit_name: Nama batas kuota, seperti "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 ^ALPHA  (project, folder, organization) Batas Kuota serentak
GAUGE, INT64, 1 consumer_quota producer_quota	Batas serentak untuk kuota. Dibuat sampelnya setiap 86.400 detik. Setelah sampelnya dibuat, data tidak akan terlihat selama maksimal 180 detik. limit_name: Nama batas kuota, seperti "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 ^ALPHA  (project, folder, organization) 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, seperti "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  (project, folder, organization) Error kuota terlampaui
GAUGE, BOOL, 1 consumer_quota	Error terjadi saat batas kuota terlampaui. Diambil sampelnya setiap 60 detik. limit_name: Nama batas kuota, seperti "Permintaan per hari" atau "Alamat IP yang sedang digunakan". quota_metric: Nama metrik kuota atau grup kuota.
quota/limit ^GA  (project, folder, organization) Batas kuota
GAUGE, INT64, 1 consumer_quota producer_quota	Batas untuk kuota. Diambil sampelnya setiap 86.400 detik. limit_name: Nama batas kuota, seperti "Permintaan per hari" atau "Alamat IP yang sedang digunakan". quota_metric: Nama metrik kuota atau grup kuota.
quota/rate/net_usage ^GA  (project, folder, organization) Penggunaan kuota tarif
DELTA, INT64, 1 consumer_quota producer_quota	Total kuota tarif yang digunakan. Dibuat sampelnya setiap 60 detik. Setelah sampelnya dibuat, 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  (project) 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 26-11-2024 17.39.42 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 dasbor dan pemberitahuan kustom yang akan membantu Anda terus memantau dan memelihara aplikasi yang andal. Anda dapat mengetahui cara melakukannya di halaman berikut:

• Membuat diagram
• Pengantar pemberitahuan
• Mengelola kebijakan pemberitahuan

Untuk informasi selengkapnya, lihat Metrics Explorer.

Memecahkan 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 Anda ke layanan gagal untuk satu ID kredensial, tetapi tidak untuk yang lain, kemungkinan ada yang salah dengan akun tersebut yang dapat Anda perbaiki sendiri dengan mudah tanpa membuka tiket.
• Anda sedang memecahkan masalah pada aplikasi, dan melihat korelasi antara penurunan performa aplikasi dan peningkatan berkelanjutan pada latensi persentil ke-50 layanan GCP yang penting. Hubungi kami dan tunjukkan data ini kepada kami agar kami dapat mulai mengatasi masalah 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 tersebut secara tidak wajar tinggi. Hal ini menunjukkan bahwa ada masalah di jaringan. Hubungi penyedia jaringan Anda (dalam beberapa kasus, Google) untuk memulai proses 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 cukup sensitif terhadap latensi, untuk layanan lainnya, skala dan keandalan lebih penting. Beberapa API, misalnya Cloud Storage atau BigQuery, dapat memiliki latensi tinggi selama beberapa detik tanpa disadari pelanggan. Dengan data dari metrik API, Anda dapat mempelajari apa yang dibutuhkan pengguna dari layanan tertentu.

Mencari perubahan dari norma

Sebelum memutuskan untuk mengirim pemberitahuan tentang nilai metrik tertentu, pertimbangkan apa yang sebenarnya dianggap sebagai perilaku yang tidak biasa. Melihat metrik API dapat menunjukkan bahwa hasil latensi untuk sebagian besar layanan berada dalam distribusi normal: gumpalan besar di tengah, dan pencilan di kedua sisi. Metrik ini akan membantu Anda memahami distribusi normal sehingga Anda dapat membuat aplikasi agar berfungsi dengan baik dalam kurva distribusi. Metrik juga dapat membantu Anda mengaitkan perubahan distribusi dengan waktu saat aplikasi tidak berfungsi sebagaimana mestinya, untuk membantu Anda menemukan akar 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.

Selain itu, Anda mungkin melihat bahwa beberapa jenis permintaan memerlukan waktu lebih lama daripada 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 kemungkinan akan secara substansial lebih buruk daripada sebagian besar pengguna, tetapi masih merupakan perilaku normal Anda.

Semua ini berarti bahwa tidak terlalu berguna untuk memberi tahu saat pertama kali RPC atau panggilan HTTP 5xx berdurasi satu detik terdeteksi. Sebagai gantinya, saat menyelidiki layanan Google sebagai kemungkinan penyebab masalah yang dialami aplikasi Anda, bandingkan kode yang ditampilkan dan rasio latensi dari waktu ke waktu, lalu cari perubahan berkelanjutan dari norma yang berkorelasi dengan masalah yang diamati di aplikasi Anda.

Rasio traffic

Metrik API paling berguna jika Anda memiliki volume traffic yang tinggi ke API. Jika Anda memanggil layanan hanya secara berkala, metrik API Anda tidak akan valid secara statistik dan tidak akan memberi Anda informasi pemilahan yang bermakna.

Misalnya, jika Anda ingin melacak latensi persentil ke-99,5 untuk 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, yang tidak akan memberi tahu Anda banyak tentang perilaku normal API atau aplikasi Anda. Pastikan rasio traffic, persentil yang Anda lacak, dan jangka waktu yang Anda pertimbangkan menghasilkan banyak titik data yang menarik atau data pemantauan tidak akan membantu Anda.

API yang didukung

Semua Google API dan Google Cloud API, serta API yang dibuat di atas Cloud Endpoints dan API Gateway, mendukung metrik API. Jika Anda adalah konsumen API, Anda dapat melihat metrik Consumed API di Dasbor API. Jika Anda adalah produsen API, Anda dapat melihat metrik API yang Diproduksi di Dasbor Endpoint.