Supervisa tu API

En esta página, se describe cómo puedes supervisar el estado de las API de API Gateway mediante los registros y las métricas que API Gateway mantiene por ti automáticamente.

Cuando creas una API, la puerta de enlace de API crea automáticamente un servicio administrado correspondiente. El nombre del servicio administrado 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 realizan solicitudes a tu API, API Gateway registra información sobre estas y las respuestas. API Gateway también realiza un 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

Para generar registros y métricas que se puedan ver, implementa una API y envíale solicitudes. Si aún no creaste ni implementaste una API en una puerta de enlace, prueba la guía de inicio rápido de API Gateway.

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:

  1. En la consola de Google Cloud, ve a la página API Gateway > APIs de tu proyecto:

    Ir a las API

  2. Si tienes más de una API, haz clic en la que quieres supervisar.

  3. Asegúrate de que te encuentres en la pestaña Descripción general.

Grafos

La página de descripción general proporciona varios gráficos de algunas de las métricas, para que puedas detectar de inmediato los picos, las caídas o la actividad inesperada. Con los filtros que se encuentran en la parte superior de la página, puedes hacer lo siguiente:

  • Usa la lista desplegable Seleccionar gráficos para mostrar los gráficos de las métricas que te interesan y quitar los que no deseas ver.
  • Para ajustar el alcance de los gráficos, selecciona entre los distintos intervalos de tiempo. Esto ajusta el intervalo de tiempo de los valores que se muestran, lo que también modifica el nivel de detalle de los puntos.

Tabla de métodos

Cuando estés listo para desglosar 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 esquina superior izquierda de la tabla, haz clic en el ícono Filtrar tabla para seleccionar opciones de búsqueda de filtros refinados en la tabla desplegable. Agrega OR entre cada consulta de filtro para buscar varios términos.
  • En la esquina superior derecha de la tabla, haz clic en el ícono Column Display Options para mostrar una lista desplegable. Marca las métricas que te interesan y borra las que no deseas que se muestren.
  • 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.

Logs

Cuando detectes un problema en las métricas, puedes usar la página Explorador de registros en la consola de Google 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 API Gateway directamente desde la página Explorador de registros, haz lo siguiente:

    1. En la consola de Google Cloud, ve a la página Explorador de registros.

      Ir al Explorador de registros

    2. Selecciona API producida, SERVICE_NAME, en la que SERVICE_NAME es el nombre del servicio administrado.

Consulta la referencia de registros de API Gateway para obtener detalles sobre la estructura de los registros en el Explorador de registros.

Aprende qué más puedes hacer con los registros:

  • Comienza a usar el Explorador de registros.

    Usa el panel de consulta 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 los receptores. Este 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 filtrar métricas en un proyecto de consumidor específico, haz lo siguiente:

  1. 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.

  2. En la consola de Google Cloud, ve a la página API Gateway > APIs de tu proyecto.

    Ir a las API

  3. 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.

  4. Haz clic en Filtrar.

Las métricas en la página se actualizan para mostrar solo el tráfico del proyecto especificado.

¿Qué sigue?