Gestionar el complemento Apigee API Analytics

Esta página se aplica a Apigee, pero no a Apigee Hybrid.

Consulta la documentación de Apigee Edge.

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. Para obtener más información sobre los tipos de datos que puede recoger y analizar con Apigee API Analytics, consulte el resumen de Apigee Analytics.

Si eres cliente de Apigee con la modalidad de pago por uso, Apigee API Analytics está disponible como complemento de pago. En este tema se describe cómo habilitar y gestionar el complemento Apigee API Analytics en entornos de pago por uso aptos. Para obtener más información sobre cómo usar los paneles de control de analíticas de la API de Apigee después de habilitar el complemento en tus entornos de Apigee, consulta el artículo Usar los paneles de control de analíticas.

Disponibilidad

Apigee API Analytics está disponible como función complementaria de pago que se gestiona para cada entorno de Apigee de tu implementación de Apigee. El complemento se puede habilitar en cualquier entorno Intermedio o Completo de Apigee. No puedes habilitar ni usar Apigee API Analytics en entornos Base. Para obtener más información sobre las funciones de los entornos de Apigee, consulta la comparación de tipos de entornos.

Roles y permisos necesarios

Para obtener los permisos que necesitas para gestionar el complemento Apigee API Analytics, pídele a tu administrador que te conceda el rol de gestión de identidades y accesos de administrador de entorno de Apigee (apigee.environment.admin) en el proyecto. Para obtener más información sobre cómo conceder roles, consulta el artículo Gestionar el acceso a proyectos, carpetas y organizaciones.

Este rol predefinido contiene los permisos necesarios para gestionar el complemento Apigee API Analytics. Para ver los permisos exactos que se necesitan, despliega la sección Permisos necesarios:

Permisos obligatorios

Para gestionar el complemento Apigee API Analytics, se necesitan los siguientes permisos:

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

También puedes obtener estos permisos con roles personalizados u otros roles predefinidos.

Habilitar el complemento Apigee API Analytics

Puedes habilitar el complemento Apigee API Analytics en un entorno de Apigee Intermedio o Completo mediante la interfaz de usuario de Apigee en la consola Google Cloud o mediante la API, tal como se describe en las siguientes secciones.

Consola de Apigee Google Cloud

Para habilitar el complemento Apigee API Analytics en la Google Cloud consola, sigue estos pasos:

  1. Abre la página Apigee en la consola.

    Ir a Apigee

  2. Selecciona el proyecto con la organización de pago por uso y los entornos que quieras gestionar.
  3. Selecciona Complementos > Analytics para abrir la página del complemento Analytics.
  4. En el panel Gestionar el complemento Apigee API Analytics, marca la casilla del entorno (o los entornos) en el que quieras habilitar el complemento.
  5. Haz clic en Habilitar seleccionadas.
  6. Cuando se haya completado la habilitación de los entornos seleccionados, el Estado del entorno mostrará Habilitado.
  7. Para ver los datos de analíticas de las APIs de Apigee, seleccione Analíticas > Métricas de API. Los datos analíticos pueden tardar hasta 10 minutos en mostrarse.

API de Apigee

Para habilitar el complemento Apigee API Analytics mediante la API de Apigee, introduce el siguiente comando: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":true}'

Donde:

  • ORG_NAME es el nombre de la organización de Apigee de pago por uso a la que quieres añadir Analytics en los entornos aptos.
  • ENV_NAME es el nombre del entorno de Apigee en el que quieres habilitar el complemento Apigee API Analytics.

Cuando se haya completado la habilitación, seleccione Analytics > API Metrics (Analíticas > Métricas de la API) para ver los datos de analíticas de la API de Apigee. Los datos analíticos pueden tardar hasta 10 minutos en mostrarse en la interfaz de usuario o en estar disponibles a través de una llamada a la API.

El proceso para habilitar el complemento Apigee API Analytics puede tardar hasta 15 minutos. Una vez habilitada, los datos analíticos del entorno se conservan durante 14 meses. Puedes acceder al historial de datos del entorno desde la página Métricas de la API de la consola siempre que el complemento esté habilitado.

La facturación por el uso del complemento Apigee API Analytics comienza cuando se habilita el complemento.

Inhabilitar el complemento Analíticas de la API de Apigee

Puedes inhabilitar el complemento Apigee API Analytics en un entorno de Apigee intermedio o completo mediante la interfaz de usuario de Apigee en la Google Cloud consola o mediante la API, tal como se describe en las siguientes secciones.

Si tienes habilitado el complemento Advanced API Security en el entorno, debes inhabilitarlo para poder inhabilitar el complemento Apigee API Analytics. Si el complemento Seguridad avanzada de APIs no está inhabilitado, se producirá un error en cualquier solicitud para inhabilitar Apigee API Analytics en el entorno. Si el complemento Advanced API Security está habilitado en tu entorno, se mostrará en la columna Otros complementos habilitados del panel Gestionar complemento Apigee API Analytics.

Para inhabilitar el complemento, consulta Inhabilitar el complemento Seguridad avanzada de las APIs.

Apigee en la consola de Cloud

Para inhabilitar el complemento Apigee API Analytics en la Google Cloud consola, sigue estos pasos:

  1. Abre la página Apigee en la consola.

    Ir a Apigee

  2. Selecciona el proyecto con la organización de pago por uso y los entornos que quieras gestionar.
  3. Selecciona Complementos > Analytics para abrir la página del complemento Analytics.
  4. En el panel Gestionar el complemento Apigee API Analytics, marca la casilla del entorno (o los entornos) en el que quieras inhabilitar el complemento.
  5. Haz clic en Inhabilitar seleccionado.
  6. Cuando se complete la inhabilitación, en la columna Estado se mostrará Inhabilitado en cada entorno.

API de Apigee

Para inhabilitar el complemento Apigee API Analytics mediante la API Apigee, introduce el siguiente comando: 

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":false}'

Donde:

  • ORG_NAME es el nombre de la organización de Apigee de pago por uso a la que quieres añadir Analytics en los entornos aptos.
  • ENV_NAME es el nombre del entorno de Apigee en el que quieres habilitar el complemento Apigee API Analytics.

Ver el estado del complemento Analíticas de la API de Apigee en un entorno

Puedes consultar el estado del complemento Apigee API Analytics en un entorno de Apigee Intermedio o Completo mediante la interfaz de usuario de Apigee en la consola Google Cloud o mediante la API, tal como se describe en las siguientes secciones.

Consola de Apigee Google Cloud

Para ver el estado del complemento Apigee API Analytics en un entorno mediante la consola de Google Cloud :

  1. Abre la página Apigee en la consola.

    Ir a Apigee

  2. Selecciona el proyecto con la organización de pago por uso y los entornos que quieras gestionar.
  3. Selecciona Complementos > Analytics para abrir la página del complemento Analytics.
  4. En el panel Gestionar el complemento Apigee API Analytics, se muestra una lista de entornos.
  5. En la columna de estado, puede ver si el complemento está Habilitado o Inhabilitado en cada entorno Intermedio o Completo. Los entornos base no muestran ninguno de los dos estados.

API de Apigee

Para ver el estado del complemento Apigee API Analytics en un entorno mediante la API de Apigee, introduce el siguiente comando: 

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json"

Donde:

  • ORG_NAME es el nombre de la organización de Apigee de pago por uso.
  • ENV_NAME es el nombre del entorno de Apigee.

La respuesta devuelve un objeto analyticsConfig que representa el estado actual del complemento.

Gestionar los datos de analíticas de la API de Apigee

Una vez que se habilita el complemento Apigee API Analytics 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 inhabilita el complemento Apigee API Analytics en un entorno, 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 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.