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.
- Pantau performa aplikasi dan Google API Anda.
- Temukan masalah antara aplikasi Anda dan Google API.
Hal ini dapat mempercepat waktu penyelesaian masalah secara signifikan saat Anda memecahkan masalah atau memerlukan dukungan teknis dari Google.
Metrik yang dihasilkan Google API adalah sinyal standar yang digunakan oleh Engineer Keandalan Situs (SRE) Google sendiri untuk menilai keandalan layanan. Metrik ini mencakup jumlah permintaan, tingkat error, total latensi, 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 dengan menggunakan Dasbor API di 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 konsol Cloud. 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 API tertentu:
- 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.
Untuk informasi penggunaan yang lebih mendetail, pilih Lihat metrik. Secara default, diagram bawaan berikut ditampilkan, meskipun ada lebih banyak diagram 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 bawaan tambahan dari menu drop-down Pilih Grafik.
Menggunakan Cloud Monitoring
Jika menggunakan Cloud Monitoring, Anda dapat mempelajari data metrik yang tersedia lebih dalam menggunakan Metrics Explorer untuk mendapatkan insight yang lebih baik 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 pada class Kode Respons HTTP untuk membuat dasbor yang menunjukkan tingkat error dari waktu ke waktu, atau Anda dapat melihat latensi persentil ke-95 permintaan ke Cloud Pub/Sub API.
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 tangguh. Anda dapat mengetahui cara melakukannya di halaman berikut:
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 ID kredensial lainnya, kemungkinan ada masalah pada 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 dari layanan GCP yang penting. Sebaiknya hubungi kami dan tunjukkan data ini agar kami dapat mulai mengatasi masalahnya secepat mungkin.
- Latensi untuk laporan layanan GCP terlihat baik dan tidak berubah dari sebelumnya, tetapi laporan metrik dalam aplikasi Anda melaporkan bahwa latensi pada panggilan ke layanan sangat tinggi. Hal ini menunjukkan bahwa ada masalah di jaringan. Hubungi penyedia jaringan Anda (dalam beberapa kasus, Google) untuk memulai proses pen-debug-an.
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 kebiasaan
Sebelum Anda memutuskan untuk memberikan pemberitahuan tentang nilai metrik tertentu, pertimbangkan apa yang sebenarnya dianggap sebagai perilaku tidak biasa. Melihat metrik API dapat menunjukkan bahwa hasil latensi untuk sebagian besar layanan berada dalam distribusi normal: tonjolan 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 mengorelasikan 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. Namun, kami tidak memperkirakan adanya 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, rata-rata waktu yang Anda butuhkan untuk mengupload 20 foto kemungkinan akan jauh lebih lama daripada kebanyakan pengguna, tetapi masih merupakan perilaku normal Anda.
Semua ini berarti bahwa tidak terlalu berguna untuk memberikan pemberitahuan saat panggilan RPC selama satu detik atau panggilan HTTP 5xx terdeteksi untuk pertama kalinya. Sebagai gantinya, saat menyelidiki layanan Google sebagai kemungkinan penyebab masalah yang dialami aplikasi Anda, bandingkan kode yang ditampilkan dan tingkat latensi dari waktu ke waktu dan cari perubahan berkelanjutan dari norma yang berkorelasi dengan masalah yang diamati di aplikasi Anda.
Tarif traffic
Metrik API paling berguna jika Anda memiliki volume traffic yang tinggi yang masuk ke API. Jika Anda memanggil layanan hanya sesekali, metrik API Anda tidak akan valid secara statistik dan tidak akan memberikan informasi triase yang bermakna.
Misalnya, jika Anda ingin melacak latensi persentil ke-99,5 untuk suatu layanan, dan Anda hanya melakukan 100 panggilan per jam, memantau pengukuran selama dua jam hanya akan memberi Anda satu titik data untuk merepresentasikan persentil ke-99,5, yang tidak akan memberi tahu Anda banyak hal 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 relevan atau data pemantauan tidak akan bermanfaat bagi Anda.
API yang didukung
Semua Google API dan Google Cloud API, serta API yang dibangun 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 Endpoints.