Présentation de la surveillance des API

Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.

Après avoir créé et lancé vos API sur Apigee, vous devez vous assurer qu'elles sont disponibles et fonctionnent comme prévu afin d'éviter toute interruption de service. La fonctionnalité de surveillance des API d'Apigee vous permet de suivre vos API pour s'assurer qu'elles sont opérationnelles et fonctionnent correctement. API Monitoring fournit des insights quasiment en temps réel sur le trafic et les performances des API, afin de vous aider à diagnostiquer et à résoudre rapidement les problèmes à mesure qu'ils se produisent.

API Monitoring vous permet d'effectuer les opérations suivantes :

  • Créer des alertes pour être informé des modifications du trafic des API afin de prendre les mesures appropriées avant que les clients ne soient affectés
  • Augmenter la disponibilité des API et réduire le temps moyen de diagnostic en analysant rapidement les problèmes liés à vos API
  • Utiliser des codes d'erreur pour accélérer le diagnostic
  • Isoler rapidement les zones à problèmes pour diagnostiquer les problèmes d'erreur, de performances et de latence ainsi que leur source

Rôles de surveillance des API

Pour accéder à l'API Monitoring, vous devez disposer des rôles suivants :

  • roles/apigee.readOnlyAdmin
  • roles/monitoring.viewer

Consultez la section Rôles Apigee pour en savoir plus sur les rôles appropriés à l'utilisation d'API Monitoring.

Accéder à la surveillance des API

Pour accéder à la surveillance des API via l'interface utilisateur d'Apigee, procédez comme suit :

  1. Connectez-vous à l'UI Apigee.
  2. Basculez vers l'organisation que vous souhaitez surveiller.
  3. Sélectionnez Analyze > API Monitoring (Analyser > Surveillance des API). Le sous-menu affiche des liens vers les deux vues principales de l'UI, comme illustré ci-dessous.
    Sélectionnez la vue de l'UI.
    Pour accéder à l'UI, sélectionnez l'une des vues suivantes :
    • Timeline (Chronologie) : affiche les chronologies du trafic récent des API.
    • Investigate (Examen) : affiche les tables des données de trafic des API, par exemple le code d'erreur par région.
    • Recent (Récents) : affiche les cartes proportionnelles de données dans lesquelles chaque proxy est représenté par un rectangle, dont la taille est proportionnelle à la quantité de trafic d'API du proxy et dont la couleur désigne la taille relative des métriques associées.

Les sections suivantes décrivent ces vues en détail :