Memantau API Anda

Halaman ini menjelaskan cara memantau kondisi API Gateway API menggunakan log dan metrik yang dikelola API Gateway untuk Anda secara otomatis.

Saat Anda membuat API, API Gateway akan otomatis membuat layanan terkelola yang sesuai. Nama layanan terkelola yang dibuat dapat ditemukan di output perintah berikut:

gcloud api-gateway apis describe API_ID

Nama layanan Anda adalah nilai kolom managedService.

Saat pengguna membuat permintaan ke API Anda, API Gateway mencatat informasi tentang permintaan dan respons. API Gateway juga melacak tiga dari empat sinyal emas pemantauan: latensi, traffic, dan error. Metrik penggunaan dan performa ini membantu Anda memantau API.

Sebelum memulai

Untuk membuat log dan metrik yang dapat dilihat, deploy API dan kirim permintaan ke API tersebut. Jika Anda belum membuat dan men-deploy API ke gateway, coba mulai cepat Gateway API.

Ringkasan API

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

  1. Di konsol Google Cloud , buka halaman API Gateway > APIs untuk project Anda:

    Buka API

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

  3. Pastikan Anda berada di tab Ringkasan.

Grafik

Halaman ringkasan menyediakan sejumlah grafik untuk beberapa metrik, sehingga Anda dapat langsung melihat lonjakan, penurunan, atau aktivitas yang tidak terduga. Dengan menggunakan filter di bagian atas halaman, Anda dapat:

  • Gunakan daftar drop-down Pilih grafik untuk menampilkan grafik metrik yang Anda minati, dan menghapus grafik yang tidak ingin Anda lihat.
  • Sesuaikan cakupan grafik dengan memilih dari berbagai rentang waktu. Tindakan ini akan menyesuaikan rentang waktu nilai yang ditampilkan, 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 sudut kiri atas tabel, klik ikon Filter Tabel untuk memilih opsi kueri filter yang disempurnakan dari tabel drop-down. Tambahkan OR di antara setiap kueri filter untuk menelusuri beberapa istilah.
  • Di sudut kanan atas tabel, klik ikon Opsi Tampilan Kolom untuk menampilkan daftar drop-down. Centang metrik yang Anda minati dan hapus centang pada metrik yang tidak ingin ditampilkan.
  • Di sudut kanan atas halaman Ringkasan, pilih rentang waktu untuk nilai metrik dalam tabel menggunakan pemilih rentang waktu. Opsi ini memilih rentang waktu untuk grafik dan tabel.

Log

Saat menemukan masalah dalam metrik, Anda dapat menggunakan 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 API Gateway langsung dari halaman Logs Explorer:

    1. Di konsol Google Cloud , buka halaman Logs Explorer:

      Buka Logs Explorer

    2. Klik Semua resource.

    3. Pilih API Gateway, LOCATION, dan GATEWAY_ID. Dengan LOCATION adalah region tempat instance API Gateway Anda di-deploy, dan GATEWAY_ID adalah nama instance API Gateway Anda.

    4. Klik Terapkan.

Lihat referensi log API Gateway untuk mengetahui detail struktur log di Logs Explorer.

Pelajari hal lain yang dapat Anda lakukan dengan log:

  • Mulai menggunakan Logs Explorer.

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

  • Mengonfigurasi dan mengelola sink. Dengan begitu, Anda dapat mengalirkan 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 memfilter metrik 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 tersebut.

  2. Di konsol Google Cloud , buka halaman API Gateway > APIs untuk project Anda.

    Buka API

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

  4. Klik Filter.

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

Langkah berikutnya