Présentation de la surveillance des API

Cette page s'applique à Apigee et à Apigee hybrid.

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

En tant que client Apigee, vous pouvez également utiliser les outils de Cloud Monitoring pour prendre en charge la surveillance des API.

À propos de la conservation des données : les journaux d'API Monitoring capturent les données du paramètre de requête et de l'user-agent. Étant donné que ces données peuvent contenir des informations personnelles, elles sont conservées pendant 6 semaines, puis supprimées conformément aux règles de confidentialité de Google. Pour en savoir plus, consultez la section Conservation des données.

Utilisateurs d'Apigee hybrid : ne désactivez pas les métriques de votre configuration hybride si vous souhaitez afficher les données de surveillance des API. Les métriques doivent être activées dans votre configuration hybride pour que les données de surveillance des API s'affichent. Les métriques sont activées par défaut pour les environnements hybrides.

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 :

Remarque : Il existe une nouvelle version de l'interface utilisateur Apigee, intégrée à la console Google Cloud. La nouvelle interface utilisateur est appelée Apigee dans la console Cloud. Les instructions des deux premiers onglets ci-dessous expliquent comment utiliser Apigee dans la console Cloud ou la version classique d'Apigee.

Apigee dans la console Cloud

1. Connectez-vous à l'interface utilisateur Apigee dans la console Cloud.
2. Sélectionnez Développement du proxy > Surveillance des API.

Apigee classique

1. Connectez-vous à l'UI Apigee.

2. Sélectionnez l'une des vues suivantes :

   • Analyser > Surveillance des API > Chronologie
   • Analyser > API Monitoring > Examiner
   • Analyser > API Monitoring > Récent

La vue principale de l'API Monitoring s'affiche. Dans le menu Affichage, vous pouvez choisir l'une des vues suivantes :

• Timeline (Chronologie) : affiche les chronologies du trafic récent des API.
• Examen : affiche les tables des données de trafic des API, par exemple le code d'erreur par région.
• 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 :

• Échéances
• Examiner
• Récents