Información general sobre las analíticas de las APIs de Apigee

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.

Mejorar tu API con las analíticas

Apigee API Analytics recoge y calcula una gran cantidad de información que fluye a través de los proxies de API. Puede visualizar estos datos con gráficos en la interfaz de usuario de Apigee o descargar los datos sin procesar para analizarlos sin conexión mediante las APIs de Apigee.

Analytics le ayuda a responder preguntas habituales, como las siguientes:

  • ¿Cómo evoluciona mi tráfico de APIs a lo largo del tiempo?
  • ¿Qué métodos de la API son los más populares?
  • ¿Quiénes son mis principales desarrolladores?
  • ¿Cuándo es más rápido el tiempo de respuesta de la API? ¿La más lenta?
  • ¿En qué zonas geográficas se genera la mayor parte del tráfico de las APIs?
  • ¿Cuántos ingresos han generado tus transacciones?

Puede analizar los datos de un nombre de host específico o de todo un entorno.

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

API Analytics ayuda a todos a mejorar

Mediante un proceso continuo de recogida, análisis y visualización de datos, Apigee API Analytics ayuda a tu equipo de APIs a mejorar sus APIs y a los desarrolladores de aplicaciones a mejorar sus aplicaciones:

Los datos fluyen desde las aplicaciones a través de proxies de API y, a continuación, las analíticas de datos ayudan a orientar las acciones de los desarrolladores de aplicaciones, los equipos de API, los equipos de operaciones y los propietarios de las empresas.
  • Equipo de APIs: este equipo está aprovechando los sistemas internos para crear APIs interesantes. El equipo de la API quiere saber cómo va el programa de APIs en general, cómo funcionan las APIs individuales y cómo mejorar sus APIs.
  • Desarrolladores de aplicaciones: si compartes información analítica con desarrolladores de aplicaciones, obtendrás mejores aplicaciones. Estos desarrolladores están innovando con tu API y creando aplicaciones creativas que ayudan a generar ingresos para tu empresa. Analytics ayuda a los desarrolladores de aplicaciones a saber cómo funcionan sus aplicaciones y cuánto contribuyen a los resultados de tu empresa. Los desarrolladores de aplicaciones quieren saber cómo pueden mejorar sus aplicaciones.
  • Equipo de Operaciones: el equipo de Operaciones quiere conocer los patrones de tráfico y anticipar cuándo debe añadir recursos backend o hacer otros ajustes críticos.
  • Propietario de la empresa: el propietario de la empresa quiere saber cómo está dando sus frutos la inversión en APIs y dónde invertir en el futuro.

¿Cómo puedo empezar a usar las analíticas de la API de Apigee?

El tipo de organización de Apigee que utilices determinará los pasos necesarios para empezar a usar Apigee API Analytics. Si no sabes con seguridad si estás usando una organización de Apigee con suscripción o con pago por uso, ponte en contacto con el administrador de tu organización de Apigee.

Usar las analíticas de la API de Apigee con una organización de suscripción

Si eres cliente de la suscripción a Apigee, el acceso a Apigee API Analytics está incluido en tus derechos de suscripción y se habilita automáticamente en cada uno de tus entornos de Apigee.

Puedes acceder a los datos analíticos de tu organización de suscripción mediante la interfaz de usuario de Apigee en la consola de Cloud o la API de Apigee. Para obtener más información, consulta Cómo accedo a mis datos analíticos.

Usar Apigee API Analytics con una organización de pago por uso

Si es cliente del plan Pay-as-you-go, debe habilitar Apigee API Analytics como complemento de pago para empezar a usar los datos analíticos. Para obtener más información sobre cómo habilitar el complemento Apigee API Analytics en tus entornos de Apigee Intermedio o Completo, consulta el artículo Gestionar el complemento Apigee API Analytics.

Una vez que el complemento Apigee API Analytics esté habilitado en tus entornos, podrás acceder a tus datos analíticos y gestionar el complemento Apigee API Analytics mediante la interfaz de Apigee en la consola de Cloud o la API de Apigee. Para obtener más información, consulta Cómo accedo a mis datos analíticos. Los datos de analíticas y la gestión de complementos no están disponibles en la interfaz de usuario clásica de Apigee para las organizaciones con pago por uso.

¿Qué tipo de datos se recogen y analizan?

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

  • Tiempo de respuesta
  • Latencia de solicitudes
  • Tamaño de la solicitud
  • Errores de destino
  • Nombre del producto de API
  • Dirección de correo del desarrollador o ID de AppGroup
  • Nombre de la aplicación
  • Ingresos por transacciones

Para ver una lista completa de los datos recogidos por API Analytics, consulte la referencia de métricas, dimensiones y filtros de Analytics.

¿Cómo puedo recoger datos analíticos personalizados?

Apigee recoge de forma nativa una gran cantidad de datos. También puede recoger datos analíticos personalizados específicos de sus proxies de API, aplicaciones, productos o desarrolladores. Por ejemplo, puede que quieras recoger datos analíticos de parámetros de consulta, encabezados de solicitud, cuerpos de solicitud y respuesta, o variables que definas en tus APIs.

Puede recoger datos analíticos personalizados con la política DataCapture y, a continuación, usar la interfaz de usuario o la API de Analytics para examinar los datos recogidos.

¿Cuándo y durante cuánto tiempo están disponibles mis datos analíticos?

Hay dos intervalos de tiempo que controlan cuándo y durante cuánto tiempo puedes ver tus datos analíticos:

  • Intervalo de retraso de los datos: después de hacer una llamada a un proxy de API, pueden pasar hasta 10 minutos para que se pueda acceder a los datos para mostrarlos o mediante llamadas a la API.
  • Disponibilidad de Analytics: el periodo de conservación de los datos de analíticas es de 14 meses.

Retención de datos de analíticas al usar el complemento Analíticas de la API de Apigee

Si tienes una organización de pago por uso, puedes habilitar el complemento Apigee API Analytics a nivel de entorno. Una vez que el complemento se habilita en un entorno, los datos analíticos de ese entorno se conservan durante 14 meses. Puedes acceder a los datos analíticos históricos del entorno desde la página Métricas de la API de la consola siempre que el complemento esté habilitado.

Si inhabilitas el complemento Apigee API Analytics en un entorno de una organización de pago por uso, los datos analíticos del entorno se eliminarán al cabo de 30 días. Si vuelves a habilitar el complemento en el mismo entorno en un plazo de 30 días desde que lo inhabilitaste, podrás volver a acceder a los datos analíticos del entorno durante el periodo de conservación de 14 meses. No se restaurarán los datos si se vuelve a habilitar el complemento en el entorno después de 30 días.

Si quieres conservar los datos analíticos de cualquier entorno de una organización de pago por uso más allá del periodo de conservación de 14 meses, te recomendamos que exportes y guardes los datos en otra ubicación. También puede exportar sus datos de Analytics antes de inhabilitar el complemento Apigee API Analytics o en un plazo de 30 días después de inhabilitarlo. Para obtener más información, consulte Exportar datos de Analytics.

¿Dónde se almacenan y procesan mis datos analíticos?

La ubicación en la que se almacenan y se tratan los datos analíticos se determina en función de la región analítica, que especificaste al instalar Apigee:

  • Si es cliente de Suscripción y ha instalado Apigee con el asistente de aprovisionamiento de Apigee, ha especificado su región de analíticas en el paso 1 de Crear una organización, al definir la región de alojamiento de analíticas.
  • Si eres cliente del modelo de pago por uso y has instalado Apigee mediante la Google Cloud consola, has especificado tu región de analíticas en el paso 3 de Crear una organización, cuando has definido la región de alojamiento de analíticas.
  • Si instalaste Apigee desde la línea de comandos como cliente de suscripción o de pago por uso, especificaste tu región de analíticas cuando definiste la variable de entorno ANALYTICS_REGION.
  • Si has instalado Apigee con la opción de un solo clic, tus datos analíticos se almacenan en la región us-west1. No puedes cambiar esta ubicación predeterminada.

Los datos de Analytics se almacenan y procesan de la siguiente manera:

  • En las regiones de analíticas que no se encuentran en EE. UU. ni en la UE, los datos de analíticas se almacenan y tratan en la región de analíticas.
  • En el caso de las regiones de analíticas de EE. UU. o de la UE, los datos se almacenan en la multirregión de EE. UU. o de la UE, respectivamente, para disfrutar de una mayor disponibilidad.

¿Cómo puedo acceder a mis datos analíticos?

Analíticas de las APIs de Apigee ofrece herramientas de visualización de datos integradas en la interfaz de usuario de Apigee. Estas herramientas incluyen paneles de control de analíticas predefinidos e informes personalizados que muestran los datos en gráficos y diagramas, y te permiten desglosarlos para ver los datos agrupados en diferentes dimensiones (como por proxy de API, dirección IP o código de estado HTTP).

También puede descargar datos analíticos mediante la API de Apigee. Una vez descargados, puede importar esos datos a sus propias herramientas de visualización de datos o a su sistema de analíticas.

Paneles de control de analíticas

La interfaz de usuario de Apigee proporciona un conjunto de paneles predefinidos que puede usar para ver datos analíticos.

Apigee en la consola de Cloud

Para abrir los paneles de control de Analytics (en organizaciones con la modalidad de pago por uso o de suscripción):

En la Google Cloud consola, ve a la página Métricas de la API > Analytics.

Ir a métricas de API

En la siguiente imagen se muestra el panel de control Rendimiento de los proxies de APIs:

Seleccione una de las siguientes pestañas para ver los paneles de control:

Para obtener más información, consulta el artículo Usar los paneles de control de analíticas.

Informes personalizados

Los informes personalizados le permiten desglosar métricas específicas de la API y ver los datos exactos que quiera. Puede crear un informe personalizado con cualquiera de los datos analíticos integrados en Apigee.

Cuando crea un informe personalizado, selecciona los datos que quiere ver (métricas), los agrupa de forma significativa (dimensiones) y, opcionalmente, limita los datos devueltos en función de características específicas de los datos (filtrado).

También puede definir el tipo de gráfico que se muestra en el informe personalizado (de columnas o de líneas). En las siguientes imágenes se muestran ejemplos de gráficos de transacciones por segundo agrupadas por proxy de API:

  • Columna: cada proxy de API se representa con una columna diferente:

    Gráfico de columnas personalizado

  • Línea: cada proxy de API se representa con una línea diferente.

    Gráfico de líneas personalizado

Para obtener más información, consulte el artículo Crear y gestionar informes personalizados.

API Analytics

Usa la API de Apigee para descargar datos analíticos. Por ejemplo, puedes usar la API para crear tus propias herramientas de visualización, que puedes insertar en portales o aplicaciones personalizadas.

A continuación, se muestra un ejemplo de llamada a la API para obtener datos analíticos de 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 devuelve lo siguiente:

  • La suma de las solicitudes (número de mensajes) por proxy de API
  • Durante un periodo de 24 horas
  • Agrupado por hora

El parámetro de consulta timeRange especifica el periodo en el siguiente formato:

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

Fíjate en el %20 antes de HH:MM. El parámetro timeRange requiere un espacio codificado como URL antes de HH:MM o un carácter +, como en el siguiente ejemplo: MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.

Para obtener más información, consulta Usar la API de métricas.

Exportar datos analíticos a Google Cloud Platform

Puede usar la API de Apigee para exportar todos los datos analíticos de un día completo de Apigee a su propio repositorio de datos, como Google Cloud Storage o BigQuery. Después, puede aprovechar las potentes funciones de consulta y aprendizaje automático que ofrecen Google Cloud BigQuery y TensorFlow para realizar su propio análisis de datos.

Para obtener más información, consulte Exportar datos de Analytics.

¿Cómo puedo compartir datos con desarrolladores de aplicaciones?

Si consideras a los desarrolladores de aplicaciones como tus clientes, querrás asegurarte de que tengan las herramientas y la información necesarias para sacar el máximo partido a tu API.

Las aplicaciones envían datos a través de proxies de API y, después, el análisis de los datos ayuda a los desarrolladores de aplicaciones a saber cómo funciona su aplicación.

Los desarrolladores de aplicaciones no solo se preocupan por la calidad de sus aplicaciones, sino que también tienen mucho interés en tus APIs. El portal para desarrolladores basado en Drupal incluye una página Rendimiento de la aplicación opcional diseñada para que los desarrolladores de aplicaciones puedan acceder a métricas importantes de sus aplicaciones. En esta página se proporciona información a los desarrolladores sobre lo siguiente:

  • Errores: ¿qué errores de la API se producen en mi aplicación?
  • Rendimiento: ¿la API es lenta? ¿Qué métodos de la API suelen ser lentos o lo son en este momento?
  • Disponibilidad: ¿la API está activa o inactiva?
  • Cuota: ¿tu API tiene una cuota? Como desarrollador de la aplicación, ¿cómo puedo saber si estoy cumpliendo la cuota?

Para obtener más información, consulta Monitor apps (Monitorizar aplicaciones) en la documentación de Drupal 8.

Además, puede compartir las analíticas con sus desarrolladores de las siguientes formas:

  • Crear informes personalizados y compartirlos con los desarrolladores de tu aplicación. Para obtener más información, consulta el artículo Crear y gestionar informes personalizados.
  • Usar las APIs de métricas para recoger datos durante un periodo más largo y compartirlos con los desarrolladores de aplicaciones sin conexión. Para obtener más información, consulta el artículo Usar la API de métricas.

¿Cómo puedo generar datos analíticos completos?

¿Qué entendemos por analíticas completas? Por ejemplo, puede crear un proxy de API y Apigee recogerá datos analíticos sobre ese proxy. Pero ¿qué ocurre con las métricas del desarrollador o la aplicación que ha llamado al proxy de API? Si Apigee no sabe quién ha hecho una llamada a una API, no puede recoger esos datos.

Para que Apigee pueda determinar qué desarrolladores y qué aplicaciones de desarrollador llaman a tus proxies de API, debes seguir algunos pasos. Aquí tienes una lista de esos pasos con enlaces a información más detallada:

  1. Crea uno o varios productos de API, que es una agrupación de proxies de API junto con un plan de servicio. Consulta Gestionar productos de API.
  2. Registrar desarrolladores de aplicaciones con Apigee. Consulta Registrar desarrolladores de aplicaciones.
  3. Registrar aplicaciones y gestionar las claves de API de tus desarrolladores. Consulta Registrar aplicaciones y gestionar claves de API.
  4. Añade políticas de seguridad a tus proxies de API que verifiquen las claves de API o los tokens de seguridad. Consulta los siguientes temas: Política VerifyAPIKey, Política OAuthV2 y Política VerifyJWT.

En los siguientes tutoriales se explican los pasos necesarios para ver las analíticas de desarrolladores y aplicaciones: Proteger una API con claves de API y Proteger una API con OAuth.

Requisitos de Apigee Hybrid

En esta sección se muestra información importante para los usuarios de Apigee Hybrid.

Compatibilidad con la residencia de datos

Las versiones anteriores de Apigee Hybrid no admiten Apigee API Analytics.

Otros requisitos

Más información