Descripción general de la API de Analytics

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

En este tema, se presenta Edge API Analytics.

Mejora tu API a través de estadísticas

Edge API Analytics recopila y calcula una gran cantidad de información que fluye a través de proxies de API. Puedes visualizar estos datos con grafos y gráficos en la IU de Edge o puedes descargar los datos sin procesar para análisis sin conexión mediante las APIs de administración de Edge.

Analytics te permite responder preguntas comunes, como las siguientes:

• En el tiempo, ¿cuáles son mis tendencias de tráfico de API?
• ¿Qué métodos de API son más populares?
• ¿Quiénes son mis desarrolladores principales?
• ¿Cuándo es más rápido el tiempo de respuesta de la API? ¿Y cuándo es más lento?
• Geográficamente, ¿dónde veo la mayor parte del tráfico de API?

Las respuestas a preguntas como estas te ayudan a mejorar las API, solucionar problemas y tomar mejores decisiones empresariales relacionadas con tu programa de API.

Las estadísticas de la API ayudan a todos a mejorar

A través de un proceso continuo de recopilación, análisis y visualización de datos, Edge API Analytics ayuda a tu equipo de API a mejorar sus API y a los desarrolladores de apps para mejorar sus apps:

• Equipo de API: El equipo de API aprovecha los sistemas internos para crear API interesantes. El equipo de API desea saber cómo funciona en general el programa de API, cuál es el rendimiento de las API individuales y cómo mejorar sus API.
• Desarrolladores de apps: Compartir información de estadísticas con los desarrolladores de apps permite obtener mejores apps. Estos desarrolladores innovan con tu API y compilan apps creativas que te ayudan a aumentar los ingresos de tu empresa. Las estadísticas ayudan a los desarrolladores de aplicaciones a conocer el rendimiento de sus aplicaciones, lo que contribuye al resultado de empresa. Los desarrolladores de aplicaciones quieren saber cómo pueden mejorar sus apps.
• Equipo de operaciones: El equipo de operaciones desea comprender los patrones de tráfico y prever cuándo agregar recursos de backend o realizar otros ajustes críticos.
• Propietario de la empresa: El propietario de la empresa desea ver cómo se mejora su inversión en la API y dónde invertir en el futuro.

¿Qué tipo de datos se recopilan y analizan?

Edge API Analytics recopila y analiza un amplio espectro de datos que fluyen a través de proxies de API como los siguientes:

• Tiempo de respuesta
• Latencia de la solicitud
• Tamaño de la solicitud
• Errores del destino
• Nombre del producto de la API
• Dirección de correo electrónico del desarrollador
• Nombre de la app
• Muchas cosas más

Para obtener una lista completa de los datos que recopilan las estadísticas de la API, consulta Referencia de métricas, dimensiones y filtros de Analytics.

¿Cómo puedo recopilar datos de estadísticas personalizados?

Edge recopila de forma nativa una gran cantidad de datos. También puedes recopilar datos de estadísticas personalizados específicos de proxies de API, apps, productos o desarrolladores. Por ejemplo, es posible que desees recopilar datos de estadísticas de parámetros de consulta, encabezados de solicitud, cuerpos de solicitudes y respuestas, o variables que definas en tus API.

Para recopilar datos de estadísticas personalizados, usa la política StatisticsCollector. Una vez que se extraen los datos personalizados, puedes usar la IU o la API de Analytics para examinarlos. Consulta Analiza el contenido de los mensajes de la API mediante estadísticas personalizadas para obtener un ejemplo completo que demuestra cómo recopilar datos de estadísticas personalizadas.

Diferencias entre los datos de Analytics y los datos de Supervisión de API

¿Cuándo están disponibles mis datos de estadísticas y durante cuánto tiempo?

Existen dos intervalos que controlan cuándo puede ver sus datos de estadísticas por cuánto tiempo puede hacerlo:

• Intervalo de demora de datos : Después de hacer una llamada a un proxy de API, pueden transcurrir hasta 10 minutos para poder acceder a los datos y poder visualizarlos o mostrarlos a través de llamadas a la API de administración.
• Retención de datos - La cantidad de tiempo que se conservan los datos de Analytics depende de tu plan de suscripción:
  • Estándar: 30 días
  • Enterprise: 3 meses
  • Enterprise Plus: 14 meses
  Consulta los precios de la administración de APIs de Apigee para obtener más información.

¿Cómo puedo acceder a mis datos de estadísticas?

Edge API Analytics proporciona herramientas de visualización de datos integradas en la IU de Edge. Estas herramientas incluyen paneles de análisis predefinidos y, también, informes personalizados que muestran datos en grafos y gráficos, y te permiten desglosar los datos agrupados en dimensiones diferentes (por ejemplo, por proxy de API, dirección IP o código de estado HTTP).

Además, puedes descargar datos de estadísticas con la API de administración de Edge. Una vez descargados, puedes importar esos datos a tus propias herramientas de visualización de datos o sistema de estadísticas.

Paneles de estadísticas

La IU de Edge proporciona un conjunto de paneles predefinidos que puedes usar para ver los datos de estadísticas. Por ejemplo, en las siguientes imágenes, se muestra el panel Rendimiento del proxy:

En este panel, se incluyen gráficos para los siguientes elementos:

• Tráfico total : La cantidad total de solicitudes a la API que recibió Edge para un entorno de API en una organización.
• Éxito del tráfico : La cantidad total de solicitudes que generaron una respuesta exitosa. Las respuestas de error no cuentan.
• Errores de tráfico: La cantidad total de todas las solicitudes a la API que no se realizaron correctamente, es decir, la solicitud no entrega una respuesta. El recuento incluye errores de proxy (de Apigee) y errores de destino (los servicios de backend).
• Promedio de TPS: Cantidad promedio de solicitudes a la API y respuestas resultantes por segundo.

Entre los paneles predefinidos adicionales, se incluyen los siguientes:

• Rendimiento de la caché
• Interacción con desarrolladores
• Uso del dispositivo
• Análisis de códigos de errores
• Mapa geográfico
• Análisis de latencia
• Rendimiento objetivo
• Composición del tráfico

Para obtener más información sobre estos paneles predefinidos, consulta la sección sobre cómo usar los paneles de estadísticas.

Informes personalizados

Con los informes personalizados, puedes desglosar las métricas específicas de la API y ver los datos exactos que deseas visualizar. Para crear un informe personalizado, usa cualquiera de los datos de estadísticas integrados en Edge o los datos de estadísticas personalizados que recopiló la política StatisticsCollector.

Cuando compilas un informe personalizado, selecciona los datos que deseas ver (métricas), agrupa los datos de manera significativa (dimensiones) y, de manera opcional, limita los datos que se muestran en función de características específicas de los datos (filtrado).

También puede establecer el tipo de gráfico que se muestra en el informe personalizado como una columna o un gráfico de líneas. En las siguientes imágenes, se muestran ejemplos de gráficos de transacciones por segundo agrupadas por el proxy de API:

• Columna: Cada proxy de API está representado por una columna diferente:

  

• Línea: Cada proxy de API está representado por una línea diferente:

  

Para obtener más información, consulte Crea y administra informes personalizados.

API de Analytics

Usa la API de administración de Edge para descargar datos de estadísticas. Por ejemplo, puedes usar la API para crear tus propias herramientas de visualización, que puedes incorporar en portales o aplicaciones personalizadas.

Esta es un ejemplo de una llamada a la API a fin de recuperar datos de estadísticas para proxies de API:

curl  https://api.enterprise.apigee.com/v1/o/org_name/environments/test/stats/apiproxy?"select=sum(message_count)&timeRange=6/24/2018%2000:00~6/24/2018%2023:59&timeUnit=hour" \
-u email:password

Esta llamada mostrará lo siguiente:

• La suma de solicitudes (recuento de mensajes) por proxy de API
• Por un período de 24 horas
• Agrupado por hora

El parámetro de consulta timeRange especifica el período en el siguiente formato:

?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM

Observa el %20 antes de HH:MM. El parámetro timeRange requiere un carácter de espacio con codificación URL antes de HH:MM o un carácter +, como en: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Para obtener más información, consulta Usa las API de métricas para medir el rendimiento del programa de API.

Exporta datos de estadísticas a Google Cloud

Puedes usar la API de administración de Edge para exportar todos los datos de estadísticas de un día entero de Edge a tu propio repositorio de datos, como Google Cloud Storage o BigQuery. Luego, puedes aprovechar las potentes capacidades de consulta y aprendizaje automático que ofrecen BigQuery y TensorFlow de Google Cloud para realizar tu propio análisis de datos.

Para obtener más información, consulta Exporta datos desde las estadísticas.

¿Cómo comparto datos con los desarrolladores de apps?

Cuando pienses en los desarrolladores de apps como tus clientes, querrás asegurarte de que tengan las herramientas y la información disponibles para que aprovechen tu API al máximo.

Los desarrolladores de apps no solo están interesados en la calidad de sus apps, sino que están muy interesados en tus API. Los portales para desarrolladores basados en Drupal incluyen una página opcional Rendimiento de la aplicación, diseñada para dar a los desarrolladores de apps acceso a métricas importantes de sus apps. En esta página, se ofrece a los desarrolladores información sobre lo siguiente:

• Errores: ¿Qué errores de API ve mi app?
• Rendimiento: ¿La API resulta lenta en este momento? ¿Qué métodos de API suelen ser lentos o son lentos en este momento?
• Disponibilidad: ¿La API está arriba o abajo en este momento?
• Cuota: ¿tu API tiene una cuota? Como desarrollador de app, ¿cómo está mi cuota ?

Para obtener más información, consulta lo siguiente:

• Drupal 7: Muestra estadísticas sobre el uso de la app
• Drupal 8: Supervisa apps
• Portal integrado: No disponible

Además, puedes compartir estadísticas con tus desarrolladores de las siguientes maneras:

• Crear informes personalizados y compartirlos con tus desarrolladores de app Para obtener más información, consulta Crea informes personalizados.
• Usar la API de administración de Edge para capturar datos de un período más amplio y compartirlos con desarrolladores de apps sin conexión Para obtener más información, consulta Usa las API de métricas para medir el rendimiento del programa de API.

¿Cómo genero datos de estadísticas completos?

¿Qué queremos decir con estadísticas completas? Por ejemplo, puedes crear un proxy de API y Edge recopilará datos de estadísticas sobre ese proxy. Sin embargo, ¿qué ocurre con las métricas para el desarrollador o la app que llamó al proxy de API? Si Edge no sabe quién realizó una llamada a la API, no puede recopilar esos datos.

Debes seguir algunos pasos para que Edge sepa qué desarrolladores y qué apps de desarrollador llaman a tus proxies de API. A continuación, te mostramos una lista de los pasos con vínculos para obtener información más detallada:

1. Crea uno o más productos de API, que es una agrupación de proxies de API junto con un plan de servicio. Consulta Administra productos de API.
2. Registra desarrolladores de apps con Edge. Consulta Registra desarrolladores de apps.
3. Registra apps y genera claves de API para tus desarrolladores. Consulta Registra apps y administra claves de API.
4. Agrega políticas de seguridad a los proxies de API que verifican las claves de API o los tokens de seguridad. Consulta los siguientes temas:Verifica la política de clave de API, política de OAuthV2 y Verifica la política de JWT.
5. Si usas Edge Microgateway, asegúrate de haber habilitado el complemento de estadísticas (que está habilitado de forma predeterminada). Si el complemento de estadísticas está inhabilitado, Edge Microgateway no enviará datos de estadísticas a Edge Analytics.

Los siguientes instructivos te guiarán en los pasos necesarios para ver estadísticas de desarrolladores y apps: Protege una API mediante la solicitud de clave de API y Protege una API con OAuth.

Compara las estadísticas de la API con la supervisión de la API

Puedes aprovechar la Supervisión de API de Edge y las estadísticas de la API. La Supervisión de API examina los datos de estadísticas para proporcionar estadísticas contextuales en tiempo real sobre el rendimiento de la API, lo que te permite diagnosticar rápidamente los problemas y facilitar las acciones de solución para la continuidad empresarial. La Supervisión de API está diseñada para encontrar rápidamente puntos problemáticos en tus APIs y backends. Las estadísticas de la API están diseñadas para capturar una amplia variedad de datos de estadísticas para que los usen varios equipos diferentes, pero los datos suelen usarse para el análisis en situaciones que no son en tiempo real.

Una de las principales diferencias entre la Supervisión de API y las estadísticas de la API es el mecanismo de alerta integrado en la Supervisión de API. Con las alertas, especificas un código de estado HTTP (2xx/4xx/5xx), latencia o límite de código de falla que, cuando se excede, activa una notificación de alerta a tu equipo de operaciones. Las notificaciones de alerta se pueden enviar a través de una variedad de canales, como correo electrónico, Slack, buscapersonas o webhooks, lo que te permite responder a los problemas de inmediato.

Consulta Compara la Supervisión de API con Edge API Analytics para obtener una comparación más detallada entre estos servicios.

Más información

• Usa los paneles de estadísticas
• Crea y administra informes personalizados
• Usa las APIs de métricas
• Analiza el contenido de mensajes de API mediante estadísticas personalizadas