Estás viendo la documentación de Apigee Edge.
Ve a la
documentación de Apigee X. info
En esta sección, se compara la supervisión de API con Edge Analytics. Si bien API Monitoring y Edge Analytics te permiten recopilar y ver datos de API, tienen objetivos diferentes:
- El objetivo de la supervisión de API es garantizar que tus APIs estén en funcionamiento según lo previsto. Para ello, debes ver los datos más recientes disponibles. La supervisión de API proporciona datos que son muy cercanos al tiempo real y te permite crear alertas que te notifiquen en caso de que surja un problema.
- El objetivo de Edge Analytics es comprender el comportamiento a largo plazo de tus APIs para que puedas asegurarte de que sean compatibles con los requisitos de tu empresa o realizar cambios si es necesario. Para estos fines, es menos importante ver los datos en tiempo real. Por lo tanto, los datos de Analytics tienen un retraso leve, aunque por lo general de 10 minutos como máximo.
Ten en cuenta que los datos de la supervisión de API, que se relacionan principalmente con los códigos de error y la latencia, son un subconjunto pequeño de los datos de Analytics.
Diferencias entre los datos de Supervisión de API y los datos de Analytics
En esta sección, se describen algunas diferencias menores entre los datos recopilados por Edge Analytics y la Supervisión de API. Dado que la Supervisión de API y Analytics usan diferentes canalizaciones de datos, es posible que veas diferencias menores entre los informes personalizados que genera la Supervisión y los que genera Analytics. Por ejemplo, es posible que veas discrepancias en los resultados informados de los errores de tiempo de espera, tanto de backend (código de estado HTTP 504 en la solicitud) como de cliente (código de estado HTTP 499). Estos pueden aparecer con el código de estado 200 en los informes personalizados de Analytics, pero aparecerán con el código de estado 504 o 499 en los informes personalizados de supervisión.Supervisión de API
La supervisión de API proporciona estadísticas en tiempo real sobre el rendimiento de la API y te ayuda a diagnosticar y solucionar problemas con rapidez para que tus APIs funcionen según lo previsto.
La supervisión de la API te permite lo siguiente:
- Aumenta la disponibilidad de las APIs y reduce el tiempo promedio del diagnóstico (MTTD).
- Tomar las medidas adecuadas en función de las alertas contextuales antes de que los consumidores se vean afectados
- Aprovecha los códigos de falla de Apigee para acelerar el diagnóstico.
- Aislar rápidamente las áreas con problemas para diagnosticar errores, el rendimiento y los problemas de latencia y su fuente.
Estadísticas de la API de Edge
Las Estadísticas de la API de Edge recopilan y analizan la información que fluye a través de las APIs. Las estadísticas de la API capturan información como la siguiente:
- ¿Cuáles son las tendencias de tráfico de tu API a lo largo del tiempo?
- ¿Cuáles son tus apps principales?
- ¿Quiénes son tus desarrolladores principales?
- Qué métodos de API son más populares
- Cuándo es más rápido o más lento el tiempo de respuesta de la API
- Geográficamente, ¿dónde ves la mayor parte del tráfico de API?
Datos recopilados por las estadísticas de la API
Las estadísticas de la API recopilan y analizan un amplio espectro de datos que fluyen a través de las APIs. Por ejemplo, mientras se implementa tu API, Analytics registra constantemente la cantidad de mensajes recibidos, la cantidad de desarrolladores, los tiempos de respuesta, los errores, la cantidad de apps en uso, el tamaño de la solicitud y muchos otros datos.
Para obtener una buena introducción a las métricas y cómo puedes usarlas, consulta Usa las APIs de métricas para medir el rendimiento del programa de API. Para obtener una lista completa de las métricas, consulta Referencia de métricas, dimensiones y filtros de Analytics.
Recopila métricas personalizadas
También puedes recopilar métricas personalizadas con la política StatisticsCollector. La política StatisticsCollector puede escribir información de los encabezados de solicitud, las cargas útiles de XML/JSON, los parámetros de consulta, los URIs y otras ubicaciones en el servidor de Analytics para el análisis y la generación de informes.
Accede a los datos de Analytics
Una vez que se generan, puedes acceder a las métricas predefinidas y personalizadas con las herramientas de visualización de la API de Analytics, incluidos el panel, los informes personalizados y el mapa geográfico. Para obtener más información sobre las herramientas de visualización que proporciona Estadísticas de API, consulta Paneles de Analytics. Para obtener más información sobre los informes personalizados, consulta Cómo crear informes personalizados.
Compara la supervisión de API con las estadísticas de API
Los desarrolladores de APIs usan la supervisión de APIs y la API de Analytics. Una de las principales diferencias entre ambos es el mecanismo de alertas integrado en la supervisión de API. Las alertas permiten que tu equipo de operaciones responda a los problemas de tus APIs en tiempo real para garantizar que estén disponibles y funcionen como se espera.
Las condiciones de alerta definen un código de estado específico (2xx/4xx/5xx), latencia y límites de código de falla que, cuando se superan, activan alertas visuales en la IU y envían notificaciones a través de una variedad de canales, como correo electrónico, Slack, PagerDuty o webhooks. Puedes configurar alertas en el entorno, el proxy de API o el servicio de destino, o en la región.
Después de que se activa una alerta, tu equipo de operaciones puede usar la IU de Supervisión de API para investigar el problema y desglosar su causa raíz. Luego, puedes generar un informe personalizado que incluya información predefinida sobre la alerta, como la siguiente:
- Tiempo total de respuesta
- Tiempo de respuesta del destino
- Errores del proxy
- Errores del destino
- UUID de la solicitud
- Y mucho más
Las estadísticas de la API están diseñadas para capturar una amplia variedad de datos que pueden usar varios equipos. Por ejemplo:
- El equipo de operaciones puede usar los datos de Analytics para identificar períodos de tráfico alto o bajo, de modo que pueda aumentar o disminuir los servicios para satisfacer las demandas cambiantes.
- El equipo de marketing puede usar los datos de Analytics para determinar los patrones de uso de los clientes que identifican las APIs, las apps, los clientes o los demás datos individuales.
- Todos los equipos pueden acceder a los datos personalizados recopilados de una solicitud para hacer un seguimiento de información específica, como los valores de encabezado, los parámetros de consulta o la carga útil de la solicitud.