Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Monitorizar a sua API
Esta página descreve como pode monitorizar o estado de funcionamento das suas APIs do API Gateway através dos registos e das métricas que o API Gateway mantém automaticamente para si.
Quando cria uma API, o API Gateway cria automaticamente um serviço gerido correspondente. Pode encontrar o nome do serviço gerido criado no resultado do seguinte comando:
gcloud api-gateway apis describe API_ID
O nome do seu serviço é o valor do campo managedService.
Quando os utilizadores fazem pedidos à sua API, o API Gateway regista informações sobre os pedidos e as respostas. O API Gateway também monitoriza três dos
quatro sinais fundamentais de monitorização:
latência, tráfego e erros. Estas métricas de utilização e desempenho ajudam a monitorizar a sua API.
Antes de começar
Para gerar registos e métricas para visualização, implemente uma API e envie-lhe pedidos. Se ainda não criou nem implementou uma API num gateway, experimente o
início rápido do API Gateway.
Vista geral da API
Quando estiver a depurar um problema com o seu serviço ou quiser garantir que tudo está a funcionar conforme esperado, aceda à vista geral da API:
Na Google Cloud consola, aceda à página API Gateway > APIs do seu projeto:
Se tiver mais do que uma API, clique na que quer monitorizar.
Certifique-se de que está no separador Vista geral.
Gráficos
A página Vista geral apresenta vários gráficos para algumas das métricas, para que possa detetar imediatamente picos, quedas ou atividade inesperada. Através dos filtros na parte superior da página, pode:
Use a lista pendente Selecionar gráficos para mostrar gráficos das métricas do seu interesse e remover as que não quer ver.
Ajuste o âmbito dos gráficos selecionando um dos vários intervalos de tempo. Isto ajusta o intervalo de tempo dos valores apresentados, o que também altera a granularidade dos pontos.
Tabela de métodos
Quando tiver tudo a postos para analisar mais detalhadamente, desloque a página abaixo dos gráficos para ver uma tabela
com métricas para métodos individuais na sua API. Pode:
No canto superior esquerdo da tabela, clique no ícone Filtrar tabela para selecionar opções de consulta de filtro refinadas na tabela pendente. Adicione um OR entre cada consulta de filtro para pesquisar vários termos.
No canto superior direito da tabela, clique no ícone Opções de visualização de colunas para apresentar uma lista pendente. Selecione as métricas que lhe interessam e desmarque as que não quer que sejam apresentadas.
No canto superior direito da página Vista geral, selecione um intervalo de tempo para os valores das métricas na tabela através do seletor de intervalo de tempo. Isto escolhe um intervalo de tempo para os gráficos e a tabela.
Registos
Quando deteta um problema nas métricas, pode usar a página Explorador de registos na
Google Cloud consola para ver os registos dos pedidos e das respostas da sua API.
Para ver os registos de métodos individuais da sua API, clique em Ver registos na tabela.
Para ver os registos de todos os métodos na sua API, clique em Ver todos os registos no canto inferior direito.
Para localizar registos do API Gateway diretamente na página Explorador de registos:
Na Google Cloud consola, aceda à página Explorador de registos:
Use o painel de consultas para especificar o conjunto de entradas de registo que quer ver, como obter todos os pedidos com uma latência superior a 300 milissegundos.
Configure e faça a gestão de lavatórios.
Isto permite-lhe transmitir registos para o BigQuery para análise adicional, guardar os registos não processados no Cloud Storage ou enviá-los para tópicos de mensagens do Pub/Sub.
Filtre por um projeto do consumidor específico
Para filtrar métricas de um projeto de consumidor específico:
Obtenha o
número do projeto
do projeto do consumidor da API. Se não tiver autorização para aceder ao projeto do consumidor da API, peça a alguém que tenha autorização para obter o número do projeto por si.
Na Google Cloud consola, aceda à página API Gateway > APIs
do seu projeto.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Informações incorretas ou exemplo de código","incorrectInformationOrSampleCode","thumb-down"],["Não contém as informações/amostras de que eu preciso","missingTheInformationSamplesINeed","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2025-08-19 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)"]]
