Esta página se aplica a Apigee, pero no a Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
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. Para obtener más información sobre los tipos de datos que puedes recopilar y analizar con las Estadísticas de la API de Apigee, consulta Descripción general de las Estadísticas de Apigee.
Si eres cliente de pago por uso, las Estadísticas de la API de Apigee están disponibles como un complemento pago. En este tema, se describe cómo habilitar y administrar el complemento de Apigee API Analytics para entornos de pago por uso que cumplen con los requisitos. Para obtener más información sobre el uso de los paneles de Apigee API Analytics después de habilitar el complemento en tus entornos de Apigee, consulta Usa los paneles de estadísticas.
Disponibilidad
Las Estadísticas de la API de Apigee están disponibles como una función complementaria de complemento paga que se administra para cada entorno de Apigee en tu implementación de Apigee. El complemento se puede habilitar en cualquier entorno intermedio o integral de Apigee. No puedes habilitar y usar las Estadísticas de la API de Apigee en entornos base. Para obtener más detalles sobre las funciones del entorno de Apigee, consulta Comparación de tipos de entornos.
Roles y permisos requeridos
Para obtener los permisos que
necesitas para administrar el complemento de Estadísticas de la API de Apigee,
pídele a tu administrador que te otorgue el rol de
administrador del entorno de Apigee (apigee.environment.admin)
de IAM en el proyecto.
Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
Este rol predefinido contiene los permisos necesarios para administrar el complemento de Apigee API Analytics. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:
Permisos necesarios
Se requieren los siguientes permisos para administrar el complemento de Apigee API Analytics:
-
apigee.addonsconfig.get -
apigee.addonsconfig.update
También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.
Habilita el complemento de Apigee API Analytics
Puedes habilitar el complemento de Apigee API Analytics para un entorno Intermedio o Integral de Apigee con la IU de Apigee en la consola de Google Cloud o con la API, como se describe en las siguientes secciones.
Apigee en la consola de Google Cloud
Para habilitar el complemento de Apigee API Analytics en la consola de Google Cloud , haz lo siguiente:
- Abre la página de Apigee en la consola.
- Selecciona el proyecto con la organización de pago por uso y los entornos que deseas administrar.
- Selecciona Complementos> Estadísticas para abrir la página complemento de estadísticas.
- En el panel Administrar el complemento de Apigee API Analytics, selecciona la casilla de verificación del entorno (o entornos) en el que deseas habilitar el complemento.
- Haz clic en habilitar los seleccionados.
- Cuando se complete la habilitación para los entornos seleccionados, el estado del entorno mostrará habilitado.
- Para ver los datos de Apigee API Analytics, selecciona Analytics > Métricas de la API para ver los datos de tus estadísticas. Los datos de estadísticas pueden tardar hasta 10 minutos en mostrarse.
API de Apigee
Para habilitar el complemento de Apigee API Analytics con la API de Apigee, ingresa 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}'En el ejemplo anterior, se ilustra lo siguiente:
- ORG_NAME es el nombre de la organización de pago por uso de Apigee en la que deseas agregar estadísticas a los entornos aptos.
- ENV_NAME es el nombre del entorno de Apigee en el que deseas habilitar el complemento de Estadísticas de la API de Apigee.
Cuando se complete la habilitación, selecciona Analytics > Métricas de la API para ver tus datos de Apigee API Analytics. Los datos de estadísticas pueden tardar hasta 10 minutos en mostrarse en la IU o en estar disponibles a través de una llamada a la API.
El proceso de habilitación del complemento de Apigee API Analytics puede tardar hasta 15 minutos. Una vez habilitado, los datos de estadísticas del entorno se conservan durante 14 meses. Puedes acceder a los datos históricos del entorno desde la página Métricas de la API en la consola, siempre y cuando el complemento esté habilitado.
La facturación por el uso del complemento de Apigee API Analytics comienza una vez que comienza la habilitación del complemento.
Inhabilita el complemento de Apigee API Analytics
Puedes inhabilitar el complemento Apigee API Analytics para un entorno Intermedio o Integral de Apigee mediante la IU de Apigee en la consola de Google Cloud o con la API, como se describe en las siguientes secciones.
Si tienes habilitado el complemento Advanced API Security en el entorno, debes inhabilitar el complemento Advanced API Security antes de inhabilitar el complemento Apigee API Analytics. Si el complemento Advanced API Security no está inhabilitado, fallará 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 Administrar complemento Apigee API Analytics.
Para inhabilitar el complemento, consulta Inhabilita el complemento Advanced API Security.
Apigee en la consola de Cloud
Para inhabilitar el complemento de Apigee API Analytics en la consola de Google Cloud , haz lo siguiente:
- Abre la página de Apigee en la consola.
- Selecciona el proyecto con la organización de pago por uso y los entornos que deseas administrar.
- Seleccionar Complementos> Estadísticas para abrir la página Complemento de Estadísticas.
- En el panel Administrar el complemento de Apigee API Analytics, selecciona la casilla de verificación del entorno (o entornos) en el que deseas inhabilitar el complemento.
- Haz clic en Inhabilitar los seleccionados.
- Cuando se complete la inhabilitación, el Estado mostrará Inhabilitado para cada entorno.
API de Apigee
Para inhabilitar el complemento de Estadísticas de la API de Apigee con la API de Apigee, ingresa 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}'En el ejemplo anterior, se ilustra lo siguiente:
- ORG_NAME es el nombre de la organización de pago por uso de Apigee en la que deseas agregar estadísticas a los entornos aptos.
- ENV_NAME es el nombre del entorno de Apigee en el que deseas habilitar el complemento de Estadísticas de la API de Apigee.
Visualiza el estado del complemento de Apigee API Analytics en un entorno
Puedes verificar el estado del complemento de Apigee API Analytics para un entorno de Apigee intermedio o integral mediante la IU de Apigee en la Google Cloud consola o mediante la API, como se describe en las siguientes secciones.
Apigee en la consola de Google Cloud
Para ver el estado del complemento de Apigee API Analytics en un entorno con la Google Cloud consola, sigue estos pasos:
- Abre la página de Apigee en la consola.
- Selecciona el proyecto con la organización de pago por uso y los entornos que deseas administrar.
- Selecciona Complementos> Estadísticas para abrir la página Complemento de Estadísticas.
- En el panel Administrar el complemento de Apigee API Analytics, se muestra una lista de entornos.
- En la columna de estado, puedes ver si el complemento está Habilitado o Inhabilitado en cada entorno Intermedio o Integral. Los entornos base no muestran ninguno de estos estados.
API de Apigee
Para ver el estado del complemento de Apigee API Analytics en un entorno con la API de Apigee, ingresa 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" En el ejemplo anterior, se ilustra lo siguiente:
- ORG_NAME es el nombre de la organización de pago por uso de Apigee.
- ENV_NAME es el nombre del entorno de Apigee.
La respuesta devuelve un objeto analyticsConfig que representa el estado actual del complemento.
Administra tus datos de Apigee API Analytics
Una vez que se habilita el complemento de Estadísticas de la API de Apigee para un entorno, los datos de estadísticas del entorno se conservan durante 14 meses. Puedes acceder a los datos 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 Apigee API Analytics en un entorno, 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 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 Analytics antes de inhabilitar el complemento de Apigee API Analytics 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.