Descripción general de la API de Analytics

Estás viendo la documentación de Apigee Edge.
Ve a la Documentación de Apigee X. información

En este tema, se presentan las estadísticas de la API de Edge.

Mejora tu API a través de estadísticas

Analytics de la API de Edge recopila y calcula una gran cantidad de información que fluye a través de los proxies de API. Puedes visualizar estos datos con gráficos en la IU de Edge o descargar los datos sin procesar para para el análisis sin conexión con 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, el análisis de la API de Edge ayuda tu equipo de API a mejorar sus APIs y ayuda a los desarrolladores de apps a 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?

Analytics de la API de Edge recopila y analiza un amplio espectro de datos que fluyen entre los proxies de API, por ejemplo:

• 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 recopilados por las estadísticas de API, consulta Referencia de métricas, dimensiones y filtros de Analytics.

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

Edge recopila una gran cantidad de datos de forma nativa. 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 búsqueda, encabezados de solicitud, cuerpos de solicitudes y respuestas, o variables que definas en tus API.

Puedes recopilar datos de estadísticas personalizados mediante la política StatisticsCollector. Una vez que se extraen los datos personalizados, puedes usar la IU o la API de Analytics para examinar los datos. 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 la 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 que se realiza una llamada a un proxy de API, puede demorar 10 minutos para que los datos estén accesibles para mostrarse o a través de llamadas a la API de Management.
• Retención de datos: La cantidad de tiempo que el perímetro conserva los datos de estadísticas depende del plan. Según tu plan, es posible que haya datos estadísticos disponibles de los últimos 30, 60, 90 o 365 días.

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

Las estadísticas de la API de Edge proporcionan 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 Proxy Performance:

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

• Tráfico total: Es 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. Puedes crear un informe personalizado con cualquiera de los datos de estadísticas integrados en Edge o de estadísticas personalizadas. Datos recopilados por 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 Edge Management 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 APIs de Metrics para medir el rendimiento del programa de APIs.

Exporta datos de estadísticas a Google Cloud

Puedes usar la API de Edge Management para exportar todos los datos de estadísticas de un día completo desde 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 de Analytics.

¿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 para el uso de apps
• 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 Cómo crear informes personalizados.
• Usar la API de Edge Management para capturar datos durante un período más amplio y compartirlos con la app a los desarrolladores sin conexión. Para obtener más información, consulta Usa las APIs de Metrics para medir el rendimiento del programa de APIs.

¿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 recopila datos estadísticos 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 hizo una llamada a la API, no puede recopilar esos datos.

Hay que seguir algunos pasos para que Edge pueda determinar cuáles son los desarrolladores y cuáles son sus apps llamando a los proxies de tu 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 a los desarrolladores de apps en Edge. Consulta Registra a los desarrolladores de apps.
3. Registra apps y genera claves de API para tus desarrolladores. Consulta Registra apps y administra las 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, sigue estos pasos: Asegúrate de haber habilitado el complemento de Analytics. (que está habilitada de forma predeterminada). Si el complemento de estadísticas está inhabilitado, Edge Microgateway no enviará datos de estadísticas a las estadísticas de Edge.

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 estadísticas de APIs. La supervisión de APIs examina los datos de análisis para proporcionar información contextual en tiempo real sobre Rendimiento de la API, lo que te permite diagnosticar problemas con rapidez y facilitar acciones correctivas para la continuidad del negocio. La supervisión de API está diseñada para encontrar rápidamente los puntos problemáticos en tus APIs y backends. Las estadísticas de las APIs se diseñaron para capturar una amplia variedad de datos de estadísticas para que los usen varios equipos diferentes. pero los datos suelen usarse para análisis en escenarios que no son en tiempo real.

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

Consulta la comparación entre la supervisión de la API y las estadísticas de la API de Edge para obtener una comparación más detallada entre estos servicios.

Más información

• Usa los paneles de estadísticas
• Cómo crear y administrar informes personalizados
• Usa las APIs de Metrics
• Analiza el contenido de los mensajes de la API con estadísticas personalizadas