Nesta página você aprende a monitorar a integridade das APIs usando os registros e as métricas mantidos automaticamente pelo Cloud Endpoints. Quando os usuários fazem solicitações para a API, o Endpoints registra informações sobre as solicitações e as respostas. Ele também rastreia três dos quatro sinais dourados de monitoramento: latência, tráfego e erros. Essas métricas de uso e desempenho ajudam a monitorar a API.
Antes de começar
Você precisa implantar a API e enviar solicitações para ela a fim de gerar registros e métricas para visualização. Caso ainda não tenha feito qualquer configuração, use o guia de início rápido do Endpoints.
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 Endpoints > Serviços 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
Na parte superior, estão os gráficos de algumas das métricas. Dessa forma, é possível identificar imediatamente quaisquer picos e quedas. Outras ações possíveis:
No canto superior direito do primeiro gráfico, use a lista suspensa Selecionar gráficos para mostrar os gráficos das métricas de seu interesse e remover os que você não quer visualizar. Cada entrada na lista suspensa tem um ponto de interrogação no qual é possível posicionar o ponteiro do mouse para ver uma descrição da métrica exibida.
No canto superior direito da visão geral, ajuste os gráficos selecionando os vários períodos. Isso ajusta o intervalo de tempo de valores exibidos nesses gráficos, o que também altera a granularidade pontual.
Tabela de métodos
Quando estiver pronto para avançar, role para baixo para ver uma tabela com métricas para métodos individuais na API, abaixo dos gráficos. Outras ações possíveis:
No canto superior direito da tabela, use a lista suspensa Selecionar colunas para mostrar as métricas de seu interesse e remover as que você não quer exibir. Posicione o ponteiro sobre o ponto de interrogação nas entradas para ver uma descrição delas.
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
Quando identificar um problema nas métricas, acesse a página Explorador de registros no
console doGoogle Cloud para ver os registros das 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 Endpoints diretamente na página do Explorador de registros:
No Google Cloud console, acesse a página Stackdriver > Logging:
Crie consultas 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.
Configure e gerencie coletores para
encaminhar seus registros a destinos compatíveis
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
Pub/Sub.
Filtrar por um projeto de consumidor específico
Para ver as métricas de um projeto de consumidor específico, os clientes da API devem enviar uma chave de API ao fazer uma solicitação. Como o Endpoints usa a chave de API
para identificar o projeto ao qual o aplicativo de chamada está associado, a chave de API precisa ter sido criada no projetoGoogle Cloud do consumidor da API. Para saber como restringir o acesso à API usando uma chave de API, consulte Como restringir o acesso à API com chaves de API.
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 Endpoints > Serviços do seu projeto.
No canto superior esquerdo da página Visão geral, digite o número do projeto no campo Filtrar por número do projeto.
Clique em Filtrar.
As métricas na página são atualizadas para refletir o tráfego apenas do projeto especificado.
Alertas
As métricas coletadas pelo Endpoints também estão disponíveis no Cloud Monitoring. O Monitoring pode ser usado para configurar alertas sobre latência, tráfego e erros. O único
sinal dourado
que não pode ter um alerta configurado para usar métricas do Endpoints é a
saturação. As métricas de que você precisa para monitorar a saturação dependem do seu aplicativo. Acesse a lista de métricas disponíveis no Cloud Monitoring para ver as métricas que você pode usar para configurar alertas de saturação.
Para configurar alertas:
No console Google Cloud , selecione o projeto Google Cloud com sua API monitorada pelo Endpoints associada à conta.
[[["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-04 UTC."],[[["\u003cp\u003eCloud Endpoints automatically logs request and response information, tracking latency, traffic, and errors to help monitor API health.\u003c/p\u003e\n"],["\u003cp\u003eThe Endpoints Services page provides an overview with graphs and tables to visualize API performance and identify issues quickly.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter metrics for specific consumer projects by entering the project number in the "Filter by Project Number" field on the Overview page.\u003c/p\u003e\n"],["\u003cp\u003eAlerts can be set up in Cloud Monitoring for latency, traffic, and error metrics, using the "Produced API" resource type.\u003c/p\u003e\n"],["\u003cp\u003eThe logs collected can be viewed and analyzed in Logs Explorer, and can be routed to other destinations like BigQuery, Cloud Storage, or Pub/Sub for further analysis.\u003c/p\u003e\n"]]],[],null,["# Monitoring your API\n\nOpenAPI \\| [gRPC](/endpoints/docs/grpc/monitoring-your-api \"View this page for the Cloud Endpoints gRPC docs\")\n\n\u003cbr /\u003e\n\nThis page describes how you can monitor the health of APIs you own by using the\nlogs and metrics Cloud Endpoints maintains for you automatically. When\nusers make requests to your API, Endpoints logs information about\nthe requests and responses. Endpoints 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\nYou must deploy your API and send requests to it in order to generate logs and\nmetrics for viewing. If you don't have anything set up yet, try the\n[Endpoints quickstart](/endpoints/docs/deploy-api).\n\nAPI overview\n------------\n\nWhen you are debugging an issue with your service or just want to ensure that\neverything is running fine, go to your API's overview:\n\n1. In the Google Cloud console, go to the **Endpoints** \\\u003e **Services** page for\n your project:\n\n\n [Go to the Endpoints Services page](https://console.cloud.google.com/endpoints)\n\n \u003cbr /\u003e\n\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\nAt the top are graphs for some of the metrics, so you can spot any spikes\nand drops right away. You can:\n\n- In the top-right of the first graph, use the **Select graphs** drop-down list\n to show graphs for metrics you are interested in, and remove the ones you\n don't want to view. Each entry in the drop-down list has a question-mark\n that you can hold your pointer over to to see a description of the metric\n it displays.\n\n- In the top-right corner of the overview, adjust the graphs by selecting from\n the various time spans. This adjusts the time range of values displayed in\n these graphs, 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-right of the table, use the **Select columns** drop-down list to\n show the metrics you are interested in and remove the ones you don't want\n displayed. Entries here also have the question-mark that you can hold your\n pointer over to see a description.\n\n- In the top-right corner of the overview, select a time span for the\n metric values in the table by using the time span picker. This picks a time\n span for both the graphs and the table.\n\n### Logs\n\nWhen you spot an issue in the metrics, go to 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**.\n\n- To locate Endpoints logs directly from the Logs Explorer page:\n\n 1. In the Google Cloud console, go to the **Stackdriver** \\\u003e **Logging**\n page:\n\n\n [Go to the Logs Explorer page](https://console.cloud.google.com/logs/query)\n\n \u003cbr /\u003e\n\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 Endpoints service.\n\nSee the\n[Endpoints logs reference](/endpoints/docs/openapi/ref-endpoints-logs)\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 Build queries to specify the set of log entries that you want to view, such\n as getting all requests with a latency greater than 300 milliseconds.\n- [Configure and manage sinks](/logging/docs/export/configure_export_v2) to\n route your logs to supported destinations\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\n|\n| **Alpha**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nTo see metrics for a specific consumer project, your API consumers must send an\nAPI key when making a request. Because Endpoints uses the API key\nto identify the project that the calling application is associated\nwith, the API key must have been created in the API consumer's\nGoogle Cloud project. To learn how to restrict access to your API by using\nan API key, see\n\n[Restricting API access with API keys](/endpoints/docs/openapi/restricting-api-access-with-api-keys).\n\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 **Endpoints** \\\u003e **Services** page\n for your project.\n\n\n [Go to the Endpoints Services page](https://console.cloud.google.com/endpoints)\n\n \u003cbr /\u003e\n\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\nAlerting\n--------\n\n|\n| **Beta**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nMetrics collected by Endpoints are also available in\nCloud Monitoring. You can use Monitoring to set up alerting\non latency, traffic, and errors. The only\n[golden signal](https://landing.google.com/sre/book/chapters/monitoring-distributed-systems.html#xref_monitoring_golden-signals)\nthat you cannot set up an alert for using Endpoints metrics is\nsaturation. The metrics that you need to monitor for saturation depend on your\napplication. See the list of\n[metrics](/monitoring/api/metrics)\navailable in Cloud Monitoring for metrics that you can use to set up alerting\non saturation.\n\nTo set up alerting:\n\n1. In the Google Cloud console, select the Google Cloud project\n with your Endpoints monitored API which is associated with the\n account.\n\n [Go to Google Cloud console](https://console.cloud.google.com/)\n2. By using the navigation pane, select **Monitoring**.\n\n3. Create an [alerting policy](/monitoring/alerts)\n to set up alerts for the\n [golden signals](https://landing.google.com/sre/book/chapters/monitoring-distributed-systems.html#xref_monitoring_golden-signals)\n by using the following:\n\n - Latency\n\n 1. For **Condition Type** , enter `Metric Threshold`.\n 2. For **Resource Type** , enter `Produced API`.\n 3. For the metric, enter `Request latencies`.\n 4. Enter the threshold you want to alert on and follow the rest of the [Alerts guide](/monitoring/alerts).\n - Traffic\n\n 1. For **Condition Type** , enter `Metric Threshold`.\n 2. For **Resource Type** , enter `Produced API`.\n 3. For the metric, enter `Request count`.\n 4. Enter the threshold you want to alert on and follow the rest of the [Alerts guide](/monitoring/alerts).\n - Errors\n\n 1. For **Condition Type** , enter `Metric Threshold`.\n 2. For **Resource Type** , enter `Produced API`.\n 3. For the metric, enter `Request count`.\n 4. For response-code-class, enter `5xx`.\n 5. Enter the threshold you want to alert on and follow the rest of the [Alerts guide](/monitoring/alerts).\n\n| **Note:** If your API hasn't logged a 5xx response yet, the alerting policy form doesn't offer it as a response-code-class.\n| **Note:** If the critical constraint for your service is network IO, you might be able to use one of the Endpoints's metrics to set up an alert. All Endpoints logs are under the **Resource Type** of `Produced API`.\n\nWhat's next\n-----------\n\n- [Endpoints logs](/endpoints/docs/openapi/ref-endpoints-logs)\n- [Endpoints metrics](/monitoring/api/metrics_gcp_p_z#gcp-serviceruntime)"]]
