Memantau API Anda

OpenAPI   |  gRPC

Halaman ini menjelaskan cara memantau kondisi API yang Anda miliki menggunakan log dan metrik yang dikelola Cloud Endpoints untuk Anda secara otomatis. 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 agar dapat menghasilkan log dan metrik untuk ditampilkan. Jika Anda belum menyiapkan apa pun, cobalah Panduan memulai endpoint.

Ringkasan API

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

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

   Buka halaman Layanan Endpoint

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

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 menu drop-down Pilih grafik untuk menampilkan grafik metrik yang Anda minati, dan hapus grafik yang tidak ingin Anda lihat. Setiap entri dalam menu drop-down memiliki tanda tanya yang dapat Anda arahkan kursor untuk melihat deskripsi metrik yang ditampilkannya.

• Di sudut kanan atas ringkasan, sesuaikan grafik dengan memilih dari berbagai rentang waktu. Tindakan ini 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 tabel dengan metrik untuk setiap metode di API Anda. Anda dapat:

• Di kanan atas tabel, gunakan menu drop-down Select columns untuk menampilkan metrik yang Anda minati dan menghapus metrik yang tidak ingin ditampilkan. Entri di sini juga memiliki tanda tanya yang dapat digunakan untuk mengarahkan pointer ke deskripsi.

• Di pojok kanan atas ringkasan, pilih rentang waktu untuk nilai metrik dalam tabel menggunakan alat pilih rentang waktu. {i>Tool<i} ini memilih rentang waktu untuk grafik dan tabel.

Log

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

• Guna melihat log untuk setiap metode API, klik Lihat log pada tabel.

• Guna melihat log untuk semua metode di API, klik View all logs di pojok kanan bawah.

• Untuk menemukan log Endpoint langsung dari halaman Logs Explorer:

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

     Buka halaman Logs Explorer

  2. Pilih Production API, SERVICE_NAME, dengan SERVICE_NAME adalah nama layanan Endpoint.

Lihat Referensi log endpoint untuk mengetahui detail tentang struktur log di Logs Explorer.

Pelajari hal lain yang dapat Anda lakukan dengan log:

• Mulai gunakan Logs Explorer.

  Mem-build kueri untuk menentukan kumpulan entri log yang ingin Anda lihat, seperti mendapatkan semua permintaan dengan latensi lebih dari 300 milidetik.

• Mengonfigurasi dan mengelola sink untuk merutekan log Anda ke tujuan yang didukung. Hal ini memungkinkan Anda melakukan streaming log ke BigQuery untuk dianalisis lebih lanjut, menyimpan log mentah ke Cloud Storage, atau mengirimnya ke topik pesan Pub/Sub.

Memfilter 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.

Guna melihat metrik untuk project konsumen tertentu, konsumen API Anda harus mengirim kunci API saat membuat permintaan. Karena Endpoint menggunakan kunci API untuk mengidentifikasi project yang dikaitkan dengan aplikasi panggilan, kunci API harus 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 pada project konsumen tertentu:

1. Dapatkan nomor project dari 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 Endpoint > Services untuk project Anda.

   Buka halaman Layanan Endpoint

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

4. Klik Filter.

Metrik di halaman 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 Endpoint juga tersedia di Cloud Monitoring. Anda dapat menggunakan Monitoring untuk menyiapkan pemberitahuan tentang latensi, traffic, dan error. Satu-satunya sinyal emas yang tidak dapat Anda siapkan notifikasi untuk menggunakan metrik Endpoint adalah saturasi. Metrik yang perlu dipantau saturasinya bergantung pada aplikasi Anda. Baca daftar metrics yang tersedia di Cloud Monitoring untuk metrik yang dapat Anda gunakan guna menyiapkan pemberitahuan tentang saturasi.

Untuk menyiapkan pemberitahuan:

1. Di Konsol Google Cloud, pilih project Google Cloud dengan API pemantauan Endpoint Anda yang terkait dengan akun tersebut.

   Buka konsol Google Cloud

2. Dengan menggunakan panel navigasi, pilih Monitoring.

3. Buat kebijakan pemberitahuan guna menyiapkan pemberitahuan untuk sinyal emas menggunakan cara 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 gunakan untuk mengirim pemberitahuan dan ikuti Panduan notifikasi lainnya.

   • 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 gunakan untuk mengirim pemberitahuan dan ikuti Panduan notifikasi lainnya.

   • Error

     1. Untuk Jenis Kondisi, masukkan Metric Threshold.
     2. Untuk Resource Type, masukkan Produced API.
     3. Untuk metrik, masukkan Request count.
     4. Untuk class kode respons, masukkan 5xx.
     5. Masukkan nilai minimum yang ingin Anda gunakan untuk mengirim pemberitahuan dan ikuti Panduan notifikasi lainnya.

Catatan: Jika API Anda belum mencatat respons 5xx, formulir kebijakan pemberitahuan tidak menawarkan class kode respons.

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

Langkah selanjutnya

• Log endpoint
• Metrik endpoint