Gérer le module complémentaire Apigee API Analytics

Cette page s'applique à Apigee, mais pas à Apigee hybrid.

Consultez la documentation d' Apigee Edge.

Apigee API Analytics collecte et calcule une multitude d'informations qui transitent par des proxys d'API. Vous pouvez visualiser ces données à l'aide de graphiques et de charts dans l'UI Apigee ou télécharger les données brutes pour les analyser hors connexion à l'aide des API Apigee. Pour plus d'informations sur les types de données que vous pouvez collecter et analyser avec Apigee API Analytics, consultez la Présentation d'Apigee Analytics.

Si vous êtes un client Apigee facturé à l'usage, Apigee API Analytics est disponible en tant que module complémentaire payant. Cette rubrique explique comment activer et gérer le module complémentaire Apigee API Analytics pour les environnements avec paiement à l'usage éligibles. Pour plus d'informations sur l'utilisation des tableaux de bord Apigee API Analytics après l'activation du module complémentaire dans vos environnements Apigee, consultez la page Utiliser les tableaux de bord d'analyse.

Qui peut en bénéficier ?

Apigee API Analytics est disponible en tant que module complémentaire payant géré individuellement pour chaque environnement Apigee dans votre mise en œuvre Apigee. Le module complémentaire peut être activé dans n'importe quel environnement Apigee intermédiaire ou complet. Vous ne pouvez pas activer ou utiliser Apigee API Analytics dans les environnements de base. Pour en savoir plus sur les capacités de l'environnement Apigee, consultez la page Comparaison des types d'environnement.

Rôles et autorisations requis

Pour obtenir les autorisations nécessaires pour gérer le module complémentaire Apigee API Analytics, demandez à votre administrateur de vous accorder le rôle IAM "Administrateur d'environnement Apigee" (apigee.environment.admin) sur le projet. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

Ce rôle prédéfini contient les autorisations requises pour gérer le module complémentaire Apigee API Analytics. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour gérer le module complémentaire Apigee API Analytics :

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

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Activer le module complémentaire Apigee API Analytics

Vous pouvez activer le module complémentaire Apigee API Analytics pour un environnement Apigee intermédiaire ou complet en utilisant l'interface utilisateur Apigee dans la console Google Cloud ou l'API, comme décrit dans les sections suivantes.

Apigee dans la console Google Cloud

Pour activer le module complémentaire Apigee API Analytics dans la console Google Cloud, procédez comme suit :

  1. Ouvrez la page Apigee dans la console.

    Accéder à Apigee

  2. Sélectionnez le projet contenant l'organisation avec paiement à l'usage et les environnements que vous souhaitez gérer.
  3. Sélectionnez Modules complémentaires > Analytics pour ouvrir la page Module complémentaire Analytics.
  4. Dans le volet Gérer le module complémentaire Apigee API Analytics, cochez la case correspondant à ou aux environnements dans lesquels vous souhaitez activer le module complémentaire.
  5. Cliquez sur Activer la sélection.
  6. Une fois l'activation terminée pour les environnements sélectionnés, l'état de l'environnement s'affiche comme Activé.
  7. Pour afficher vos données Apigee API Analytics, sélectionnez Analytics > Métriques d'API pour afficher vos données d'analyse. L'affichage des données d'analyse peut prendre jusqu'à 10 minutes.

API Apigee

Pour activer le module complémentaire Apigee API Analytics en utilisant l'API Apigee, saisissez la commande suivante : 

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}'

Où :

  • ORG_NAME correspond au nom de l'organisation Apigee avec paiement à l'usage dans laquelle vous souhaitez ajouter Analytics aux environnements éligibles.
  • ENV_NAME correspond au nom de l'environnement Apigee dans lequel vous souhaitez activer le module complémentaire Apigee API Analytics.

Une fois l'activation terminée, sélectionnez Analytics > Métriques d'API pour afficher vos données Apigee API Analytics. L'affichage des données d'analyse dans l'interface utilisateur ou leur disponibilité via un appel d'API peuvent prendre jusqu'à 10 minutes.

Le processus d'activation du module complémentaire Apigee API Analytics peut prendre jusqu'à 15 minutes. Après l'activation, les données d'analyse de l'environnement sont conservées pendant 14 mois. Vous pouvez accéder aux données de l'historique de l'environnement à partir de la page Métriques de l'API de la console tant que le module complémentaire est activé.

La facturation de l'utilisation du module complémentaire Apigee API Analytics commence à l'activation du module complémentaire.

Désactiver le module complémentaire Apigee API Analytics

Vous pouvez désactiver le module complémentaire Apigee API Analytics pour un environnement Apigee intermédiaire ou complet en utilisant l'interface utilisateur Apigee dans la console Google Cloud ou en utilisant l'API, comme décrit dans les sections suivantes.

Si le module complémentaire Advanced API Security est activé dans l'environnement, vous devez le désactiver avant de pouvoir désactiver le module complémentaire Apigee API Analytics. Si le module complémentaire Advanced API Security n'est pas désactivé, toute requête de désactivation de Apigee API Analytics dans l'environnement échouera. Si le module complémentaire Advanced API Security est activé dans votre environnement, il s'affiche dans la colonne Autres modules complémentaires activés du panneau Gérer le module complémentaire Apigee API Analytics.

Pour désactiver le module complémentaire, consultez la section Désactiver le module complémentaire Advanced API Security.

Apigee dans la console Cloud

Pour désactiver le module complémentaire Apigee API Analytics dans la console Google Cloud, procédez comme suit :

  1. Ouvrez la page Apigee dans la console.

    Accéder à Apigee

  2. Sélectionnez le projet contenant l'organisation avec paiement à l'usage et les environnements que vous souhaitez gérer.
  3. Sélectionnez Modules complémentaires > Analytics pour ouvrir la page Module complémentaire Analytics.
  4. Dans le volet Gérer le module complémentaire Apigee API Analytics, cochez la case correspondant à ou aux environnements dans lesquels vous souhaitez désactiver le module complémentaire.
  5. Cliquez sur Désactiver la sélection.
  6. Après la désactivation, l'état s'affiche comme Désactivé pour chaque environnement.

API Apigee

Pour désactiver le module complémentaire Apigee API Analytics en utilisant l'API Apigee, saisissez la commande suivante : 

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}'

Où :

  • ORG_NAME correspond au nom de l'organisation Apigee avec paiement à l'usage dans laquelle vous souhaitez ajouter Analytics aux environnements éligibles.
  • ENV_NAME correspond au nom de l'environnement Apigee dans lequel vous souhaitez activer le module complémentaire Apigee API Analytics.

Afficher l'état du module complémentaire Apigee API Analytics dans un environnement

Vous pouvez vérifier l'état du module complémentaire Apigee API Analytics pour un environnement Apigee intermédiaire ou complet en utilisant l'interface utilisateur Apigee dans la console Google Cloud ou en utilisant l'API, comme décrit dans les sections suivantes.

Apigee dans la console Google Cloud

Pour afficher l'état du module complémentaire Apigee API Analytics dans un environnement en utilisant la console Google Cloud, procédez comme suit :

  1. Ouvrez la page Apigee dans la console.

    Accéder à Apigee

  2. Sélectionnez le projet contenant l'organisation avec paiement à l'usage et les environnements que vous souhaitez gérer.
  3. Sélectionnez Modules complémentaires > Analytics pour ouvrir la page Module complémentaire Analytics.
  4. Dans le volet Gérer le module complémentaire Apigee API Analytics, une liste d'environnements s'affiche.
  5. Dans la colonne d'état, vous pouvez voir si le module complémentaire est Activé ou Désactivé pour chaque environnement intermédiaire ou complet. Les environnements de base n'affichent aucun des deux états.

API Apigee

Pour afficher l'état du module complémentaire Apigee API Analytics dans un environnement en utilisant l'API Apigee, saisissez la commande suivante : 

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

Où :

  • ORG_NAME est le nom de l'organisation Apigee avec paiement à l'usage.
  • ENV_NAME est le nom de l'environnement Apigee.

La réponse renvoie un objet analyticsConfig représentant l'état actuel du module complémentaire.

Gérer vos données Apigee API Analytics

Une fois le module complémentaire Apigee API Analytics activé pour un environnement, les données d'analyse de l'environnement sont conservées pendant 14 mois. Vous pouvez accéder aux données analytiques de l'historique de l'environnement à partir de la page Métriques de l'API de la console tant que le module complémentaire est activé.

Si vous désactivez le module complémentaire Apigee API Analytics dans un environnement, les données d'analyse de l'environnement sont supprimées au bout de 30 jours. Si vous réactivez le module complémentaire dans le même environnement dans les 30 jours suivant sa désactivation, vous pouvez de nouveau accéder aux données analytiques de l'environnement pendant la période de conservation de 14 mois. Aucune donnée n'est restaurée si le module complémentaire est réactivé pour l'environnement après 30 jours.

Si vous souhaitez conserver les données d'analyse pour un environnement au-delà de la période de conservation de 14 mois, nous vous recommandons de les exporter et de les enregistrer dans un autre emplacement. Vous pouvez également exporter vos données Analytics avant de désactiver le module complémentaire Apigee API Analytics, ou dans le délai de 30 jours suivant la désactivation du module. Pour plus d'informations, consultez la section Exporter des données issues d'Analytics.