Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
Monitoraggio dell'API
Questa pagina descrive come monitorare lo stato delle API API Gateway utilizzando i log e le metriche gestiti automaticamente da API Gateway.
Quando crei un'API, API Gateway crea automaticamente un servizio gestito corrispondente. Il nome del servizio gestito creato è disponibile nell'output del seguente comando:
gcloud api-gateway apis describe API_ID
Il nome del servizio è il valore del campo managedService.
Quando gli utenti inviano richieste alla tua API, API Gateway registra informazioni sulle richieste e sulle risposte. API Gateway tiene traccia anche di tre dei
quattro indicatori principali del monitoraggio:
latenza, traffico ed errori. Queste metriche di utilizzo e prestazioni ti aiutano a monitorare la tua API.
Prima di iniziare
Per generare log e metriche da visualizzare, esegui il deployment di un'API e invia richieste. Se non hai ancora creato ed eseguito il deployment di un'API in un gateway, prova la guida rapida di API Gateway.
Panoramica dell'API
Quando stai cercando di risolvere un problema con il tuo servizio o vuoi solo assicurarti che tutto funzioni come previsto, vai alla panoramica dell'API:
Nella Google Cloud console, vai alla pagina API Gateway > API per il tuo progetto:
Se hai più di un'API, fai clic su quella che vuoi monitorare.
Assicurati di essere nella scheda Panoramica.
Grafici
La pagina Panoramica fornisce una serie di grafici per alcune metriche, in modo da poter rilevare immediatamente eventuali picchi, cali o attività impreviste. Utilizzando i filtri nella parte superiore della pagina, puoi:
Utilizza l'elenco a discesa Seleziona grafici per visualizzare i grafici relativi alle metriche che ti interessano e rimuovere quelli che non vuoi visualizzare.
Modifica l'ambito dei grafici selezionando uno dei vari intervalli di tempo. In questo modo viene modificato l'intervallo di tempo dei valori visualizzati, il che altera anche la granularità dei punti.
Tabella dei metodi
Quando vuoi visualizzare ulteriori dettagli, scorri sotto i grafici per visualizzare una tabella con le metriche per i singoli metodi dell'API. Puoi:
Nell'angolo in alto a sinistra della tabella, fai clic sull'icona Filtra tabella per selezionare le opzioni di query di filtro perfezionate dalla tabella a discesa. Aggiungi un OR tra ciascuna query di filtro per cercare più termini.
Nell'angolo in alto a destra della tabella, fai clic sull'icona Opzioni di visualizzazione delle colonne per visualizzare un elenco a discesa. Seleziona le metriche che ti interessano e deseleziona quelle che non vuoi visualizzare.
Nell'angolo in alto a destra della pagina Panoramica, seleziona un intervallo di tempo per i valori delle metriche nella tabella utilizzando il selettore dell'intervallo di tempo. Viene selezionato un intervallo di tempo sia per i grafici sia per la tabella.
Log
Quando riscontri un problema nelle metriche, puoi utilizzare la pagina Esplora log nella consoleGoogle Cloud per visualizzare i log delle richieste e delle risposte per la tua API.
Per visualizzare i log dei singoli metodi della tua API, fai clic su
Visualizza log nella tabella.
Per visualizzare i log di tutti i metodi dell'API, nell'angolo in basso a destra fai clic su
Visualizza tutti i log.
Per trovare i log di API Gateway direttamente dalla pagina Esplora log:
Nella Google Cloud console, vai alla pagina Esplora log:
Utilizza il riquadro delle query per specificare l'insieme di voci di log che vuoi visualizzare, ad esempio per ottenere tutte le richieste con una latenza superiore a 300 millisecondi.
Configura e gestisci i sink.
In questo modo puoi eseguire lo streaming dei log in BigQuery per ulteriori analisi, salvare i log non elaborati in Cloud Storage o inviarli agli argomenti di messaggistica Pub/Sub.
Filtrare per un progetto consumer specifico
Per filtrare le metriche per un progetto consumer specifico:
Recupera il
numero del progetto
del progetto del consumatore dell'API. Se non disponi dell'autorizzazione per accedere al progetto del consumatore dell'API, chiedi a qualcuno che dispone dell'autorizzazione di recuperare il numero del progetto per te.
Nella Google Cloud console, vai alla pagina API Gateway > API per il tuo progetto.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Difficile da capire","hardToUnderstand","thumb-down"],["Informazioni o codice di esempio errati","incorrectInformationOrSampleCode","thumb-down"],["Mancano le informazioni o gli esempi di cui ho bisogno","missingTheInformationSamplesINeed","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 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)"]]
