Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
Cette section compare API Monitoring à Edge Analytics. Bien que les fonctionnalités de surveillance des API et d'analyse Edge vous permettent toutes deux de collecter et d'afficher des données d'API, elles ont des objectifs différents:
- L'objectif de la surveillance des API est de s'assurer que vos API fonctionnent comme prévu. Pour ce faire, vous souhaitez consulter les données les plus récentes disponibles. API Monitoring fournit des données très proches du temps réel et vous permet de créer des alertes qui vous informent en cas de problème.
- L'objectif d'Edge Analytics est de comprendre le comportement à long terme de vos API, afin de vous assurer qu'elles répondent à vos exigences métier et, si nécessaire, de les modifier. À ces fins, il est moins important de consulter les données en temps réel. Par conséquent, les données Analytics sont légèrement retardées, mais généralement pas plus de 10 minutes.
Notez que les données de surveillance des API, qui sont principalement liées aux codes d'erreur et à la latence, constituent un petit sous-ensemble des données Analytics.
Différences entre les données de surveillance des API et les données Analytics
Cette section décrit quelques différences mineures entre les données collectées par Edge Analytics et celles des fonctions de surveillance des API. Étant donné que les fonctions de surveillance des API et Analytics utilisent des pipelines de données différents, vous pouvez constater de légères différences entre les rapports personnalisés générés par Monitoring et ceux générés par Analytics. Par exemple, vous pouvez constater des écarts dans les résultats signalés pour les erreurs de délai avant expiration, à la fois pour les délais avant expiration du backend (code d'état HTTP 504 sur la requête) et pour les délais avant expiration du client (code d'état HTTP 499). Ils peuvent apparaître avec le code d'état 200 dans les rapports personnalisés Analytics, mais avec le code d'état 504 ou 499 dans les rapports personnalisés de surveillance.Surveillance des API
API Monitoring fournit des insights en temps réel sur les performances des API, et vous aide à diagnostiquer et à résoudre rapidement les problèmes pour que vos API fonctionnent comme prévu.
API Monitoring vous permet d'effectuer les opérations suivantes :
- Augmentez la disponibilité des API et réduisez le délai moyen de diagnostic.
- Prendre des mesures appropriées en fonction des alertes contextuelles, avant que les consommateurs ne soient affectés.
- Utiliser les codes d'erreur Apigee pour accélérer le diagnostic
- Isoler rapidement les zones à problèmes pour diagnostiquer les erreurs et les problèmes de performances ou de latence ainsi que leur source
Analyse des API Edge
Edge API Analytics collecte et analyse les informations qui transitent par les API. API Analytics collecte des informations telles que:
- l'évolution du trafic de votre API au fil du temps ;
- Quelles sont vos applications les plus utilisées ?
- Quels sont vos meilleurs développeurs ?
- Quelles méthodes d'API sont les plus populaires ?
- Quand le temps de réponse de l'API est-il le plus rapide/lent ?
- Quelle zone géographique connaît le trafic d'API le plus important ?
Données collectées par l'API Analytics
API Analytics collecte et analyse un large éventail de données qui transitent par les API. Par exemple, lorsque votre API est déployée, Analytics enregistre en permanence le nombre de messages reçus, le nombre de développeurs, les temps de réponse, les erreurs, le nombre d'applications utilisées, la taille des requêtes et de nombreuses autres données.
Pour une bonne introduction aux métriques et à leur utilisation, consultez Utiliser les API de métriques pour mesurer les performances des programmes API. Pour obtenir la liste complète des métriques, consultez la documentation de référence sur les métriques, les dimensions et les filtres d'Analytics.
Collecter des métriques personnalisées
Vous pouvez également collecter des métriques personnalisées à l'aide de la règle StatisticsCollector. La stratégie StatisticsCollector peut écrire des informations provenant des en-têtes de requête, des charges utiles XML/JSON, des paramètres de requête, des URI et d'autres emplacements sur le serveur Analytics à des fins d'analyse et de génération de rapports.
Accéder aux données Analytics
Une fois générées, vous pouvez accéder aux métriques prédéfinies et aux métriques personnalisées à l'aide des outils de visualisation de l'API Analytics, y compris le tableau de bord, les rapports personnalisés et GeoMap. Pour en savoir plus sur les outils de visualisation fournis par API Analytics, consultez Tableaux de bord Analytics. Pour en savoir plus sur les rapports personnalisés, consultez Créer des rapports personnalisés.
Comparer API Monitoring et API Analytics
Les développeurs d'API utilisent à la fois la surveillance des API et l'API Analytics. L'une des principales différences entre les deux est le mécanisme d'alerte intégré à la surveillance des API. Les alertes permettent à votre équipe d'opérations de répondre aux problèmes liés à vos API en temps réel pour s'assurer qu'elles sont disponibles et fonctionnent comme prévu.
Les conditions d'alerte définissent un code d'état spécifique (2xx/4xx/5xx), la latence et les seuils de code d'erreur qui, lorsqu'une limite est dépassée, déclenchent des alertes visuelles dans l'interface utilisateur et envoient des notifications via plusieurs canaux, tels que les e-mails, Slack, PagerDuty ou les webhooks. Vous pouvez configurer des alertes au niveau de l'environnement, du proxy API, du service cible ou de la région.
Une fois une alerte déclenchée, votre équipe chargée des opérations peut utiliser l'interface utilisateur de l'API Monitoring pour examiner le problème et en identifier l'origine. Vous pouvez ensuite générer un rapport personnalisé qui inclut des informations prédéfinies sur l'alerte, par exemple:
- Temps de réponse total
- Temps de réponse cible
- Erreurs de proxy
- Erreurs de cible
- UUID de la requête
- et bien plus
Les API Analytics sont conçues pour capturer un large éventail de données à utiliser par plusieurs équipes. Exemple :
- L'équipe d'exploitation peut utiliser les données Analytics pour identifier les périodes de trafic élevé ou faible afin d'ajuster vos services en fonction des demandes changeantes.
- L'équipe marketing peut utiliser les données Analytics pour déterminer les habitudes d'utilisation des clients identifiées par des API, des applications, des clients ou d'autres données spécifiques.
- Toutes les équipes peuvent accéder aux données personnalisées collectées à partir d'une requête pour suivre des informations spécifiques telles que les valeurs d'en-tête, les paramètres de requête ou la charge utile de la requête.