Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Como monitorar sua API
Nesta página, você aprende a monitorar a integridade das APIs do gateway de API usando os registros e as métricas que o gateway de API mantém automaticamente.
Quando você cria uma API, o gateway de API cria automaticamente um serviço gerenciado correspondente O nome do serviço gerenciado criado pode ser encontrado na saída do seguinte comando:
gcloud api-gateway apis describe API_ID
O nome do seu serviço é o valor do campo managedService.
Quando os usuários fazem solicitações para sua API, o gateway de API registra informações sobre solicitações e respostas. A API Gateway também rastreia três dos quatro sinais de ouro do monitoramento: latência, tráfego e erros. Essas métricas de uso e desempenho ajudam a monitorar a API.
Antes de começar
Para gerar registros e métricas para visualização, implante uma API e envie solicitações. Se você ainda não criou e implantou uma API em um gateway, veja o Guia de início rápido do gateway de API.
Visão geral da API
Quando estiver depurando um problema com o serviço ou apenas quiser garantir que tudo está funcionando bem, acesse a visão geral da API:
No Google Cloud console, acesse a página Gateway de API > APIs do seu projeto:
Se tiver mais de uma API, clique na que você quer monitorar.
Verifique se você está na guia Visão geral.
Gráficos
A página de visão geral fornece vários gráficos com algumas métricas. Assim, é possível identificar picos, quedas ou atividades inesperadas imediatamente. Use os filtros na parte superior da página para fazer o seguinte:
Use a lista suspensa Selecionar gráficos para exibir gráficos das métricas do seu interesse e remover aqueles que você não quer ver.
Ajuste o escopo dos gráficos selecionando os vários períodos. Isso ajusta o intervalo de tempo dos valores exibidos, o que também altera a granularidade dos pontos.
Tabela de métodos
Quando estiver pronto para avançar, role para baixo os gráficos para ver uma tabela com métricas para métodos individuais na API. Você pode:
No canto superior esquerdo da tabela, clique no ícone Filtrar tabela para selecionar opções de consulta de filtro refinadas na tabela suspensa. 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 exibição da coluna para abrir uma lista suspensa. Marque as métricas do seu interesse e limpe as que você não quer que sejam exibidas.
No canto superior direito da visão geral, use o seletor de períodos para escolher um intervalo de tempo para os valores de métricas na tabela. Isso seleciona um período tanto para os gráficos como para a tabela.
Registros
Ao identificar um problema nas métricas, use a página Explorador de registros no
consoleGoogle Cloud para conferir os registros de solicitações e respostas da API.
Para ver registros de métodos individuais da API, clique em Ver registros na tabela.
Para ver os registros de todos os métodos na API, clique em Ver todos os registros no canto inferior direito.
Para localizar os registros do Gateway de API diretamente na página Explorador de registros:
No Google Cloud console, acesse a página Análise de registros.
Use o painel de consulta para especificar o conjunto de entradas de registro que você quer visualizar,
como receber todas as solicitações com uma latência superior a 300 milissegundos.
Configurar e gerenciar coletores.
Isso permite que você faça o stream de registros para o BigQuery para ter análises adicionais, salve os registros brutos no Cloud Storage ou os envie para os tópicos de mensagens do Cloud Pub/Sub.
Filtrar por um projeto de consumidor específico
Para filtrar métricas em um projeto de consumidor específico:
Consiga o
número do projeto
do consumidor da API. Se não tiver permissão para acessar o projeto do consumidor da API, peça a alguém que tenha permissão para conseguir o número do projeto para você.
No Google Cloud console, acesse a página Gateway de API > 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-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)"]]
