Telemetri diagnostik dan analisis error memungkinkan Anda mengidentifikasi dan mengatasi kegagalan permintaan di seluruh Google API dan Cloud de Confiance by S3NS API. Anda dapat memeriksa metrik penggunaan API, log sisi klien, Cloud Audit Logs, dan respons error terstruktur untuk mendiagnosis penyebab utama dalam aplikasi Anda.
Latar belakang
Google API adalah API jaringan yang disediakan oleh layanan Google. Aplikasi dapat mengakses Google API melalui JSON HTTP dan gRPC dari berbagai lingkungan. Sebaiknya developer menggunakan library klien yang disediakan Google di aplikasi mereka. Library ini menerapkan logika boilerplate umum, seperti autentikasi dan penomoran halaman daftar, yang sangat mengurangi overhead pengembangan dan kesalahan umum.
Untuk mengetahui informasi selengkapnya, lihat Penjelasan Library Klien
Memulai
Jika baru menggunakan Google API, Anda harus mengikuti halaman
Memulai untuk menyelesaikan
langkah-langkah persiapan aplikasi. Anda harus menggunakan perintah curl -v terlebih dahulu untuk mengirim permintaan pengujian ke Google API yang ingin Anda gunakan.
Dengan begitu, Anda dapat bereksperimen dengan Google API tanpa menulis kode apa pun.
Anda sering kali dapat mengatasi banyak masalah sebelum memulai pengembangan aplikasi yang sebenarnya.
Untuk mengetahui informasi selengkapnya, lihat Memulai.
Memecahkan masalah menggunakan metrik
Google API menyediakan metrik API gratis yang mencakup aspek umum penggunaan API, termasuk jumlah permintaan, error, latensi, ukuran permintaan dan respons. Metrik ini memberikan dimensi yang mendetail dalam hal aplikasi dan lokasi. Developer dapat menemukan penggunaan API yang tidak normal, dan mengidentifikasi potensi penyebab utama. Misalnya, error 400 yang lebih tinggi dapat berarti aplikasi yang baru diupdate memiliki beberapa bug logis, atau ukuran permintaan dan respons yang lebih tinggi dapat menyebabkan performa aplikasi lebih lambat.
Untuk mengetahui informasi selengkapnya, lihat Memantau penggunaan API.
Memecahkan masalah menggunakan log
Karena alasan keamanan dan privasi, Google API umumnya tidak menyediakan log API kepada developer aplikasi. Sebaiknya developer aplikasi mencatat log error API di sisi klien. Anda dapat mencatat log error ke penyimpanan lokal atau ke API logging jarak jauh, seperti Cloud Logging API.
Log biasanya berisi lebih banyak informasi tentang error daripada metrik, seperti pesan error dan detail error. Log sangat berguna dan sering kali diperlukan untuk memecahkan masalah error API. Saat developer melihat masalah terkait penggunaan API, mereka dapat membuat kueri log untuk menemukan pesan error dan detail error, lalu menggunakan informasi tersebut untuk mengatasi error atau menghubungi dukungan.
Cloud Audit Logs
Untuk aktivitas yang sensitif terhadap keamanan, produk Google Cloud dapat membuat log audit yang berisi informasi mendetail tentang aktivitas tersebut. Log audit adalah sumber informasi yang bagus untuk memecahkan masalah penggunaan Google Cloud API. Misalnya, Kontrol Layanan VPC fitur uji coba menghasilkan log audit bagi administrator untuk mengevaluasi perubahan kebijakan yang akan datang.
Untuk mengetahui informasi selengkapnya, lihat Cloud Audit Logs.
Mengatasi error
Jika Anda mengalami masalah dengan penggunaan Google API dan telah menemukan metrik serta log yang sesuai, Anda dapat mengikuti halaman Error Panduan Desain API untuk mengatasi error tersebut.
Secara umum, setiap error API memiliki 3 bagian informasi: kode error, pesan error, dan detail error:
- Kode error memungkinkan aplikasi menangani error di tingkat yang lebih tinggi, seperti mencoba lagi setelah error
503atau mengautentikasi ulang pengguna setelah error401. Pesan error memungkinkan developer aplikasi memahami error dan memperbaiki logika aplikasi mereka.
Detail error berisi informasi tambahan yang dapat digunakan aplikasi untuk menangani error secara terprogram.
Untuk mengetahui informasi selengkapnya, lihat halaman Error.