Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
En este tema, se presenta Apigee API Analytics.
Video: Mira un video breve para ver una descripción general de los servicios de estadísticas de la API de Apigee.
Mejora tu API a través de estadísticas
Las Estadísticas de la API de Apigee recopilan y calculan una gran cantidad de información que fluye a través de proxies de la API. Puedes visualizar estos datos con grafos y gráficos en la IU de Apigee o puedes descargar los datos sin procesar para un análisis sin conexión mediante las API de Apigee.
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?
- ¿Cuántos ingresos generaron tus transacciones?
Puedes analizar los datos de un nombre de host específico o de un entorno completo.
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, las estadísticas de la API de Apigee 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.
¿Cómo empiezo a usar las estadísticas de la API de Apigee?
El tipo de organización de Apigee que usas determinará los pasos necesarios para comenzar a usar las estadísticas de la API de Apigee. Si no estás seguro de si usas una organización de suscripción de Apigee o de pago por uso, comunícate con el administrador de tu organización de Apigee.
Usa las estadísticas de la API de Apigee con una organización de suscripción
Si eres cliente de una suscripción de Apigee, se incluye el acceso a las estadísticas de la API de Apigee en tus derechos de suscripción y se habilita automáticamente para cada uno de tus entornos de Apigee.
Puedes acceder a los datos de estadísticas para tu organización de suscripción con la IU de Apigee, la IU de Apigee en la consola de Cloud o la API de Apigee. Para obtener más detalles, consulta ¿Cómo puedo acceder a mis datos de estadísticas?
Usa las estadísticas de la API de Apigee con una organización de pago por uso
Si eres cliente de Pay-as-you-go, debes habilitar las estadísticas de la API de Apigee como un complemento pago para comenzar a usar los datos de estadísticas. Si deseas obtener más información sobre cómo habilitar el complemento de Analytics de la API de Apigee para tus entornos de Apigee intermedios o completos, consulta Administra el complemento de Analytics de la API de Apigee.
Después de habilitar el complemento de estadísticas de la API de Apigee en tus entornos, puedes acceder a tus datos de estadísticas y administrar el complemento de estadísticas de la API de Apigee con la IU de Apigee en la consola de Cloud o la API de Apigee. Para obtener más detalles, consulta ¿Cómo puedo acceder a mis datos de estadísticas? Los datos de estadísticas y la administración de complementos no están disponibles en la IU clásica de Apigee para organizaciones de pago por uso.
¿Qué tipo de datos se recopilan y analizan?
Las estadísticas de la API de Apigee recopilan y analizan 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 o ID de AppGroup
- Nombre de la aplicación
- Ingresos por transacciones
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?
Apigee 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 búsqueda, encabezados de solicitud, cuerpos de solicitudes y respuestas, o variables que definas en tus API.
Puedes recopilar datos de estadísticas personalizadas con la política DataCapture y, luego, usar la IU o la API de estadísticas para examinar los datos recopilados.
¿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.
- Disponibilidad de estadísticas: El tiempo que Apigee proporciona los datos de estadísticas (incluidos los datos de Monetization y Sense, si corresponde) varía según el plan. Según tu plan, los datos de estadísticas pueden estar disponibles para los últimos 30 días, 90 días o 14 meses.
Retención de las estadísticas cuando se usa el complemento de Analytics de la API de Apigee
Si tienes una organización de pago por uso, puedes habilitar el complemento de Estadísticas de la API de Apigee a nivel del entorno. Una vez que se habilita el complemento para un entorno, los datos de estadísticas del entorno se conservan durante 14 meses. Puedes acceder a los datos estadísticos históricos de estadísticas del entorno desde la página Métricas de la API en la consola, siempre y cuando el complemento esté habilitado.
Si inhabilitas el complemento de Estadísticas de la API de Apigee para un entorno en una organización de pago por uso, los datos de estadísticas del entorno se borran después de 30 días. Si vuelves a habilitar el complemento en el mismo entorno dentro de los 30 días posteriores a la inhabilitación, puedes recuperar el acceso a los datos de estadísticas del entorno durante el período de retención de 14 meses. No se restablecen los datos si el complemento se vuelve a habilitar para el entorno después de 30 días.
Si deseas conservar los datos de estadísticas para cualquier entorno de una organización de pago por uso más allá del período de retención de 14 meses, te recomendamos exportar y guardar tus datos en otra ubicación. También puedes exportar los datos de Estadísticas antes de inhabilitar el complemento de Estadísticas de la API de Apigee o dentro del período de 30 días después de la inhabilitación. Para obtener más información, consulta Exportar datos desde Estadísticas.
¿Dónde se almacenan y procesan mis datos de estadísticas?
El lugar donde se almacenan y procesan tus datos de estadísticas se determina mediante tu región de estadísticas, que especificaste cuando instalaste Apigee:
- Si eres cliente de una suscripción e instalaste Apigee con el asistente de aprovisionamiento de Apigee, especificaste tu región de estadísticas en el paso 1 Crea una organización cuando configuraste la región de hosting de Analytics.
- Si eres un cliente de pago por uso e instalaste Apigee con la consola de Google Cloud, especificaste tu región de análisis en el paso 3 Crea una organización, cuando configuras la región de hosting de Analytics.
- Si instalaste Apigee desde la línea de comandos como un cliente de suscripción o de pago por uso, especificaste tu región de análisis cuando definiste la variable de entorno
ANALYTICS_REGION.
Los datos de estadísticas se almacenan y procesan de la siguiente manera:
- En las regiones de estadísticas que no están en EE.UU. o la UE, los datos de estadísticas se almacenan y procesan en la región de estadísticas.
- Para las regiones de estadísticas de EE.UU. o la UE, los datos se almacenan en las multirregiones de US o EU, respectivamente, para lograr una mayor disponibilidad.
¿Cómo puedo acceder a mis datos de estadísticas?
El API de Apigee Analytics proporciona herramientas de visualización de datos integradas en la IU de Apigee. 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).
También puedes descargar datos de estadísticas con la API de Apigee. 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 Apigee proporciona un conjunto de paneles predefinidos que puedes usar para ver los datos de estadísticas.
Apigee en la consola de Cloud
Para abrir los paneles de Analytics (para organizaciones de suscripción o de pago por uso)
- Abre la IU de Apigee en la consola de Cloud en un navegador.
- Selecciona Estadísticas > Métricas de API.
Selecciona una de las siguientes pestañas para ver los paneles:
- Rendimiento de proxy de la API
- Análisis de códigos de errores
- Análisis de latencia
- Rendimiento de la caché
- Rendimiento objetivo
Para obtener más información, consulta Usa los paneles de estadísticas.
Apigee clásico
Para abrir los paneles de Analytics (solo para organizaciones de suscripción), haz lo siguiente:
- Abre la IU de Apigee en un navegador.
- Selecciona Analizar > Métricas de API.
- Selecciona uno de los siguientes paneles:
Además de estos, también puedes usar los siguientes paneles:
- En Analizar > Desarrolladores, haz lo siguiente:
- En Analizar > Usuarios finales, haz lo siguiente:
Para obtener más información, consulta Usa 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 Apigee.
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, consulta Crea y administra informes personalizados.
API de Analytics
Usa la API de Apigee 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://apigee.googleapis.com/v1/organizations/myorg/environments/test/stats/apiproxy?select=sum(message_count)&timeRange=6/24/2022%2000:00~6/25/2022%2023:59&timeUnit=hour" \ -H "Authorization: Bearer $TOKEN"
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 la sección sobre cómo usar la API de métricas.
Exporta datos de estadísticas a Google Cloud Platform
Puedes usar la API de Apigee para exportar todos los datos de estadísticas de un día entero de Apigee 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 la sección sobre cómo exportar datos desde 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 sobre el 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 es lenta? ¿Qué métodos de API suelen ser lentos o son lentos en este momento?
- Disponibilidad: ¿La API está arriba o abajo?
- Cuota: ¿tu API tiene una cuota? Como desarrollador de app, ¿cómo está mi cuota?
Para obtener más información, consulta Supervisa apps en la documentación de Drupal 8.
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 y administra informes personalizados.
- Usar las API de métricas 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 la API de métricas.
¿Cómo genero datos de estadísticas completos?
¿Qué queremos decir con estadísticas completas? Por ejemplo, puedes crear un proxy de API y Apigee 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 Apigee no sabe quién hizo una llamada a la API, no puede recopilar esos datos.
Debes seguir algunos pasos para que Apigee 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:
- 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.
- Registra desarrolladores de apps con Apigee. Consulta Registra desarrolladores de apps.
- Registra apps y administra las claves de API para tus desarrolladores. Consulta Registra apps y administra claves de API.
- 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: Política VerifyAPIKey, Política de OAuthV2 y Política VerifyJWT.
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.
Requisitos de Apigee Hybrid
En esta sección, se enumera información importante para los usuarios de Apigee Hybrid.
Compatibilidad con la residencia de datos
- Si tienes una organización de Apigee Hybrid v1.13.1 creada recientemente con la residencia de datos habilitada, sigue los pasos que se indican en Usa la residencia de datos con Apigee Hybrid.
- Los relojes de todos los nodos de Synchronizer deben estar sincronizados y en UTC.
Las versiones anteriores de Apigee Hybrid no son compatibles con las estadísticas de la API de Apigee.
Otros requisitos
- Debes tener configurada la cuenta de servicio
apigee-udca. Consulta la página Especifica anulaciones de configuración. - Los relojes de todos los nodos de Synchronizer deben estar sincronizados y en UTC.