Surveiller une API

Cette page explique comment surveiller l'état de vos API API Gateway à l'aide des journaux et des métriques qu'API Gateway gère automatiquement pour vous.

Lorsque vous créez une API, API Gateway crée automatiquement un service géré correspondant. Le nom du service géré créé figure dans la sortie de la commande suivante:

gcloud api-gateway apis describe API_ID

Le nom de votre service correspond à la valeur du champ managedService.

Lorsque des utilisateurs adressent des requêtes à votre API, API Gateway enregistre des informations sur ces requêtes et sur les réponses renvoyées. API Gateway suit également trois des quatre signaux clés de surveillance : la latence, le trafic et les erreurs. Ces métriques d'utilisation et de performances vous aident à surveiller l'API.

Avant de commencer

Pour générer des journaux et des métriques à afficher, déployez une API et lui envoyez des requêtes. Si vous n'avez pas encore créé et déployé d'API sur une passerelle, essayez le guide de démarrage rapide d'API Gateway.

Présentation de l'API

Lorsque vous corrigez un problème lié au service ou que vous souhaitez simplement vérifier que tout s'exécute comme prévu, accédez à la présentation de l'API :

  1. Dans la console Google Cloud, accédez à la page API Gateway > API de votre projet:

    Accéder aux API

  2. Si vous possédez plusieurs API, cliquez sur celle que vous souhaitez surveiller.

  3. Assurez-vous que vous êtes sur l'onglet Aperçu.

Graphes

La page "Présentation" fournit plusieurs graphiques pour certaines métriques, ce qui vous permet de repérer immédiatement les pics, les baisses ou toute activité inattendue. Les filtres en haut de la page vous permettent d'effectuer les opérations suivantes:

  • Utiliser la liste déroulante Sélectionner des graphiques pour afficher les graphiques des métriques qui vous intéressent et supprimer ceux que vous ne souhaitez pas afficher.
  • Ajustez la portée des graphiques en sélectionnant différentes périodes. Cette action permet de modifier la période appliquée aux valeurs affichées, modifiant également le niveau de précision des points.

Table des méthodes

Pour une exploration plus approfondie, consultez le tableau situé en dessous des graphiques contenant les métriques par méthode de votre API. Vous pouvez :

  • En haut à gauche du tableau, cliquez sur l'icône Filtrer le tableau pour sélectionner des options de requête de filtre affinées dans le tableau déroulant. Ajoutez OR entre chaque requête de filtre pour rechercher plusieurs termes.
  • En haut à droite du tableau, cliquez sur l'icône Options d'affichage des colonnes pour afficher une liste déroulante. Cochez les métriques qui vous intéressent et décochez celles que vous ne souhaitez pas afficher.
  • Dans le coin supérieur droit de l'aperçu, sélectionnez une période pour les valeurs de métriques du tableau à l'aide de l'outil de sélection de périodes. Cette sélection s'applique aux graphiques ainsi qu'au tableau.

Journaux

Lorsque vous repérez un problème dans les métriques, vous pouvez utiliser la page Explorateur de journaux de la console Google Cloud pour consulter les journaux des requêtes et des réponses de votre API.

  • Pour afficher les journaux par méthode de l'API, cliquez sur Afficher les journaux dans le tableau.

  • Pour afficher les journaux de toutes les méthodes de l'API, cliquez sur Afficher tous les journaux dans le coin inférieur droit.

  • Pour localiser les journaux d'API Gateway directement à partir de la page de l'explorateur de journaux, procédez comme suit :

    1. Dans la console Google Cloud, accédez à la page Explorateur de journaux.

      Accéder à l'explorateur de journaux

    2. Sélectionnez API produite, SERVICE_NAME, où SERVICE_NAME est le nom du service géré.

Pour en savoir plus sur la structure des journaux dans l'explorateur de journaux, consultez la documentation de référence des journaux d'API Gateway.

Découvrez tout ce que vous pouvez faire d'autre avec les journaux :

  • Commencez à utiliser l'explorateur de journaux.

    Utilisez le volet de requête pour spécifier l'ensemble des entrées de journal à afficher, par exemple l'obtention de toutes les requêtes dont la latence est supérieure à 300 millisecondes.

  • Configurez et gérez les récepteurs. Vous pouvez ainsi transférer les journaux vers BigQuery pour les analyser plus en détail, enregistrer les journaux bruts dans Cloud Storage, ou les envoyer aux sujets de messagerie Pub/Sub.

Filtrer selon un projet client spécifique

Pour filtrer les métriques pour un projet client spécifique, procédez comme suit :

  1. Obtenez le numéro du projet du client utilisant l'API. Si vous n'êtes pas autorisé à accéder au projet du client de l'API, demandez à une personne disposant des autorisations nécessaires d'obtenir le numéro de projet pour vous.

  2. Dans la console Google Cloud, accédez à la page API Gateway > API de votre projet.

    Accéder aux API

  3. Dans l'angle supérieur gauche de la page Présentation, saisissez le numéro du projet dans le champ Filtrer par numéro de projet.

  4. Cliquez sur Filtrer.

Les métriques de la page sont mises à jour pour correspondre au trafic provenant uniquement du projet indiqué.

Étape suivante