Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
En esta página, se describe cómo puedes supervisar el estado de las API que posees mediante los registros y las métricas que Cloud Endpoints conserva de forma automática. Cuando los usuarios envían solicitudes a tu API, Endpoints registra la información sobre estas y las respuestas. Endpoints también realiza el seguimiento de tres de los cuatro indicadores de oro de la supervisión: latencia, tráfico y errores. Estas métricas de rendimiento y uso te ayudan a supervisar tu API.
Antes de comenzar
Debes implementar la API y enviarle solicitudes con el objetivo de generar registros y métricas que se puedan ver. Si aún no configuraste nada, puedes consultar la Guía de inicio rápido de Endpoints.
Descripción general de la API
Cuando depures un problema con tu servicio o tan solo desees asegurarte de que todo funcione bien, ve a la descripción general de la API siguiendo estos pasos:
En la consola de Google Cloud , ve a la página Endpoints > Servicios de tu proyecto:
Si tienes más de una API, haz clic en la que quieres supervisar.
Asegúrate de que te encuentres en la pestaña Descripción general.
Grafos
En la parte superior, hay grafos de algunas de las métricas, para que puedas localizar los picos y las caídas con rapidez. Puedes llevar a cabo las siguientes acciones:
En la parte superior derecha del primer grafo, utiliza la lista desplegable Seleccionar grafos para mostrar los grafos de las métricas que te interesan y quitar los que no deseas ver. Cada entrada de la lista desplegable tiene un signo de interrogación sobre el cual puedes pasar el puntero para ver una descripción de la métrica que muestra.
En la esquina superior derecha de la descripción general, elige entre los distintos intervalos de tiempo para ajustar los grafos. Esto ajusta el intervalo de tiempo de los valores que se muestran en los grafos, lo que también modifica el nivel de detalle de los puntos.
Tabla de métodos
Cuando estés listo para desglosar aún más, desplázate debajo de los grafos hasta llegar a la tabla que contiene las métricas de los métodos individuales de la API. Puedes llevar a cabo las siguientes acciones:
En la parte superior derecha de la tabla, usa la lista desplegable Seleccionar columnas para ver las métricas que te interesan y quitar las que no quieres ver. Estas entradas también tienen un signo de interrogación sobre el cual puedes colocar el puntero para ver una descripción.
En la esquina superior derecha de la descripción general, selecciona un intervalo de tiempo para los valores de métrica en la tabla mediante el selector de intervalos de tiempo. Este intervalo se usará para los grafos y la tabla.
Registros
Cuando detectes un problema en las métricas, ve a la página Explorador de registros en la consola deGoogle Cloud para ver los registros de las solicitudes y respuestas de tu API.
Si deseas ver registros individuales de los métodos de la API, haz clic en Ver registros en la tabla.
Para ver registros de todos los métodos de la API, haz clic en Ver todos los registros en la esquina inferior derecha.
Para ubicar los registros de Endpoints directamente desde la página Explorador de registros, haz lo siguiente:
En la consola de Google Cloud , ve a la página Stackdriver > Logging:
Crea consultas para especificar el conjunto de entradas de registro que deseas ver, por ejemplo, si quieres obtener todas las solicitudes con una latencia mayor a 300 milisegundos.
Configura y administra receptores para enrutar tus registros a destinos admitidos. Esto te permite transmitir registros a BigQuery para realizar un análisis más detallado, guardar los registros sin procesar en Cloud Storage o enviarlos a temas de mensajes de Pub/Sub.
Filtro para un proyecto de consumidor específico
Para ver las métricas de un proyecto de consumidor específico, los consumidores de la API deben enviar una clave de API cuando hacen la solicitud. Debido a que Endpoints usa la clave de API para identificar el proyecto asociado con la aplicación que realiza la llamada, esta clave debe haberse creado en el proyectoGoogle Cloud del consumidor de la API. Para obtener información sobre cómo restringir el acceso a tu API mediante una clave de API, consulta lo siguiente:
Para filtrar métricas en un proyecto de consumidor específico, haz lo siguiente:
Obtén el número del proyecto del consumidor de la API. Si no tienes permiso para acceder al proyecto de consumidor de la API, pídele el número del proyecto a alguien que sí tenga acceso.
En la consola de Google Cloud , ve a la página Endpoints > Servicios de tu proyecto.
En la esquina superior izquierda de la página Descripción general, ingresa el número del proyecto en el campo Filtrar por número de proyecto.
Haz clic en Filtrar.
Las métricas en la página se actualizan para mostrar solo el tráfico del proyecto especificado.
Alertas
Las métricas que recopila Endpoints también están disponibles en Cloud Monitoring. Puedes usar Monitoring para configurar alertas de latencia, tráfico y errores. El único indicador de oro para el que no puedes configurar una alerta cuando se usan métricas de Endpoints es la saturación. Las métricas que necesitas supervisar para ver la saturación dependen de la aplicación. Consulta la lista de métricas disponibles en Cloud Monitoring para obtener métricas que puedas usar a fin de configurar alertas de saturación.
Para configurar alertas, sigue estos pasos:
En la consola de Google Cloud , selecciona el proyecto Google Cloud con tu API supervisada por Endpoints asociada a la cuenta.
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (UTC)"],[[["\u003cp\u003eCloud Endpoints automatically logs and tracks key metrics for your APIs, including latency, traffic, and errors, to help monitor their health and performance.\u003c/p\u003e\n"],["\u003cp\u003eThe Endpoints Services page provides an overview of API performance through graphs and a methods table, allowing you to quickly spot trends and drill down into specific methods.\u003c/p\u003e\n"],["\u003cp\u003eThe Logs Explorer allows you to view logs of requests and responses for your API, either for individual methods or all methods, aiding in debugging and monitoring.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter metrics to view traffic from specific consumer projects by using their project number and setting it on the overview page.\u003c/p\u003e\n"],["\u003cp\u003eCloud Monitoring allows you to set up alerts for latency, traffic, and errors, and you can use additional Cloud Monitoring metrics to alert on saturation.\u003c/p\u003e\n"]]],[],null,["# Monitoring your API\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/frameworks/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\nthe following:\n\n- [Java: Restricting API access with API keys](/endpoints/docs/frameworks/java/restricting-api-access-with-api-keys-frameworks).\n- [Python: Restricting API access with API keys](/endpoints/docs/frameworks/python/restricting-api-access-with-api-keys-frameworks).\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/frameworks/ref-endpoints-logs)\n- [Endpoints metrics](/monitoring/api/metrics_gcp_p_z#gcp-serviceruntime)"]]
