Surveiller une API

Cette page vous explique comment surveiller l'état des API dont vous êtes propriétaire, à l'aide des journaux et des métriques que Cloud Endpoints conserve automatiquement. Lorsque des utilisateurs adressent des requêtes à votre API, Endpoints enregistre des informations sur ces requêtes et sur les réponses renvoyées. Il 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

Vous devez déployer votre API et lui envoyer des requêtes, pour générer des journaux et des métriques à afficher. Si vous n'avez rien configuré pour le moment, consultez le guide de démarrage rapide de Cloud Endpoints.

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 correctement, accédez à la présentation de l'API :

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

    Accédez à la page Services Endpoints

  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.

Graphiques

En haut se trouvent des graphiques pour certaines métriques, vous permettant ainsi de repérer immédiatement les pics et les chutes d'activité. Vous pouvez alors réaliser les actions suivantes :

  • Dans le coin supérieur droit du premier graphique, utilisez 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. Chaque entrée de la liste déroulante comporte un point d'interrogation sur lequel vous pouvez placer votre pointeur pour afficher une description de la métrique affichée.

  • Dans le coin supérieur droit de l'aperçu, ajustez les graphiques en sélectionnant différentes périodes. Cette action permet de modifier la période appliquée aux valeurs affichées dans ces graphiques, modifiant également le niveau de précision des points.

Tableau 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 effectuer les actions suivantes :

  • Dans le coin supérieur droit du tableau, utilisez la liste déroulante Sélectionner des colonnes pour afficher les métriques qui vous intéressent et supprimer celles que vous ne voulez pas afficher. Les entrées ainsi affichées possèdent également le point d'interrogation sur lequel vous pouvez placer votre pointeur pour voir une description de celle-ci.

  • Dans le coin supérieur droit de la présentation, sélectionnez une période pour les valeurs de métriques de la table à 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, accédez à la page Explorateur de journaux dans la console Google Cloud pour consulter les journaux des requêtes et des réponses de l'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 Endpoints directement depuis la page de l'explorateur de journaux:

    1. Dans la console Google Cloud, accédez à la page Stackdriver > Logging:

      Accéder à la page "Explorateur de journaux"

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

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

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

  • Commencez à utiliser l'explorateur de journaux.

    Créez des requêtes pour spécifier l'ensemble des entrées de journal à afficher, par exemple pour obtenir toutes les requêtes dont la latence est supérieure à 300 millisecondes.

  • Configurez et gérez des récepteurs pour acheminer vos journaux vers des destinations compatibles. 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 afficher les métriques d'un projet client spécifique, les clients de l'API doivent envoyer une clé API lorsqu'ils effectuent une requête. Comme Endpoints utilise la clé API pour identifier le projet auquel l'application appelante est associée, la clé API doit avoir été créée dans le projet Google Cloud de l'utilisateur d'API. Pour savoir comment restreindre l'accès à votre API à l'aide d'une clé API, consultez la page Restreindre l'accès à l'API avec des clés API.

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 Endpoints > Services de votre projet.

    Accédez à la page Services Endpoints

  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é.

Alertes

Les métriques collectées par Endpoints sont également disponibles dans Cloud Monitoring, lequel vous permet de configurer des alertes sur la latence, le trafic et les erreurs. La saturation est le seul signal clé pour lequel vous ne pouvez pas configurer une alerte à l'aide des métriques Endpoints. Les métriques pour lesquelles vous avez besoin de surveiller la saturation dépendent de votre application. Consultez la liste des métriques disponibles dans Cloud Monitoring pour savoir quelles métriques vous pouvez utiliser pour configurer les alertes de saturation.

Pour configurer les alertes, procédez comme suit :

  1. Dans la console Google Cloud, sélectionnez le projet Google Cloud contenant l'API Endpoints surveillée qui est associée au compte.

    Accéder à Google Cloud Console

  2. À l'aide du volet de navigation, sélectionnez Surveillance.

  3. Créez une règle d'alerte afin de configurer des alertes pour les signaux clés à l'aide des éléments suivants:

    • Latence

      1. Dans Type de condition, saisissez Metric Threshold.
      2. Dans Type de ressource, saisissez Produced API.
      3. Saisissez Request latencies pour la métrique.
      4. Saisissez le seuil à partir duquel vous souhaitez déclencher une alerte, et suivez le reste du guide relatif aux alertes.

    • Trafic

      1. Dans Type de condition, saisissez Metric Threshold.
      2. Dans Type de ressource, saisissez Produced API.
      3. Saisissez Request count pour la métrique.
      4. Saisissez le seuil à partir duquel vous souhaitez déclencher une alerte, et suivez le reste du guide relatif aux alertes.

    • Erreurs

      1. Dans Type de condition, saisissez Metric Threshold.
      2. Dans Type de ressource, saisissez Produced API.
      3. Saisissez Request count pour la métrique.
      4. Pour la classe de code de réponse, saisissez 5xx.
      5. Saisissez le seuil à partir duquel vous souhaitez déclencher une alerte, et suivez le reste du guide relatif aux alertes.

Étape suivante