Surveiller l'utilisation des API

Cette page explique comment utiliser les métriques d'API pour suivre et analyser votre utilisation des API Google et des API Google Cloud.

Les API Google génèrent des métriques d'utilisation détaillées qui peuvent vous aider à :

  • suivre et analyser votre utilisation des API Google ;
  • surveiller les performances de vos applications et de vos API Google ;
  • détecter les problèmes entre vos applications et les API Google.

Ces métriques peuvent considérablement accélérer les délais de résolution des problèmes en cas de besoin, ou lorsque vous utilisez l'assistance technique de Google.

Les métriques produites par les API Google correspondent aux signaux standards que les ingénieurs en fiabilité des sites (SRE) de Google utilisent pour évaluer l'état d'un service. Ces métriques couvrent le nombre de requêtes, les taux d'erreur, les latences totales, les latences de backend, la taille des requêtes et la taille des réponses. Pour les définitions de métriques d'API, consultez la documentation Cloud Monitoring.

Vous pouvez afficher les métriques d'API à deux endroits : le tableau de bord des API et Cloud Monitoring. Les métriques que vous voyez sont spécifiques à votre projet et ne reflètent pas l'état général du service.

Utiliser le tableau de bord des API

Le moyen le plus simple d'afficher les métriques de l'API consiste à utiliser le tableau de bord des API de la console Google Cloud. Vous pouvez afficher un aperçu de l'ensemble de l'utilisation de votre API ou afficher le détail de votre utilisation pour une API spécifique.

Pour afficher un aperçu de votre utilisation de l'API, procédez comme suit :

  1. Accédez à la section API et services de la console Cloud. Le tableau de bord principal des API s'affiche par défaut. Sur cette page, vous pouvez voir toutes les API que vous avez actuellement activées pour votre projet, ainsi que des graphiques de présentation pour les métriques suivantes :

    • Trafic : nombre de requêtes par seconde adressées par votre projet aux API activées ou en rapport avec votre projet
    • Erreurs : pourcentage de requêtes adressées à des API activées ayant entraîné des erreurs
    • Latence médiane : latence médiane des requêtes adressées aux API activées, le cas échéant

Pour afficher les détails d'utilisation d'une API spécifique :

  1. Sélectionnez l'API à afficher dans la liste principale des API du tableau de bord des API. La page d'aperçu de l'API affiche un graphique de trafic plus détaillé avec une répartition par code de réponse.
  2. Pour des informations d'utilisation encore plus détaillées, sélectionnez Afficher les métriques. Par défaut, les graphiques prédéfinis suivants sont affichés, bien que d'autres soient disponibles :

    • Trafic par code de réponse
    • Erreurs par méthode API
    • Latence globale au 50e, 95e et 99e centile
    • Latence par méthode API (médiane)
  3. Si vous souhaitez ajouter d'autres graphiques, vous pouvez sélectionner d'autres graphiques prédéfinis dans le menu déroulant Sélectionner des graphiques.

Utiliser Cloud Monitoring

Si vous utilisez Cloud Monitoring, vous pouvez accéder à l'Explorateur de métriques afin d'approfondir l'analyse des données de métriques disponibles et obtenir un meilleur aperçu de votre utilisation de l'API. Cloud Monitoring accepte une grande variété de métriques que vous pouvez associer à des filtres et des agrégations pour créer de nouvelles vues pertinentes des performances de votre application. Par exemple, vous pouvez associer une métrique du nombre de requêtes avec un filtre sur la classe Code de réponse HTTP pour créer un tableau de bord indiquant les taux d'erreur au fil du temps, ou vous pouvez regarder la latence au 95e centile des requêtes adressées à l'API Cloud Pub/Sub.