Memantau API Anda

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

Saat Anda membuat API, Gateway API secara 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, Gateway API mencatat informasi tentang permintaan dan respons ke dalam log. Gateway API juga melacak tiga dari empat sinyal emas pemantauan: latensi, traffic, dan error. Metrik penggunaan dan performa ini membantu Anda memantau API.

Sebelum memulai

Guna menghasilkan log dan metrik untuk ditampilkan, deploy API dan kirim permintaan ke API tersebut. Jika Anda belum membuat dan men-deploy API ke gateway, coba panduan memulai API Gateway.

Ringkasan API

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

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

    Buka halaman API

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

  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 tidak terduga. Dengan menggunakan filter di bagian atas halaman, Anda dapat:

  • Gunakan menu drop-down Pilih grafik untuk menampilkan grafik metrik yang Anda minati, dan hapus grafik yang tidak ingin Anda lihat.
  • Sesuaikan cakupan grafik dengan memilih dari berbagai rentang waktu. Ini menyesuaikan rentang waktu nilai yang ditampilkan, 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 pojok kiri atas tabel, klik ikon Filter Table 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 Column Display Options untuk menampilkan menu drop-down. Centang metrik yang Anda inginkan dan hapus centang pada metrik yang tidak ingin ditampilkan.
  • Di pojok kanan atas halaman Overview, 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 menemukan masalah dalam metrik, Anda dapat menggunakan halaman Logs Explorer di Konsol Google Cloud untuk melihat log permintaan dan respons untuk API.

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

  • Guna melihat log untuk semua metode di API Anda, di pojok kanan bawah, klik Lihat semua log.

  • Untuk menemukan log Gateway API langsung dari halaman Logs Explorer:

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

      Buka halaman Logs Explorer

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

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

Pelajari hal lain yang dapat Anda lakukan dengan log:

  • Mulai gunakan 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 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

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 Gateway API > APIs untuk project Anda.

    Buka halaman API

  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.

Langkah selanjutnya