Organízate con las colecciones
Guarda y clasifica el contenido según tus preferencias.
Supervisar la API
En esta página se describe cómo puedes monitorizar el estado de tus APIs de API Gateway mediante los registros y las métricas que API Gateway mantiene automáticamente.
Cuando creas una API, API Gateway crea automáticamente un servicio gestionado correspondiente. El nombre del servicio gestionado creado se puede encontrar en el resultado del siguiente comando:
gcloud api-gateway apis describe API_ID
El nombre de tu servicio es el valor del campo managedService.
Cuando los usuarios envían solicitudes a tu API, API Gateway registra información sobre las solicitudes y las respuestas. API Gateway también monitoriza tres de las cuatro señales de oro de la monitorización: latencia, tráfico y errores. Estas métricas de uso y rendimiento te ayudan a monitorizar tu API.
Antes de empezar
Para generar registros y métricas que se puedan consultar, despliega una API y envíale solicitudes. Si aún no has creado ni implementado una API en una gateway, prueba la guía de inicio rápido de API Gateway.
Información general sobre la API
Cuando depures un problema con tu servicio o simplemente quieras asegurarte de que todo funciona correctamente, ve al resumen de tu API:
En la Google Cloud consola, ve a la página API Gateway > APIs de tu proyecto:
Si tienes más de una API, haz clic en la que quieras monitorizar.
Asegúrate de que estás en la pestaña Vista general.
Gráficos
La página de resumen incluye varios gráficos de algunas métricas para que pueda detectar al instante cualquier pico, descenso o actividad inesperada. Con los filtros de la parte superior de la página, puedes hacer lo siguiente:
Utilice la lista desplegable Seleccionar gráficos para mostrar los gráficos de las métricas que le interesen y quitar los que no quiera ver.
Ajusta el ámbito de los gráficos seleccionando uno de los distintos periodos. De esta forma, se ajusta el intervalo de tiempo de los valores mostrados, lo que también modifica la granularidad de los puntos.
Tabla de métodos
Cuando quieras obtener información más detallada, desplázate hacia abajo para ver una tabla con las métricas de los métodos individuales de tu API. Puedes hacer lo siguiente:
En la esquina superior izquierda de la tabla, haz clic en el icono Filtrar tabla para seleccionar opciones de consulta de filtro refinado en la tabla desplegable. Si quieres buscar varios términos, escribe OR entre los elementos de la consulta con filtros aplicados.
En la esquina superior derecha de la tabla, haz clic en el icono Opciones de visualización de columnas para que se muestre una lista desplegable. Marca las métricas que te interesen y desmarca las que no quieras que se muestren.
En la esquina superior derecha de la página Resumen, seleccione un periodo para los valores de las métricas de la tabla con el selector de periodo. De esta forma, se selecciona un periodo para los gráficos y la tabla.
Registros
Si detectas un problema en las métricas, puedes usar la página Explorador de registros de la consolaGoogle Cloud para ver los registros de las solicitudes y respuestas de tu API.
Para ver los registros de métodos concretos de tu API, haz clic en Ver registros en la tabla.
Para ver los registros de todos los métodos de tu API, en la esquina inferior derecha, haz clic en
Ver todos los registros.
Para localizar los registros de API Gateway directamente desde la página Explorador de registros, sigue estos pasos:
En la Google Cloud consola, ve a la página Explorador de registros:
Usa el panel de consulta para especificar el conjunto de entradas de registro que quieras ver, como todas las solicitudes con una latencia superior a 300 milisegundos.
Configurar y gestionar sumideros.
De esta forma, puedes transmitir registros a BigQuery para analizarlos más a fondo, guardar los registros sin procesar en Cloud Storage o enviarlos a temas de mensajería de Pub/Sub.
Filtrar por un proyecto del consumidor específico
Para filtrar métricas de un proyecto de consumidor específico, sigue estos pasos:
Obtén el número de proyecto del proyecto del consumidor de la API. Si no tienes permiso para acceder al proyecto del consumidor de la API, pide a alguien que sí lo tenga que te proporcione el número del proyecto.
En la Google Cloud consola, ve a la página API Gateway > APIs de tu proyecto.
[[["Es fácil de entender","easyToUnderstand","thumb-up"],["Me ofreció una solución al problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Es difícil de entender","hardToUnderstand","thumb-down"],["La información o el código de muestra no son correctos","incorrectInformationOrSampleCode","thumb-down"],["Me faltan las muestras o la información que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 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)"]]
