Supervisar tu API

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:

  1. En la consola de Google Cloud, ve a la página Endpoints > Servicios de tu proyecto:

    Ir a la página Servicios de Endpoints

  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

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 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 Endpoints directamente desde la página Explorador de registros, haz lo siguiente:

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

      Ir a la página Explorador de registros

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

Para obtener más detalles sobre la estructura de los registros en el Explorador de registros, consulta la referencia de registros de Endpoints.

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

  • Comienza a usar el Explorador de registros.

    Compila 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 los receptores para desviar tus registros a destinos compatibles. 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 mensajería 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 proyecto de Google 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 la sección sobre cómo restringir el acceso a la API con claves de API.

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 Endpoints > Servicios de tu proyecto.

    Ir a la página Servicios de Endpoints

  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.

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:

  1. En la consola de Google Cloud, selecciona el proyecto de Google Cloud con tu API supervisada por Endpoints asociada con la cuenta.

    Ir a la consola de Google Cloud

  2. Usa el panel de navegación para seleccionar Monitoring.

  3. Crea una política de alertas para configurar alertas de los indicadores de oro con lo siguiente:

    • Latencia

      1. Para Tipo de condición, ingresa Metric Threshold.
      2. Para Tipo de recurso, ingresa Produced API.
      3. Para la métrica, ingresa Request latencies.
      4. Ingresa el umbral sobre el que quieres configurar alertas y continúa con el resto de la guía de alertas.

    • Tráfico

      1. Para Tipo de condición, ingresa Metric Threshold.
      2. Para Tipo de recurso, ingresa Produced API.
      3. Para la métrica, ingresa Request count.
      4. Ingresa el umbral sobre el que quieres configurar alertas y continúa con el resto de la guía de alertas.

    • Errores

      1. Para Tipo de condición, ingresa Metric Threshold.
      2. Para Tipo de recurso, ingresa Produced API.
      3. Para la métrica, ingresa Request count.
      4. Para response-code-class, ingresa 5xx.
      5. Ingresa el umbral sobre el que quieres configurar alertas y continúa con el resto de la guía de alertas.

¿Qué sigue?