Halaman ini menjelaskan cara memantau kondisi API yang Anda miliki menggunakan log dan metrik yang dikelola Cloud Endpoints secara otomatis untuk Anda. Saat pengguna membuat permintaan ke API Anda, Endpoints mencatat informasi tentang permintaan dan respons. Endpoints juga melacak tiga dari empat sinyal emas pemantauan: latensi, traffic, dan error. Metrik penggunaan dan performa ini membantu Anda memantau API.
Sebelum memulai
Anda harus men-deploy API dan mengirim permintaan ke API tersebut untuk membuat log dan metrik yang dapat dilihat. Jika Anda belum menyiapkan apa pun, coba Mulai cepat Endpoint.
Ringkasan API
Saat Anda men-debug masalah pada layanan atau hanya ingin memastikan semuanya berjalan dengan baik, buka ringkasan API Anda:
Di konsol Google Cloud , buka halaman Endpoints > Services untuk project Anda:
Jika Anda memiliki lebih dari satu API, klik API yang ingin Anda pantau.
Pastikan Anda berada di tab Ringkasan.
Grafik
Di bagian atas terdapat grafik untuk beberapa metrik, sehingga Anda dapat langsung melihat lonjakan dan penurunan. Anda dapat:
Di kanan atas grafik pertama, gunakan daftar drop-down Pilih grafik untuk menampilkan grafik metrik yang Anda minati, dan hapus grafik yang tidak ingin Anda lihat. Setiap entri dalam daftar drop-down memiliki tanda tanya yang dapat Anda arahkan kursor ke atasnya untuk melihat deskripsi metrik yang ditampilkan.
Di pojok kanan atas ringkasan, sesuaikan grafik dengan memilih dari berbagai rentang waktu. Tindakan ini akan menyesuaikan rentang waktu nilai yang ditampilkan dalam grafik ini, yang juga mengubah perincian titik.
Tabel metode
Jika Anda siap melihat perincian lebih lanjut, scroll di bawah grafik untuk melihat tabel dengan metrik untuk setiap metode di API Anda. Anda dapat:
Di kanan atas tabel, gunakan daftar drop-down Pilih kolom untuk menampilkan metrik yang Anda minati dan menghapus metrik yang tidak ingin ditampilkan. Entri di sini juga memiliki tanda tanya yang dapat Anda arahkan kursornya untuk melihat deskripsi.
Di sudut kanan atas ringkasan, pilih rentang waktu untuk nilai metrik dalam tabel menggunakan pemilih rentang waktu. Tindakan ini memilih rentang waktu untuk grafik dan tabel.
Log
Saat Anda menemukan masalah dalam metrik, buka halaman Logs Explorer di konsolGoogle Cloud untuk melihat log permintaan dan respons untuk API Anda.
Untuk melihat log masing-masing metode API Anda, klik Lihat log di tabel.
Untuk melihat log semua metode di API Anda, klik Lihat semua log di pojok kanan bawah.
Untuk menemukan log Endpoints langsung dari halaman Logs Explorer:
Di konsol Google Cloud , buka halaman Stackdriver > Logging:
Pilih Produced API,
SERVICE_NAME, denganSERVICE_NAMEadalah nama layanan Endpoints.
Lihat Referensi log Endpoint untuk mengetahui detail struktur log di Logs Explorer.
Pelajari hal lain yang dapat Anda lakukan dengan log:
Mulai menggunakan Logs Explorer.
Buat kueri untuk menentukan kumpulan entri log yang ingin Anda lihat, seperti mendapatkan semua permintaan dengan latensi lebih dari 300 milidetik.
Konfigurasi dan kelola sink untuk merutekan log ke tujuan yang didukung Dengan begitu, Anda dapat melakukan streaming log ke BigQuery untuk analisis lebih lanjut, menyimpan log mentah ke Cloud Storage, atau mengirimkannya ke topik pesan Pub/Sub.
Memfilter project konsumen tertentu
Untuk melihat metrik project konsumen tertentu, konsumen API Anda harus mengirimkan kunci API saat membuat permintaan. Karena Endpoints menggunakan kunci API untuk mengidentifikasi project yang terkait dengan aplikasi yang memanggil, kunci API harus dibuat di projectGoogle Cloud konsumen API. Untuk mempelajari cara membatasi akses ke API Anda menggunakan kunci API, lihat berikut ini:
Untuk memfilter metrik project konsumen tertentu:
Dapatkan nomor project project konsumen API. Jika Anda tidak memiliki izin untuk mengakses project konsumen API, minta seseorang yang memiliki izin untuk mendapatkan nomor project tersebut.
Di Google Cloud console, buka halaman Endpoints > Services untuk project Anda.
Di pojok kiri atas halaman Ringkasan, masukkan nomor project di kolom Filter menurut Nomor Project.
Klik Filter.
Metrik di halaman diperbarui untuk mencerminkan traffic hanya dari project yang ditentukan.
Pemberitahuan
Metrik yang dikumpulkan oleh Endpoints juga tersedia di Cloud Monitoring. Anda dapat menggunakan Monitoring untuk menyiapkan pemberitahuan tentang latensi, traffic, dan error. Satu-satunya sinyal keemasan yang tidak dapat Anda siapkan pemberitahuannya menggunakan metrik Endpoint adalah saturasi. Metrik yang perlu Anda pantau untuk mengetahui saturasi bergantung pada aplikasi Anda. Lihat daftar metrik yang tersedia di Cloud Monitoring untuk metrik yang dapat Anda gunakan untuk menyiapkan pemberitahuan tentang saturasi.
Untuk menyiapkan pemberitahuan:
Di konsol Google Cloud , pilih project Google Cloud dengan API yang dipantau Endpoints yang terkait dengan akun.
Dengan menggunakan panel navigasi, pilih Monitoring.
Buat kebijakan pemberitahuan untuk menyiapkan pemberitahuan untuk sinyal keemasan menggunakan hal berikut:
Latensi
- Untuk Condition Type, masukkan
Metric Threshold. - Untuk Resource Type, masukkan
Produced API. - Untuk metrik, masukkan
Request latencies. - Masukkan nilai minimum yang ingin Anda pantau dan ikuti petunjuk selanjutnya di Panduan pemberitahuan.
- Untuk Condition Type, masukkan
Traffic
- Untuk Condition Type, masukkan
Metric Threshold. - Untuk Resource Type, masukkan
Produced API. - Untuk metrik, masukkan
Request count. - Masukkan nilai minimum yang ingin Anda pantau dan ikuti petunjuk selanjutnya di Panduan pemberitahuan.
- Untuk Condition Type, masukkan
Error
- Untuk Condition Type, masukkan
Metric Threshold. - Untuk Resource Type, masukkan
Produced API. - Untuk metrik, masukkan
Request count. - Untuk response-code-class, masukkan
5xx. - Masukkan nilai minimum yang ingin Anda pantau dan ikuti petunjuk selanjutnya di Panduan pemberitahuan.
- Untuk Condition Type, masukkan