Surveillance de Google Maps Platform

Cloud Monitoring collecte des métriques sur vos API et services, et sur les ressources Google Cloud Platform que vous utilisez. Cet article explique comment configurer Cloud Monitoring, surveiller l'utilisation des API, et créer des tableaux de bord et des alertes grâce à cet outil.

Cloud Monitoring inclut de nombreuses fonctionnalités et options. Cet article présente Cloud Monitoring et fournit des exemples de base. Pour plus d'informations sur toutes les fonctionnalités, y compris de nombreux autres exemples, consultez la documentation Cloud Monitoring.

Configurer Cloud Monitoring

Monitoring vous permet d'afficher et de gérer les métriques :

  • pour un seul projet ;
  • pour plusieurs projets d'une même organisation ;
  • pour plusieurs projets dans plusieurs organisations.

Pour vous assurer que les métriques de vos projets sont disponibles, procédez comme suit :

  1. Dans Google Cloud Console, sélectionnez Monitoring :

    Accéder à Monitoring

  2. Assurez-vous d'avoir sélectionné le projet concerné.
  3. Dans le volet de navigation "Monitoring", cliquez sur > à droite de Champ d'application des métriques. La capture d'écran ci-dessous montre la page qui s'affiche lorsque le projet "AllEnvironments" est sélectionné :

    Capture d'écran des métriques surveillées pour le projet (chaque projet est listé, ainsi que son ID et son rôle)

Le tableau intitulé Métriques surveillées par ce projet liste les projets dont les métriques sont accessibles avec le champ d'application actuel des métriques. Chaque ligne du tableau spécifie un projet et son rôle :

  • Projet effectuant une surveillance : ce projet stocke les tests de disponibilité, les règles d'alerte, les groupes et les tableaux de bord que vous configurez. Il existe une relation 1:1 entre un champ d'application des métriques et un projet effectuant une surveillance. Dans cet exemple, "AllEnvironments" est le projet effectuant une surveillance.
  • Projet surveillé : les métriques du projet sont visibles avec le champ d'application actuel des métriques. Dans cet exemple, "Staging" et "Production" sont des projets surveillés.

Le tableau intitulé Les métriques de ce projet sont visibles dans les projets répertoriés ci-dessous liste les projets dont le champ d'application des métriques inclut le projet actuel. La capture d'écran précédente montre qu'aucun autre projet ne peut accéder aux métriques stockées par le projet "AllEnvironments".

Pour plus d'informations, y compris sur la façon d'ajouter et de supprimer des projets, consultez Configurer Cloud Monitoring.

Explorer les métriques

Pour explorer les données de métriques, créez un graphique à l'aide de l'explorateur de métriques inclus dans Cloud Monitoring. Par exemple, pour consulter l'utilisation du quota d'une API, accédez à l'explorateur de métriques et créez un graphique affichant les données les plus récentes.

L'image ci-dessous montre un graphique détaillant l'utilisation des quotas pour les API Google Maps :

Capture d'écran des données de métriques concernant les quotas pour toutes les API Google Maps. Elle affiche un graphique à barres, où chaque segment de la barre correspond à une API différente.

Cet exemple montre un graphique à barres empilées dans lequel chaque API est représentée par une section de la barre. Vous pouvez créer différents types de graphiques (en courbes, à barres, heat maps, etc.). Vous pouvez également créer un graphique unique affichant jusqu'à 10 métriques différentes.

Dans cette image :

  • Les champs Type de ressource et Métrique situés à gauche du graphique définissent les données de métriques affichées dans le graphique.
  • Au-dessus du graphique, un menu déroulant permet de sélectionner le type de graphique. Dans cet exemple, il s'agit d'un graphique à barres empilées.
  • L'intervalle de temps au-dessus du graphique est défini sur 1S (une semaine).
  • Sous le graphique se trouve la liste des paramètres qui définissent les données du graphique : service, quota_metrics, method (méthode de l'API) et value (valeur de la métrique). Sélectionnez Ajouter un filtre afin d'affiner les données affichées grâce à ces informations.

Lorsque vous quittez la page de l'explorateur de métriques, le graphique est supprimé. Vous n'avez donc aucun artefact indésirable à supprimer. Vous pouvez aussi enregistrer le graphique dans un tableau de bord personnalisé ou le partager. Pour savoir comment ajouter un graphique à un tableau de bord, consultez Créer des tableaux de bord ci-dessous.

Représenter une seule métrique sous forme graphique

Pour configurer un graphique à l'aide de l'explorateur de métriques, procédez comme suit :

  1. Dans Cloud Console, sélectionnez Monitoring :

    Accéder à Monitoring

  2. Dans le volet de navigation, sélectionnez Explorateur de métriques.
  3. Sélectionnez Graphique à barres empilées dans la liste déroulante "Type de graphique" pour afficher les données de métriques sous forme de graphique à barres.
  4. Sélectionnez un intervalle de temps, comme 1S (une semaine).
  5. Spécifiez les données que vous souhaitez afficher dans le graphique. Pour utiliser une interface basée sur un menu ou définir un filtre, sélectionnez l'onglet Configuration. Pour utiliser le langage MQL (Monitoring Query Language), sélectionnez l'onglet MQL.
    1. Pour représenter l'utilisation du quota sous forme graphique, sélectionnez Quota du consommateur comme type de ressource. Si vous souhaitez plutôt créer une métrique sur l'utilisation de l'API, sélectionnez API Consumed. Pointez sur chaque type de ressource pour afficher sa description.
    2. Pour le champ Métrique, sélectionnez Utilisation du quota de débit. Le graphique est automatiquement mis à jour pour afficher les données de métriques. Notez qu'il existe d'autres options de quota pour la métrique. Pointez sur chaque métrique pour afficher sa description. Pour en savoir plus sur les champs de l'explorateur de métriques, consultez Sélectionner des métriques et Choisir le mode d'affichage des données représentées graphiquement.
  6. (Facultatif) Utilisez les options suivantes pour affiner l'affichage :
    1. Pour spécifier un sous-ensemble de données à afficher, ajoutez des filtres. Pour ajouter un filtre, sélectionnez Ajouter un filtre et remplissez les champs de la boîte de dialogue. Pour en savoir plus, consultez Filtrer les données représentées graphiquement. Par exemple, pour afficher les données d'une seule API :
      1. Dans le champ Libellé, sélectionnez méthode.
      2. Dans le champ Comparaison, sélectionnez = (Est égal(e) à).
      3. Dans le champ Valeur, sélectionnez le nom d'une méthode spécifique. Vous êtes invité à sélectionner le nom d'une méthode avec les données à afficher.
      4. Sélectionnez OK pour modifier le graphique.
    2. Pour regrouper des séries temporelles par libellé, utilisez le champ Grouper par. Lorsque vous choisissez une valeur pour ce champ, une valeur est automatiquement sélectionnée pour le champ Agrégateur.
    3. Pour indiquer comment combiner les séries temporelles, définissez le champ Agrégateur. Par exemple, si le champ Grouper par est vide et que le champ Agrégateur est défini sur une moyenne, le graphique affiche la moyenne de la série temporelle.
    4. Pour configurer le traitement d'une série temporelle individuelle, sélectionnez Options avancées. Pour en savoir plus, consultez Sélectionner des métriques lors de l'utilisation de l'explorateur de métriques.
  7. Si vous le souhaitez, ajoutez le graphique à un tableau de bord.

    Lorsque vous quittez la page Explorateur de métriques, le graphique est supprimé. Vous pouvez éventuellement sélectionner Enregistrer le graphique pour l'ajouter à un tableau de bord existant ou nouveau. Pour savoir comment ajouter un graphique à un tableau de bord, consultez Créer des tableaux de bord ci-dessous.

Représenter plusieurs métriques sous forme graphique

Vous pouvez avoir besoin d'inclure plusieurs métriques sur un même graphique (par exemple, pour afficher simultanément la limite et l'utilisation du quota). Notez qu'un graphique peut afficher jusqu'à 10 métriques.

Pour ajouter une métrique à un graphique existant, procédez comme suit :

  1. Dans le graphique existant, sélectionnez Ajouter une métrique en bas de l'écran.
  2. Sélectionnez la métrique souhaitée, puis indiquez comment afficher la série temporelle pour cette métrique (comme vous l'avez fait pour configurer la métrique d'origine ci-dessus).

Pour en savoir plus sur l'exploration des métriques, consultez les pages suivantes :

Créer des tableaux de bord

Les tableaux de bord vous permettent de visualiser et de surveiller les données de vos séries temporelles sous la forme d'un ensemble de graphiques. Cloud Monitoring permet de créer des tableaux de bord prédéfinis ou personnalisés :

  • Les tableaux de bord prédéfinis sont installés automatiquement pour les services Google Cloud Platform que vous utilisez et ne sont pas configurables.
  • Les tableaux de bord personnalisés sont ceux que vous créez. Ils vous permettent de définir les données que vous souhaitez consulter et leur mode d'affichage. Par exemple, vous pouvez afficher les données de métriques, les règles d'alerte et les journaux stockés dans votre projet. Vous pouvez afficher les données de séries temporelles sur un graphique, avec une jauge ou un tableau de données, ou sous forme de tableau.

Pour créer des tableaux de bord personnalisés, vous pouvez utiliser Cloud Console ou l'API Cloud Monitoring. L'image ci-dessous illustre un tableau de bord personnalisé comportant deux graphiques :

  • Un graphique sur les quotas (à gauche)
  • Un graphique sur le nombre de requêtes API (à droite)

Capture d'écran d'un tableau de bord personnalisé affichant deux graphiques. Le graphique de gauche porte sur les quotas, tandis que celui de droite illustre l'utilisation de l'API.
  Les deux graphiques présentent les points temporels sur leur axe horizontal.

Pour générer un tableau de bord personnalisé, créez des graphiques de métriques, puis ajoutez-les au tableau de bord. Vous pouvez créer le graphique dans l'explorateur de métriques, puis l'ajouter à un tableau de bord nouveau ou existant. Vous pouvez aussi créer le tableau de bord, puis le modifier pour ajouter un graphique.

Si vous choisissez de gérer les tableaux de bord personnalisés à l'aide de l'API Cloud Monitoring, l'explorateur de métriques propose deux utilitaires intéressants :

  • Pour générer la représentation JSON d'un graphique que vous prévoyez d'ajouter à un tableau de bord, configurez le graphique avec l'explorateur de métriques. Vous pouvez ensuite accéder à la représentation JSON depuis l'élément de menu Plus d'options, dans la barre d'outils de l'explorateur de métriques.
  • Pour identifier la syntaxe d'un filtre Monitoring utilisé avec l'API Cloud Monitoring, configurez le graphique à l'aide de l'interface de l'explorateur de métriques, basée sur un menu. Après avoir sélectionné la métrique et les filtres, passez en mode de filtrage direct pour afficher le filtre Monitoring équivalent.

Créer un tableau de bord personnalisé

Pour créer un tableau de bord personnalisé :

  1. Dans Cloud Console, sélectionnez Monitoring :

    Accéder à Monitoring

  2. Dans le volet de navigation, sélectionnez Tableaux de bord.
  3. Sur la page "Aperçu des tableaux de bord", cliquez sur Créer un tableau de bord.
  4. Pour chaque graphique que vous souhaitez ajouter au tableau de bord, procédez comme suit :
    1. Sélectionnez un type de graphique dans Ajouter un graphique ou faites-en glisser un depuis la bibliothèque vers la zone du graphique.

      Un graphique préconfiguré du type sélectionné s'affiche. L'exemple ci-dessous présente un graphique en courbes et son volet de configuration :

      Capture d'écran de l'explorateur de métriques que vous utilisez pour créer un graphique à ajouter à un tableau de bord.

    2. Sélectionnez un type de ressource et une métrique, puis appliquez des filtres (comme vous l'avez fait pour créer un graphique ci-dessus).

      Pour en savoir plus sur les options disponibles, consultez Ajouter des widgets de tableau de bord.

  5. (Facultatif) Dans la barre d'outils du tableau de bord, cliquez sur Ajouter un graphique pour ajouter un graphique, puis répétez les étapes précédentes pour le personnaliser.
  6. Lorsque vous avez terminé, sélectionnez la flèche vers la gauche pour quitter le tableau de bord ou sélectionnez un autre élément de menu de Monitoring. Votre tableau de bord est enregistré automatiquement.

Afficher un tableau de bord

Pour afficher un tableau de bord :

  1. Dans Cloud Console, sélectionnez Monitoring :

    Accéder à Monitoring

  2. Dans le volet de navigation, sélectionnez Tableaux de bord.
  3. Sélectionnez votre tableau de bord personnalisé ou un tableau de bord prédéfini dans la liste.

Pour plus d'informations, consultez les pages suivantes :

Créer des alertes

Les alertes permettent de détecter et de résoudre rapidement les problèmes qui surviennent dans vos applications. Dans Cloud Monitoring, une règle d'alerte décrit les circonstances dans lesquelles vous souhaitez être averti et par quel type de notification.

Les règles d'alerte peuvent être simples ou complexes. Elles vous permettent de déterminer si une seule série temporelle peut suffire à remplir une condition, ou si plusieurs séries temporelles doivent satisfaire la condition avant qu'elle ne soit remplie. Exemple :

  • M'avertir lorsque le nombre de requêtes pour une API spécifique dépasse 1 000 par période de cinq minutes
  • Avertir l'équipe d'astreinte lorsque le 90e centile des réponses HTTP 200 dépasse une latence de 100 ms pour au moins trois API

L'image ci-dessous montre comment définir une alerte pour générer une notification lorsque le nombre de requêtes pour une API dépasse 20 sur une période de cinq minutes :

Capture d'écran d'une alerte indiquant le nombre de requêtes API pour toutes les API Google Maps sous forme de lignes individuelles, et le seuil d'alerte sous forme de ligne horizontale.

Dans cette image :

  • Le graphique indique le nombre d'appels au fil du temps pour différentes API.
  • La ligne rouge indique le seuil de l'alerte. Les appels d'API qui dépassent ce seuil pendant cinq minutes déclenchent l'alerte. Cet exemple montre qu'une API a dépassé la limite.

Lorsque les conditions d'une règle d'alerte sont remplies, Cloud Monitoring ouvre un incident et émet des notifications :

  • Un incident est un enregistrement continu qui stocke des informations sur les ressources surveillées lorsque la condition est remplie. Lorsque la condition cesse d'être remplie, l'incident est automatiquement fermé. Vous pouvez afficher tous les incidents (ouverts et fermés) via le tableau de bord des alertes.
  • C'est vous qui indiquez qui sera averti lorsque vous configurez une règle d'alerte. Monitoring est compatible avec les canaux de notification courants : e-mail, Cloud Mobile App, services comme PagerDuty ou Slack, etc. Pour obtenir la liste complète des canaux de notification, consultez Options de notification.

Types d'alertes

Dans Cloud Monitoring, vous pouvez définir de nombreux types d'alertes, dont les suivants :

  • Alertes de seuil de métrique : déclenchez une alerte si une métrique devient supérieure ou inférieure à une valeur pendant une durée spécifique, ou si elle augmente ou diminue selon un pourcentage prédéfini.
  • Alertes de budget : définissez des règles liées aux seuils pour déclencher des notifications lorsque vos coûts (réels ou prévisionnels) dépassent un certain pourcentage de votre budget (selon les règles que vous avez définies). Cette alerte ne limite pas l'utilisation de l'API. Elle vous avertit lorsque le montant de vos dépenses s'approche du montant spécifié.
  • Alertes de quota : Google Cloud Platform établit différents quotas que vous pouvez utiliser pour suivre et limiter les ressources dédiées à un projet ou une organisation. Utilisez ces alertes pour envoyer des notifications lorsque votre utilisation approche d'une limite de quota.

Pour en savoir plus, consultez Types de règles d'alerte.

Gérer les règles d'alerte

Vous pouvez ajouter une règle d'alerte à votre projet via Cloud Console ou l'API Cloud Monitoring. Pour savoir comment afficher la liste des règles d'alerte basées sur les métriques de votre projet et les modifier, consultez les pages suivantes :

Créer une alerte

Lorsque vous créez une alerte :

  • définissez les conditions qui la déclenchent en fonction des données de métriques ;
  • indiquez les canaux de notification qui permettront d'envoyer l'alerte.

L'exemple ci-dessous montre comment configurer le déclenchement d'une alerte lorsque le taux d'utilisation du service Google Maps Platform pour une API dépasse deux requêtes sur une période de cinq minutes.

Pour créer l'alerte :

  1. Dans Cloud Console, sélectionnez Monitoring :

    Accéder à Monitoring

  2. Sélectionnez Alertes.
  3. Sélectionnez Modifier le canal de notification pour déterminer comment l'alerte enverra la notification. Dans cet exemple, vous utiliserez votre adresse e-mail.
    1. Dans la section Canal de messagerie, sélectionnez Ajouter.
    2. Renseignez les champs Adresse e-mail et Nom à afficher.
    3. Sélectionnez Enregistrer.
  4. Sélectionnez Alertes.
  5. Cliquez sur Créer une règle.
  6. Sélectionnez un intervalle de temps (par exemple, 7 jours).
  7. Sous Conditions d'alerte, sélectionnez Nouvelle condition :
    1. Cliquez sur Sélectionner une métrique, sélectionnez API Consumed comme ressource et Nombre de requêtes comme métrique, puis Appliquer.
    2. (Facultatif) Sous le graphique se trouve la liste des paramètres qui définissent les données du graphique : service, quota_metrics, method (méthode de l'API) et value (valeur de la métrique). Sélectionnez Ajouter un filtre pour filtrer les données selon ces informations. Par exemple, vous pouvez utiliser le filtre afin d'indiquer que la méthode doit être égale à google.places.Autocomplete.http pour déclencher l'alerte.
    3. Sous Transformer les données, sélectionnez 5 min pour la fenêtre glissante et moyenne pour le fenêtrage glissant.
    4. Sélectionnez Suivant.
  8. Sous Configurer le déclencheur d'alerte, définissez la valeur du seuil sur 2 pour déclencher l'alerte lorsque plus de deux requêtes sont envoyées au cours d'une période de cinq minutes. Notez que le graphique affiche désormais la ligne rouge indiquant la limite d'alerte pour l'intervalle de temps sélectionné. Le graphique vous permet de voir où une alerte aurait été déclenchée. Vous pouvez utiliser ce graphique pour ajuster la limite si nécessaire.
  9. Cliquez sur Suivant.
  10. Sur la page Configurer les notifications et finaliser l'alerte :
    1. Sélectionnez l'adresse e-mail créée pour le canal de notification.
    2. Sous Nom de l'alerte, saisissez Mon alerte test.
    3. Cliquez sur Créer une règle.
  11. Effectuez des requêtes API. Veillez à envoyer plus de deux requêtes API en cinq minutes pour générer la notification d'alerte par e-mail.
  12. Après avoir reçu l'e-mail, accédez à la page Alertes.
    1. Dans le tableau, cliquez sur l'alerte concernée pour afficher plus d'informations.
    2. Cliquez sur le nom de l'alerte pour afficher des informations, y compris un graphique indiquant l'événement qui l'a déclenchée.

Pour en savoir plus sur les alertes, consultez :