Cette page s'applique à Apigee et à Apigee hybrid.
Consultez la documentation d'Apigee Edge.
Cette rubrique présente Apigee API Analytics.
Vidéo : Regardez une courte vidéo pour un aperçu des services d'Apigee API Monitoring.
Améliorer votre API grâce aux données d'analyse
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.
Analytics vous aide à répondre à des questions courantes, telles que :
- Quelles tendances le trafic de mon API affiche-t-il sur la durée ?
- Quelles méthodes d'API sont les plus populaires ?
- Qui sont mes meilleurs développeurs ?
- À quel moment le délai de réponse de l'API est-il le plus court ? Et le plus long ?
- Quelle zone géographique connaît le trafic d'API le plus important ?
- Quel est le montant des revenus générés par vos transactions ?
Vous pouvez analyser les données pour un nom d'hôte spécifique ou pour un environnement tout entier.
Les réponses à des questions telles que celles-ci vous aident à améliorer vos API, à résoudre les problèmes et à prendre de meilleures décisions commerciales concernant votre programme d'API.
API Analytics aide chacun à s'améliorer
Grâce à un processus continu de collecte, d'analyse et de visualisation des données, Apigee API Analytics aide votre équipe d'API à améliorer ses API et les développeurs d'applications à améliorer leurs applications :
- Équipe API - L'équipe API exploite les systèmes internes pour créer des API intéressantes. L'équipe API souhaite connaître l'état de santé du programme d'API global et des API individuelles, et comprendre comment améliorer leurs API.
- Développeurs d'applications - En partageant des données d'analyse avec les développeurs d'applications, vous obtenez de meilleures applications. Ces développeurs innovent grâce à votre API et développent des applications créatives permettant de générer des revenus pour votre entreprise. Analytics aide les développeurs d'applications à évaluer les performances de leurs applications et à quel point elles contribuent au résultat de votre entreprise. Les développeurs d'applications veulent savoir comment améliorer leurs applications.
- Équipe d'opérations - L'équipe chargée des opérations souhaite comprendre les schémas de trafic et prévoir à quel moment ajouter des ressources de backend ou effectuer d'autres ajustements critiques.
- Propriétaire d'entreprise - Le propriétaire d'entreprise souhaite savoir comment son investissement dans les API porte ses fruits et où investir son argent dans les API à l'avenir.
Comment débuter avec Apigee API Analytics ?
Le type d'organisation Apigee que vous utilisez détermine les étapes requises pour commencer à utiliser Apigee API Analytics. Si vous ne savez pas si vous utilisez une organisation Apigee avec abonnement ou en paiement à l'usage, contactez l'administrateur de votre organisation Apigee.
Utiliser Apigee API Analytics avec une organisation par abonnement
Si vous êtes client Apigee avec abonnement, l'accès à Apigee API Analytics est inclus dans vos droits d'abonnement et activé automatiquement pour chacun de vos environnements Apigee.
Vous pouvez accéder aux données d'analyse de votre organisation avec abonnement à l'aide de l'interface utilisateur Apigee, de l'interface utilisateur Apigee dans la console Cloud ou de l'API Apigee. Pour en savoir plus, consultez Comment accéder à mes données d'analyse.
Utiliser Apigee API Analytics avec une organisation facturée à l'usage
Si vous êtes un client Pay-as-you-go, vous devez activer Apigee API Analytics en tant que module complémentaire payant pour commencer à utiliser les données d'analyse. Pour en savoir plus sur l'activation du module complémentaire Apigee API Analytics pour vos environnements Apigee intermédiaires ou complets, consultez la page Gérer le module complémentaire Apigee API Analytics.
Une fois le module complémentaire Apigee API Analytics activé dans vos environnements, vous pouvez accéder à vos données d'analyse et gérer votre module complémentaire Apigee API Analytics à l'aide de l'interface utilisateur Apigee dans la console Cloud ou d'Apigee. API. Pour en savoir plus, consultez Comment accéder à mes données d'analyse. Les données d'analyse et la gestion des modules complémentaires ne sont pas disponibles dans l'UI classique d'Apigee pour les organisations avec paiement à l'usage.
Quels types de données sont collectés et analysés ?
Apigee API Analytics collecte et analyse un large éventail de données qui transitent par des proxys d'API tels que :
- Temps de réponse
- Latence de la requête
- Taille d'une requête
- Erreurs de cible
- Nom du produit d'API
- Adresse e-mail du développeur ou ID de l'AppGroup
- Nom de l'application
- Revenus des transactions
Pour obtenir la liste complète des données collectées par API Analytics, consultez la documentation de référence sur les métriques, les dimensions et les filtres d'Analytics.
Comment puis-je collecter des données d'analyse personnalisées ?
Apigee collecte une grande quantité de données de manière native. Vous pouvez également recueillir des données analytiques personnalisées spécifiques à vos proxys d'API, vos applications, vos produits ou vos développeurs. Par exemple, vous pouvez collecter des données analytiques à partir des paramètres de requête, des en-têtes de requête, du corps des requête et des réponses, ou encore de variables que vous définissez dans vos API.
Vous pouvez collecter des données analytiques personnalisées avec la règle DataCapture, puis utiliser l'interface utilisateur ou l'API Analytics pour examiner les données collectées.
Quand et pendant combien de temps mes données d'analyse sont-elles disponibles ?
Deux intervalles de temps sont utilisés pour contrôler le moment et la durée d'affichage des données d'analyse :
- Intervalle de délai entre les données - Une fois qu'un appel a été passé vers un proxy d'API, l'accès aux données par l'affichage ou via des appels d'API peut prendre jusqu'à 10 minutes.
- Disponibilité des données analytiques : la durée pendant laquelle les données analytiques (y compris les données de monétisation et Sense, le cas échéant) sont mises à disposition par Apigee diffère selon le forfait. Selon votre forfait, les données analytiques peuvent être disponibles pour les 30 derniers jours, les 90 derniers jours ou les 14 derniers mois.
Conservation des données analytiques lors de l'utilisation du module complémentaire Apigee API Analytics
Si vous votre organisation est facturée à l'usage, vous pouvez activer le module complémentaire Apigee API Analytics au niveau de l'environnement. Une fois le module complémentaire activé pour un environnement, les données analytiques 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 pour un environnement d'une organisation facturée à l'usage, les données analytiques 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 analytiques d'un environnement dans une organisation facturée à l'usage au-delà de la période de conservation de 14 mois, nous vous recommandons d'exporter et d'enregistrer vos données dans un autre emplacement. Vous pouvez également exporter vos données analytiques avant de désactiver le module complémentaire Apigee API Analytics, ou dans le délai de 30 jours suivant la désactivation. Pour plus d'informations, consultez la section Exporter des données issues d'Analytics.
Où mes données d'analyse sont-elles stockées et traitées ?
L'emplacement de stockage et de traitement de vos données d'analyse est déterminé par la région d'analyse que vous avez spécifiée lors de l'installation d'Apigee :
- Si vous êtes abonné et avez installé Apigee à l'aide de l'assistant de provisionnement Apigee, vous avez spécifié votre région d'analyse à l'étape 1 Créer une organisation, lorsque vous avez défini la région d'hébergement Analytics
- Si vous êtes un client facturé à l'usage et que vous avez installé Apigee à l'aide de la console Google Cloud, vous avez spécifié votre région d'analyse à l'étape 3 Créer une organisation, lorsque vous avez défini la région d'hébergement Analytics.
- Si vous avez installé Apigee à partir de la ligne de commande en tant que client avec abonnement ou paiement à l'usage, vous avez spécifié votre région d'analyse lorsque vous avez défini la variable d'environnement
ANALYTICS_REGION.
Les données d'analyse sont stockées et traitées comme suit :
- Pour les régions d'analyse qui ne se trouvent pas aux États-Unis ni dans l'UE, les données d'analyse sont stockées et traitées dans la région d'analyse.
- Pour les régions d'analyse situées aux États-Unis ou dans l'UE, les données sont stockées dans l'emplacement multirégional US ou EU, respectivement, pour une disponibilité plus élevée.
Comment accéder à mes données d'analyse ?
Apigee API Analytics fournit des outils de visualisation des données intégrés à l'interface utilisateur Apigee. Ces outils incluent des tableaux de bord d'analyse prédéfinis et des rapports personnalisés qui affichent des données sous forme de graphiques et de charts. Ils vous permettent d'afficher les données regroupées en différentes dimensions (par exemple, par proxy d'API, adresse IP ou code d'état HTTP).
Vous pouvez également télécharger des données analytiques à l'aide de l'API Apigee. Une fois les données téléchargées, vous pouvez les importer dans vos propres outils de visualisation de données ou votre propre système d'analyse.
Tableaux de bord Analytics
L'UI Apigee fournit un ensemble de tableaux de bord prédéfinis que vous pouvez utiliser pour afficher les données analytiques.
Apigee dans la console Cloud
Pour ouvrir les tableaux de bord Analytics (pour le paiement à l'usage ou les organisations avec abonnement), procédez comme suit :
- Ouvrez l'interface utilisateur d'Apigee dans la console Cloud dans un navigateur.
- Sélectionnez Analytics > Métriques de l'API.
Sélectionnez l'un des onglets présents à l'écran pour afficher les tableaux de bord correspondants :
- Performances des proxys d'API
- Analyse des codes d'erreur
- Analyse de la latence
- Performances des caches
- Performances des cibles
Pour plus d'informations, consultez la section Utiliser les tableaux de bord Analytics.
Apigee classique
Pour ouvrir les tableaux de bord Analytics (uniquement pour les organisations avec abonnement), procédez comme suit :
- Ouvrez l'interface utilisateur Apigee dans un navigateur.
- Sélectionnez Analyser > Métriques de l'API.
- Sélectionnez l'un des tableaux de bord suivants :
Outre ces tableaux de bord, vous pouvez également exploiter ceux ci-après :
- Sous Analyser > Développeurs :
- Sous Analyser > Utilisateurs finaux :
Pour plus d'informations, consultez la section Utiliser les tableaux de bord Analytics.
Rapports personnalisés
Les rapports personnalisés vous permettent d'explorer des métriques d'API spécifiques et d'afficher les données exactes que vous souhaitez voir. Vous pouvez créer un rapport personnalisé en utilisant n'importe quelles données d'analyse intégrées à Apigee.
Lors de la création d'un rapport personnalisé, vous sélectionnez les données que vous souhaitez afficher (métriques), vous les regroupez de manière significative (dimensions) et vous limitez éventuellement les données renvoyées en fonction de caractéristiques spécifiques des données (filtrage).
Vous pouvez également définir le type de graphique affiché dans le rapport personnalisé sous forme de graphique à colonnes ou en courbes. Les images suivantes illustrent des exemples de graphique pour les transactions par seconde regroupées par proxy d'API :
Colonne - Chaque proxy d'API est représenté par une colonne différente :
Ligne - Chaque proxy d'API est représenté par une ligne différente :
Pour plus d'informations, consultez la page Créer et gérer des rapports personnalisés.
API Analytics
Utilisez l'API Apigee pour télécharger des données analytiques. Par exemple, vous pouvez utiliser l'API pour créer vos propres outils de visualisation, que vous pouvez ensuite intégrer à des portails ou à des applications personnalisées.
Voici un exemple d'appel d'API permettant de récupérer des données d'analyse pour les proxys d'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"
Cet appel renvoie :
- La somme des requêtes (nombre de messages) par proxy d'API
- Pendant une période de 24 heures
- Regroupées par heure
Le paramètre de requête timeRange spécifie la période sous la forme suivante :
?timeRange=MM/DD/YYYY%20HH:MM~MM/DD/YYYY%20HH:MM
Notez le caractère %20 figurant avant HH:MM. Le paramètre timeRange requiert un caractère d'espace encodé au format URL avant HH:MM ou un caractère +, comme dans cet exemple : MM/DD/YYYY+HH:MM~MM/DD/YYYY+HH:MM.
Pour en savoir plus, consultez la section Utiliser l'API de métriques.
Exporter des données d'analyse vers Google Cloud Platform
Vous pouvez utiliser l'API Apigee pour exporter l'ensemble des données d'analyse d'une journée entière depuis Apigee vers votre propre dépôt de données, tel que Google Cloud Storage ou BigQuery. Vous pouvez ensuite exploiter les puissantes fonctionnalités d'interrogation et de machine learning offertes par Google Cloud BigQuery et TensorFlow pour effectuer votre propre analyse de données.
Pour plus d'informations, consultez la section Exporter des données issues d'Analytics.
Comment partager des données avec les développeurs d'applications ?
Lorsque vous considérez les développeurs d'applications comme des clients, vous devez vous assurer qu'ils disposent des outils et des informations nécessaires pour exploiter au mieux votre API.
Les développeurs d'applications ne s'intéressent pas seulement à la qualité de leurs applications, mais aussi à vos API. Le portail de développeurs basés sur Drupal inclut une page Performances des applications facultative, conçue pour permettre aux développeurs d'accéder aux métriques importantes associées à leurs applications. Cette page fournit aux développeurs des informations sur les éléments suivants :
- Erreurs : Quelles erreurs API mon application voit-elle ?
- Performances : L'API est-elle lente ? Quelles méthodes API sont généralement lentes ou sont actuellement lentes ?
- Disponibilité : L'API est-elle disponible ou indisponible ?
- Quota : Votre API a-t-elle un quota ? En tant que développeur d'applications, où est-ce que je me situe par rapport à mon quota ?
Pour en savoir plus, consultez la page Surveiller des applications dans la documentation de Drupal 8.
En outre, vous pouvez partager des analyses avec vos développeurs comme suit :
- Créer des rapports personnalisés et les partager avec vos développeurs d'applications. Pour plus d'informations, consultez la page Créer et gérer des rapports personnalisés.
- Utiliser les API de métriques pour capturer des données sur une période plus longue et partager ces données avec des développeurs d'applications hors connexion. Pour en savoir plus, consultez la section Utiliser l'API de métriques.
Comment générer des données d'analyse complètes ?
Qu'entendons-nous par "données d'analyse complètes" ? Vous pouvez, par exemple, créer un proxy d'API au sujet duquel Apigee collectera des données d'analyse. Mais qu'advient-il des métriques pour le développeur ou l'application qui a appelé le proxy d'API ? Si Apigee ne sait pas qui a passé un appel d'API, il ne peut pas collecter ces données.
Quelques étapes sont nécessaires pour permettre à Apigee de déterminer quels développeurs et quelles applications appellent vos proxys d'API. Voici une liste de ces étapes, accompagnées de liens vers des informations plus détaillées :
- Créer un ou plusieurs produits API, regroupant des proxys d'API et un forfait. Voir Gérer des produits API.
- Enregistrer des développeurs d'applications avec Apigee. Consultez la section Enregistrer des développeurs d'applications.
- Enregistrer des applications et gérer des clés API pour vos développeurs. Consultez la page Enregistrer des applications et gérer les clés API.
- Ajouter à vos proxy d'API des règles de sécurité qui vérifient les clés API et/ou les jetons de sécurité. Consultez les rubriques suivantes : Règle VerifyAPIKey, Règle OAuthV2 et Règle VerifyJWT.
Les tutoriels suivants vous guident tout au long des étapes nécessaires pour visualiser les analyses destinées aux développeurs et aux applications : Sécuriser une API en exigeant des clés API et Sécuriser une API avec OAuth.
Configuration requise pour Apigee Hybrid
Cette section présente des informations importantes pour les utilisateurs d'Apigee Hybrid.
Compatibilité avec la résidence des données
- Si vous venez de créer une organisation Apigee hybrid v1.13.1 avec la résidence des données activée, suivez la procédure décrite dans Utiliser la résidence des données avec Apigee hybrid.
- Les horloges de tous les nœuds de synchronisateurs doivent être synchronisées et à l'heure UTC.
Les anciennes versions d'Apigee hybrid ne sont pas compatibles avec Apigee API Analytics.
Autres conditions requises
- Vous devez avoir configuré le compte de service
apigee-udca. Consultez la section Spécifier des remplacements de configuration. - Les horloges de tous les nœuds de synchronisateurs doivent être synchronisées et à l'heure UTC.
En savoir plus
- Utiliser les tableaux de bord Analytics
- Créer et gérer des rapports personnalisés
- Utiliser l'API de métriques