Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Memantau API Anda
Halaman ini menjelaskan cara memantau status API API Gateway menggunakan log dan metrik yang dikelola API Gateway secara otomatis untuk Anda.
Saat Anda membuat API, API Gateway akan otomatis membuat layanan terkelola yang sesuai. Nama layanan terkelola yang dibuat dapat ditemukan dalam 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 akan 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
panduan memulai API Gateway.
Ringkasan API
Saat men-debug masalah pada layanan atau hanya ingin memastikan bahwa
semuanya berjalan seperti yang diharapkan, buka ringkasan API Anda:
Di Google Cloud console, buka halaman API Gateway > APIs untuk
project Anda:
Jika Anda memiliki lebih dari satu API, klik API yang ingin Anda pantau.
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 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. Tindakan ini akan 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 melihat tabel
dengan metrik untuk setiap metode di API Anda. Anda dapat:
Di sudut kiri atas tabel, klik ikon Filter Table untuk memilih opsi kueri filter yang dipertajam 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 metrik yang tidak ingin ditampilkan.
Di sudut kanan atas halaman 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 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 untuk setiap metode API Anda, klik
Lihat log di tabel.
Untuk melihat log semua metode di API Anda, di pojok kanan bawah, klik
Lihat semua log.
Untuk menemukan log API Gateway langsung dari halaman Logs Explorer:
Di konsol Google Cloud , buka halaman Logs Explorer:
Gunakan panel kueri untuk menentukan kumpulan entri log yang ingin Anda lihat,
seperti mendapatkan semua permintaan dengan latensi lebih besar dari 300 milidetik.
Mengonfigurasi dan mengelola sink.
Dengan begitu, Anda dapat melakukan streaming log ke BigQuery untuk analisis lebih lanjut, menyimpan log mentah ke Cloud Storage, atau mengirimnya ke topik pesan Pub/Sub.
Memfilter untuk project konsumen tertentu
Untuk memfilter metrik untuk 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 untuk Anda.
Di Google Cloud console, buka halaman API Gateway > APIs
untuk project Anda.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-09-03 UTC."],[[["\u003cp\u003eAPI Gateway automatically maintains logs and metrics for monitoring API health, including latency, traffic, and errors, and creates a managed service for each created API.\u003c/p\u003e\n"],["\u003cp\u003eThe API overview page displays graphs for various metrics, which can be customized and filtered by time span and specific metrics.\u003c/p\u003e\n"],["\u003cp\u003eThe methods table allows for in-depth examination of individual API methods, with options to filter queries, adjust displayed metrics, and select a time span.\u003c/p\u003e\n"],["\u003cp\u003eThe Logs Explorer can be used to view detailed logs of requests and responses for your API, either for specific methods or for all methods.\u003c/p\u003e\n"],["\u003cp\u003eMetrics can be filtered to show data from a specific consumer project by entering the project number in the "Filter by Project Number" field.\u003c/p\u003e\n"]]],[],null,["# Monitoring your API\n===================\n\nThis page describes how you can monitor the health of your API Gateway APIs using the logs and metrics that API Gateway maintains for you automatically.\n\nWhen you create an API, API Gateway automatically creates a corresponding [managed service](/service-infrastructure/docs/overview#creating_apis_and_services). The name of the managed service created can be found in the output of the following command: \n\n```\ngcloud api-gateway apis describe API_ID\n```\n\nThe name of your service is the value of the `managedService` field.\n\nWhen users make requests to your API, API Gateway logs information about\nthe requests and responses. API Gateway also tracks three of the\n[four golden signals of monitoring](https://landing.google.com/sre/book/chapters/monitoring-distributed-systems.html#xref_monitoring_golden-signals):\nlatency, traffic, and errors. These usage and performance metrics help you monitor\nyour API.\n\nBefore you begin\n----------------\n\nTo generate logs and metrics for viewing, deploy an API and send requests to it. If you have not created and deployed an API to a gateway yet, try the\n[API Gateway quickstart](/api-gateway/docs/quickstart).\n\nAPI overview\n------------\n\nWhen you are debugging an issue with your service or just want to ensure that\neverything is running as expected, go to your API's overview:\n\n1. In the Google Cloud console, go to the **API Gateway** \\\u003e **APIs** page for\n your project:\n\n [Go to APIs](https://console.cloud.google.com/api-gateway/api)\n2. If you have more than one API, click the one you want to monitor.\n\n3. Ensure you are on the **Overview** tab.\n\n### Graphs\n\nThe overview page provides a number of graphs for some of the metrics, so you can spot any spikes, drops, or unexpected activity right away. Using the filters at the top of the page, you can:\n\n- Use the **Select graphs** drop-down list to show graphs for metrics you are interested in, and remove the ones you don't want to view.\n- Adjust the scope of the graphs by selecting from the various time spans. This adjusts the time range of values displayed, which also alters the point granularity.\n\n### Methods table\n\nWhen you are ready to drill down further, scroll below the graphs for a table\nwith metrics for individual methods in your API. You can:\n\n- In the top-left corner of the table, click the **Filter Table** icon to select refined filter query options from the drop-down table. Add an `OR` between each filter query to search for multiple terms.\n- In the top-right corner of the table, click the **Column Display Options** icon to display a drop-down list. Check the metrics you are interested in and clear the ones you don't want displayed.\n- In the top-right corner of the **Overview** page, select a time span for the metric values in the table by using the time span picker. This picks a time span for both the graphs and the table.\n\n### Logs\n\nWhen you spot an issue in the metrics, you can use the **Logs Explorer** page in the\nGoogle Cloud console to see logs of the requests and responses for your API.\n\n- To see logs for individual methods of your API, in the table click\n **View logs**.\n\n- To see logs for all methods in your API, in the bottom-right corner click\n [**View all logs**](https://console.cloud.google.com/logs/query).\n\n- To locate API Gateway logs directly from the Logs Explorer page:\n\n 1. In the Google Cloud console, go to the **Logs Explorer**\n page:\n\n [Go toLogs Explorer](https://console.cloud.google.com/logs/query)\n 2. Select **Produced API, \u003cvar translate=\"no\"\u003eSERVICE_NAME\u003c/var\u003e** , where\n \u003cvar translate=\"no\"\u003eSERVICE_NAME\u003c/var\u003e is the name of the\n managed service.\n\nSee the\n[API Gateway logs reference](/api-gateway/docs/audit-logging)\nfor details on the structure of the logs in the Logs Explorer.\n\nLearn what else you can do with the logs:\n\n- Get started using the\n [Logs Explorer](/logging/docs/view/logs-explorer-interface).\n\n Use the query pane to specify the set of log entries that you want to view,\n such as getting all requests with a latency greater than 300 milliseconds.\n- [Configure and manage sinks](/logging/docs/export/configure_export_v2).\n This lets you stream logs to BigQuery for further analysis, save the\n raw logs to Cloud Storage, or send them to Pub/Sub messaging\n topics.\n\n### Filter for a specific consumer project\n\nTo filter metrics for a specific consumer project:\n\n1. Get the\n [project number](/resource-manager/docs/creating-managing-projects#identifying_projects)\n of the API consumer's project. If you don't have permission to access the\n API consumer's project, ask someone who has permission to get the project\n number for you.\n\n2. In the Google Cloud console, go to the **API Gateway** \\\u003e **APIs** page\n for your project.\n\n [Go to APIs](https://console.cloud.google.com/api-gateway/api)\n3. In the top-left corner of the **Overview** page, enter the project number in\n the **Filter by Project Number** field.\n\n4. Click **Filter**.\n\nThe metrics on the page update to reflect traffic only from the specified\nproject.\n\nWhat's next\n-----------\n\n- [Tracing your API](/api-gateway/docs/tracing)"]]
