Supervisar la API

OpenAPI   |  gRPC

En esta página se describe cómo puedes monitorizar el estado de las APIs que tienes mediante los registros y las métricas que Cloud Endpoints mantiene automáticamente. Cuando los usuarios envían solicitudes a tu API, Endpoints registra información sobre las solicitudes y las respuestas. Endpoints 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, debe desplegar su API y enviarle solicitudes. Si aún no has configurado nada, prueba la guía de inicio rápido de Endpoints.

Información general sobre la API

Cuando depures un problema con tu servicio o simplemente quieras asegurarte de que todo funciona correctamente, ve a la página de resumen de tu API:

1. En la consola de Google Cloud , vaya a la página Endpoints (Endpoints) > Services (Servicios) de su proyecto:

   Ir a la página Servicios de Endpoints

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

3. Asegúrate de que estás en la pestaña Vista general.

Gráficos

En la parte superior se muestran gráficos de algunas de las métricas para que puedas detectar picos y descensos al instante. Puedes hacer lo siguiente:

• En la parte superior derecha del primer gráfico, usa la lista desplegable Seleccionar gráficos para mostrar los gráficos de las métricas que te interesen y quitar los que no quieras ver. Cada entrada de la lista desplegable tiene un signo de interrogación sobre el que puedes colocar el cursor para ver una descripción de la métrica que muestra.

• En la esquina superior derecha del resumen, ajusta los gráficos seleccionando uno de los distintos periodos. De esta forma, se ajusta el intervalo de tiempo de los valores que se muestran en estos gráficos, 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 parte superior derecha de la tabla, usa la lista desplegable Seleccionar columnas para mostrar las métricas que te interesan y quitar las que no quieras que se muestren. Las entradas de esta sección también tienen un signo de interrogación sobre el que puedes colocar el cursor para ver una descripción.

• En la esquina superior derecha del resumen, selecciona un periodo para los valores de la métrica de la tabla con el selector de periodo. De esta forma, se selecciona un periodo para los gráficos y la tabla.

Registros

Cuando detectes un problema en las métricas, ve a 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 Endpoints directamente desde la página Explorador de registros, sigue estos pasos:

  1. En la Google Cloud consola, ve a la página Stackdriver > Logging:

     Ir a la página Explorador de registros

  2. Selecciona API generada, SERVICE_NAME, donde SERVICE_NAME es el nombre del servicio Endpoints.

Consulta la referencia de registros de endpoints para obtener información sobre la estructura de los registros en el Explorador de registros.

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

• Empieza a usar el Explorador de registros.

  Crea consultas para especificar el conjunto de entradas de registro que quieres ver, como obtener todas las solicitudes con una latencia superior a 300 milisegundos.

• Configura y gestiona sumideros para enrutar tus registros a destinos compatibles. 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

Alfa

Esta función está sujetas a los "Términos de las Ofertas de Acceso Previo a la Disponibilidad General" de la sección Términos Generales de los Servicios de los Términos Específicos de los Servicios. Las funciones previas a la disponibilidad general están disponibles tal cual y pueden tener una compatibilidad y asistencia limitadas. Para obtener más información, consulta las descripciones de las fases de lanzamiento.

Para ver las métricas de un proyecto de consumidor específico, los consumidores de tu API deben enviar una clave de API al hacer una solicitud. Como Endpoints usa la clave de API para identificar el proyecto al que está asociada la aplicación que llama, la clave de API debe haberse creado en elGoogle Cloud proyecto del consumidor de la API. Para saber cómo restringir el acceso a tu API mediante una clave de API, consulta el artículo Restringir el acceso a las APIs con claves de API.

Para filtrar métricas de un proyecto del consumidor específico, sigue estos pasos:

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

2. En la Google Cloud consola, ve a la página Endpoints > Services (Endpoints > Servicios) de tu proyecto.

   Ir a la página Servicios de Endpoints

3. En la esquina superior izquierda de la página Resumen, introduzca el número de proyecto en el campo Filtrar por número de proyecto.

4. Haz clic en Filtrar.

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

Alertas

Beta

Esta función está sujetas a los "Términos de las Ofertas de Acceso Previo a la Disponibilidad General" de la sección Términos Generales de los Servicios de los Términos Específicos de los Servicios. Las funciones previas a la disponibilidad general están disponibles tal cual y pueden tener una compatibilidad y asistencia limitadas. Para obtener más información, consulta las descripciones de las fases de lanzamiento.

Las métricas recogidas por Endpoints también están disponibles en Cloud Monitoring. Puedes usar Monitoring para configurar alertas sobre la latencia, el tráfico y los errores. La única señal de oro para la que no puedes configurar una alerta con las métricas de Endpoints es la saturación. Las métricas que debes monitorizar para detectar la saturación dependen de tu aplicación. Consulta la lista de métricas disponibles en Cloud Monitoring para ver las que puedes usar para configurar alertas de saturación.

Para configurar alertas, sigue estos pasos:

1. En la Google Cloud consola, selecciona el Google Cloud proyecto con la API monitorizada de Endpoints asociada a la cuenta.

   Ir a la Google Cloud consola

2. En el panel de navegación, selecciona Monitorización.

3. Crea una política de alertas para configurar alertas de las señales de oro mediante lo siguiente:

   • Latencia

     1. En Tipo de condición, escribe Metric Threshold.
     2. En Resource Type (Tipo de recurso), introduce Produced API.
     3. En la métrica, introduzca Request latencies.
     4. Introduce el umbral para el que quieres recibir alertas y sigue el resto de las instrucciones de la guía de alertas.

   • Tráfico

     1. En Tipo de condición, escribe Metric Threshold.
     2. En Resource Type (Tipo de recurso), introduce Produced API.
     3. En la métrica, introduzca Request count.
     4. Introduce el umbral para el que quieres recibir alertas y sigue el resto de las instrucciones de la guía de alertas.

   • Errores

     1. En Tipo de condición, escribe Metric Threshold.
     2. En Resource Type (Tipo de recurso), introduce Produced API.
     3. En la métrica, introduzca Request count.
     4. En response-code-class, introduce 5xx.
     5. Introduce el umbral para el que quieres recibir alertas y sigue el resto de las instrucciones de la guía de alertas.

Nota: Si tu API aún no ha registrado una respuesta 5xx, el formulario de la política de alertas no la ofrece como clase de código de respuesta.

Nota: Si la restricción crítica de tu servicio es la E/S de red, es posible que puedas usar una de las métricas de Endpoints para configurar una alerta. Todos los registros de Endpoints se encuentran en el tipo de recurso de Produced API.

Siguientes pasos

• Registros de Endpoints
• Métricas de endpoints