Memantau API Anda

OpenAPI   |  gRPC

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, Endpoint akan mencatat informasi tentang permintaan dan respons ke dalam log. Endpoint 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 Panduan memulai Endpoints.

Ringkasan API

Saat men-debug masalah pada layanan atau hanya ingin memastikan bahwa semuanya berjalan dengan baik, buka ringkasan API Anda:

1. Di konsol Google Cloud, buka halaman Endpoints > Services untuk project Anda:

   Buka halaman Endpoints Services

2. Jika Anda memiliki lebih dari satu API, klik API yang ingin Anda pantau.

3. 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 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 untuk 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 menu 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 kursor untuk melihat deskripsi.

• Di sudut kanan atas ringkasan, pilih rentang waktu untuk nilai metrik dalam tabel menggunakan pemilih rentang waktu. Tindakan ini akan memilih rentang waktu untuk grafik dan tabel.

Log

Jika Anda menemukan masalah dalam metrik, buka halaman Logs Explorer di konsol Google Cloud untuk melihat log permintaan dan respons untuk API Anda.

• Untuk melihat log untuk setiap 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:

  1. Di konsol Google Cloud, buka halaman Stackdriver > Logging:

     Buka halaman Logs Explorer

  2. Pilih Produced API, SERVICE_NAME, dengan SERVICE_NAME adalah nama layanan Endpoints.

Lihat Referensi log Endpoint untuk mengetahui detail tentang 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 besar dari 300 milidetik.

• Konfigurasikan dan kelola sink untuk me-rutekan log ke tujuan yang didukung Tindakan ini memungkinkan Anda melakukan streaming log ke BigQuery untuk analisis lebih lanjut, menyimpan log mentah ke Cloud Storage, atau mengirimkannya ke topik pesan Pub/Sub.

Memfilter untuk project konsumen tertentu

Alfa

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

Untuk melihat metrik untuk project konsumen tertentu, konsumen API Anda harus mengirim kunci API saat membuat permintaan. Karena Endpoints menggunakan kunci API untuk mengidentifikasi project yang terkait dengan aplikasi panggilan, kunci API harus telah dibuat di project Google Cloud konsumen API. Untuk mempelajari cara membatasi akses ke API Anda menggunakan kunci API, lihat Membatasi akses API dengan kunci API.

Untuk memfilter metrik untuk project konsumen tertentu:

1. 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 untuk Anda.

2. Di konsol Google Cloud, buka halaman Endpoints > Services untuk project Anda.

   Buka halaman Endpoints Services

3. Di pojok kiri atas halaman Ringkasan, masukkan nomor project di kolom Filter menurut Nomor Project.

4. Klik Filter.

Metrik di halaman akan diperbarui untuk mencerminkan traffic hanya dari project yang ditentukan.

Pemberitahuan

Beta

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dalam Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

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 emas yang menunjukkan bahwa Anda tidak dapat menyiapkan pemberitahuan untuk menggunakan metrik Endpoints adalah kejenuhan. Metrik yang perlu Anda pantau untuk mengetahui kejenuhan bergantung pada aplikasi Anda. Lihat daftar metrik yang tersedia di Cloud Monitoring untuk mengetahui metrik yang dapat Anda gunakan untuk menyiapkan pemberitahuan saat terjadi saturasi.

Untuk menyiapkan pemberitahuan:

1. Di konsol Google Cloud, pilih project Google Cloud dengan API yang dipantau Endpoints yang dikaitkan dengan akun.

   Buka konsol Google Cloud

2. Dengan menggunakan panel navigasi, pilih Monitoring.

3. Buat kebijakan pemberitahuan untuk menyiapkan pemberitahuan bagi sinyal emas menggunakan hal berikut:

   • Latensi

     1. Untuk Jenis Kondisi, masukkan Metric Threshold.
     2. Untuk Resource Type, masukkan Produced API.
     3. Untuk metrik, masukkan Request latencies.
     4. Masukkan nilai minimum yang ingin Anda kirimkan pemberitahuannya, lalu ikuti petunjuk lainnya dalam Panduan pemberitahuan.

   • Traffic

     1. Untuk Jenis Kondisi, masukkan Metric Threshold.
     2. Untuk Resource Type, masukkan Produced API.
     3. Untuk metrik, masukkan Request count.
     4. Masukkan nilai minimum yang ingin Anda kirimkan pemberitahuannya, lalu ikuti petunjuk lainnya dalam Panduan pemberitahuan.

   • Error

     1. Untuk Jenis Kondisi, masukkan Metric Threshold.
     2. Untuk Resource Type, masukkan Produced API.
     3. Untuk metrik, masukkan Request count.
     4. Untuk response-code-class, masukkan 5xx.
     5. Masukkan nilai minimum yang ingin Anda kirimkan pemberitahuannya, lalu ikuti petunjuk lainnya dalam Panduan pemberitahuan.

Catatan: Jika API Anda belum mencatat respons 5xx ke dalam log, formulir kebijakan pemberitahuan tidak akan menawarkannya sebagai class kode respons.

Catatan: Jika batasan kritis untuk layanan Anda adalah IO jaringan, Anda mungkin dapat menggunakan salah satu metrik Endpoint untuk menyiapkan pemberitahuan. Semua log Endpoint berada di bagian Jenis Resource dari Produced API.

Langkah selanjutnya

• Log endpoint
• Metrik endpoint