Vous consultez la documentation d'Apigee Edge.
Consultez la
documentation Apigee X. en savoir plus
Cette section compare la surveillance des API et Edge Analytics. Bien que la surveillance des API et Edge Analytics vous permettent tous deux de collecter et d'afficher les données d'API, ils ont des objectifs différents:
- L'objectif de la surveillance des API est de s'assurer que vos API sont opérationnelles comme prévu. À cet effet, vous souhaitez voir les données les plus récentes disponibles. La surveillance des API fournit des données quasiment en temps réel et vous permet de créer des alertes qui vous avertissent 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 aux exigences de votre entreprise ou d'apporter des modifications si nécessaire. À ces fins, il est moins important d'afficher des données en temps réel. Les données Analytics sont donc légèrement retardées, bien que ne dépassant pas 10 minutes en général.
Notez que les données de surveillance des API, principalement liées aux codes d'erreur et à la latence, constituent un petit sous-ensemble de données Analytics.
Différences entre les données de surveillance des API et les données Analytics
Cette section décrit certaines différences mineures entre les données collectées par Edge Analytics et la surveillance des API. Étant donné que l'API Monitoring 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 d'expiration de délai, qu'il s'agisse de délais avant expiration du backend (code d'état HTTP 504 sur la requête) et de délais avant expiration du client (code d'état HTTP 499). Celles-ci 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 Monitoring.Surveillance des API
La surveillance des API 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 continuent de fonctionner 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 (MTTD).
- Prenez les mesures appropriées en fonction des alertes contextuelles avant que les consommateurs ne soient touchés.
- Utilisez les codes d'erreur Apigee pour accélérer le diagnostic.
- Isolez rapidement les zones problématiques afin de diagnostiquer les problèmes d'erreur, de performances et 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 capture des informations telles que:
- Tendances du trafic de votre API au fil du temps
- Quelles sont tes applis préférées ?
- Qui 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/le plus lent ?
- Géographiquement, où voyez-vous le plus de trafic d'API
Données collectées par API Analytics
API Analytics collecte et analyse un large éventail de données qui transitent entre les API. Par exemple, pendant que 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 présentation des métriques et de leur utilisation, consultez Utiliser les API de métriques pour mesurer les performances du programme d'API. Pour obtenir la liste complète des métriques, voir Métriques, dimensions et filtres.
Collecter des métriques personnalisées
Vous pouvez également collecter des métriques personnalisées à l'aide de la stratégie StatisticsCollector. La règle StatisticsCollector peut écrire des informations à partir d'en-têtes de demande, de charges utiles XML/JSON, de paramètres de requête, d'URI et d'autres emplacements sur le serveur Analytics pour l'analyse et la génération de rapports.
Accéder aux données Analytics
Une fois générés, vous pouvez accéder aux métriques prédéfinies et personnalisées à l'aide des outils de visualisation d'API Analytics, y compris le tableau de bord, les rapports personnalisés et GeoMap. Pour plus d'informations sur les outils de visualisation fournis par API Analytics, voir Tableaux de bord Analytics. Pour plus d'informations sur les rapports personnalisés, voir Créer des rapports personnalisés.
Comparer la surveillance et l'analyse des API
Les développeurs d'API utilisent à la fois la surveillance et l'analyse des API. 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 opérationnelle de répondre aux problèmes liés à vos API en temps réel afin de garantir que celles-ci sont disponibles et fonctionnent comme prévu.
Les conditions d'alerte définissent des seuils de code d'état (2xx/4xx/5xx), de latence et de code d'erreur qui, lorsqu'ils sont dépassés, déclenchent des alertes visuelles dans l'interface utilisateur et envoient des notifications via divers 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.
Après le déclenchement d'une alerte, votre équipe chargée des opérations peut utiliser l'interface utilisateur de surveillance des API pour examiner le problème et en rechercher la cause. Vous pouvez ensuite générer un rapport personnalisé qui inclut des informations prédéfinies sur l'alerte, telles que:
- Temps de réponse total
- Temps de réponse cible
- Erreurs de proxy
- Erreurs de cible
- Demander un UUID
- et bien plus
API Analytics sont conçus pour capturer un large éventail de données à utiliser par plusieurs équipes. Exemple :
- Grâce aux données Analytics, l'équipe chargée des opérations peut identifier les périodes de trafic élevé ou faible afin d'adapter vos services en fonction de l'évolution de la demande.
- L'équipe marketing peut utiliser les données Analytics afin de déterminer les modèles d'utilisation des clients identifiés par chaque API, application, client ou d'autres données.
- Toutes les équipes peuvent accéder aux données personnalisées collectées à partir d'une demande 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.