Configurer une alerte basée sur une requête à l'aide de MQL

Configurer une alerte basée sur une requête à l'aide de MQL

Ce document explique comment utiliser le langage MQL (Monitoring Query Language) pour explorer les métriques, créer des graphiques et configurer une alerte basée sur des requêtes dans la console Google Cloud. Si vous préférez utiliser l'API Cloud Monitoring, consultez la section Créer des conditions pour les règles d'alerte.

Dans ce document, vous allez effectuer les opérations suivantes:

1. Créer une instance Compute Engine,

2. Accédez à l'éditeur de code.

3. Effectuer une requête et créer un graphique,

4. Configurez une alerte basée sur une requête.

Avant de commencer

Pour utiliser le langage MQL, vous devez créer un projet Google Cloud et activer la facturation.

1. Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.

2. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

3. Vérifiez que la facturation est activée pour votre projet Google Cloud.

4. Dans Google Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Google Cloud.

   Remarque : Si vous ne comptez pas conserver les ressources créées dans cette procédure, créez un projet au lieu de sélectionner un projet existant. Après avoir suivi ces étapes, vous pouvez supprimer le projet. Cela entraîne la suppression de toutes les ressources qui lui sont associées.

   Accéder au sélecteur de projet

5. Vérifiez que la facturation est activée pour votre projet Google Cloud.

Configurez ensuite les autorisations et les canaux de notification.

1. Pour obtenir les autorisations dont vous avez besoin pour créer des règles d'alerte avec une condition basée sur MQL, demandez à votre administrateur de vous attribuer le rôle IAM Éditeur Monitoring (roles/monitoring.editor) sur votre projet. Pour en savoir plus sur l'attribution de rôles, consultez la section Gérer les accès.

   Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

   Pour en savoir plus sur les rôles Cloud Monitoring, consultez la page Contrôler les accès avec Identity and Access Management.

2. Assurez-vous de bien connaître les concepts généraux liés aux règles d'alerte, à MQL et à l'éditeur de code. Pour plus d'informations, consultez les articles suivants :

   • Présentation des alertes
   • Règles d'alerte avec MQL
   • Utiliser l'éditeur de code pour MQL

Créer une instance Compute Engine

Pour disposer d'une ressource Google Cloud à partir de laquelle collecter des métriques, créez une instance Compute Engine en procédant comme suit :

1. Dans le menu de la console Google Cloud, sélectionnez Compute Engine.

   

2. Sélectionnez Créer une instance, puis cliquez sur Créer.

Remarque :Si vous rencontrez des problèmes lors de la création d'une instance, consultez le Guide de démarrage rapide à l'aide d'une VM Linux.

Accéder à l'éditeur de code

Pour commencer à utiliser le langage MQL, procédez comme suit :

1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Surveillance, puis  Explorateur de métriques :

   Accéder à l'Explorateur de métriques

2. Dans la barre d'outils du volet de création de requêtes, sélectionnez le bouton nommé  MQL ou  PromQL.
3. Vérifiez que MQL est sélectionné dans le bouton d'activation Langage. Le bouton de langage se trouve dans la barre d'outils qui vous permet de mettre en forme votre requête.

Créez, testez et exécutez des requêtes MQL à l'aide de l'éditeur de code.

Exécuter une requête et créer un graphique

Créez une requête qui représente l'utilisation du processeur de votre instance:

1. Collez la requête suivante dans l'éditeur de code:

   fetch gce_instance::compute.googleapis.com/instance/cpu/utilization
   | {
       top 1, max(val())
     ;
       bottom 1, min(val())
     }
   | union
   

   Cette requête sélectionne les séries temporelles présentant l'utilisation maximale et minimale du processeur pour la représentation graphique. Pour en savoir plus sur cette requête, consultez la section Combiner des sélections avec union.

2. Cliquez sur Exécuter la requête. Le graphique affiche deux lignes, affichant l'utilisation maximale et minimale du processeur par votre instance :

   

3. Pour enregistrer le graphique, cliquez sur Save Chart (Enregistrer le graphique). Attribuez un nom au graphique et ajoutez-le à un tableau de bord nouveau ou existant. Cliquez ensuite sur Enregistrer.

Le graphique est accessible via la page Présentation de la surveillance ou, si vous l'avez enregistré dans un tableau de bord, via la page correspondante.

Configurer une alerte basée sur des requêtes

Vous pouvez créer une règle d'alerte permettant de surveiller les résultats d'une requête. Pour créer une règle d'alerte de ce type, procédez comme suit :

1. Dans le panneau de navigation de la console Google Cloud, sélectionnez Monitoring, puis  Alertes :

   Accéder à l'interface des alertes

2. Sur la page Alertes, cliquez sur Modifier les canaux de notification. Au cours de cette étape, vous allez configurer une adresse e-mail pour recevoir des notifications d'alerte.

   1. Sur la page Canaux de notification, accédez à E-mail, puis cliquez sur Ajouter.

   2. Saisissez l'adresse e-mail à laquelle sur laquelle vous souhaitez recevoir les notifications d'alerte dans le champ Adresse e-mail.

   3. Saisissez une brève description de ce canal, par exemple "Alerte astreinte", dans le champ Nom à afficher.

   4. Cliquez sur Enregistrer.

   5. Revenez à la page Alertes en cliquant sur Retour sur l'en-tête de la page.

3. Sur la page Alertes, cliquez sur Créer une règle.

   Cette page vous guide tout au long du processus de création d'une règle d'alerte :

   1. Décrire les éléments pour lesquels vous souhaitez recevoir des alertes.
   2. Fournir des informations sur la façon de résoudre ce problème.
   3. Spécifier un canal de notification pour l'alerte.

4. Pour décrire l'alerte, cliquez sur Nouvelle condition. Cette action entraîne l'affichage de l'éditeur de conditions basées sur des formulaires.

   1. Sous Mode de configuration des règles, sélectionnez Éditeur de code (MQL ou PromQL).

   2. Vérifiez que MQL est sélectionné dans le bouton d'activation Langage. Le bouton de langage se trouve dans la barre d'outils qui vous permet de mettre en forme votre requête.

   3. Saisissez la requête qui sélectionne les données que vous souhaitez surveiller dans l'éditeur de code. La requête suivante déclenche une alerte lorsque le temps d'utilisation du processeur par votre instance reste supérieur à 20 secondes:

      fetch gce_instance::compute.googleapis.com/instance/cpu/usage_time
      | window 1m
      | condition val() > 20 's'
      

      L'opération condition établit le seuil de performances pour lequel vous souhaitez générer une alerte. Pour en savoir plus sur condition et d'autres opérations d'alerte, consultez la section Alertes dans la documentation de référence de MQL.

      Si l'exécution automatique est activée, le graphique MQL affiche les données sélectionnées et une ligne de seuil:

      

   4. Pour configurer le déclencheur d'alerte, cliquez sur Suivant:

      1. Dans le menu Déclencheur d'alerte, sélectionnez le nombre de séries temporelles qui doivent satisfaire à l'opération d'alerte pour que la règle d'alerte puisse être déclenchée. Vous avez le choix entre les critères suivants:

         • Une seule série temporelle,
         • Un nombre spécifique de séries temporelles,
         • Un pourcentage de la série temporelle,
         • Toutes les séries temporelles.

      2. Facultatif: développez le menu Options avancées et, dans le champ Déclencher lorsque la condition est remplie pendant cette durée, saisissez ou sélectionnez une valeur.

         Ce champ définit la durée pendant laquelle la condition doit être remplie avant que la règle d'alerte soit déclenchée. La fenêtre de nouveau test est différente de la fenêtre d'alignement utilisée dans la requête MQL. Pour plus d'informations sur la relation entre ces valeurs, consultez la section Période d'alignement et durée.

      3. Saisissez un nom pour votre condition, par exemple "Condition MQL de base".

5. Pour configurer les notifications, la documentation et le nom de la règle d'alerte, cliquez sur Suivant.

   1. Sélectionnez le canal de notification que vous avez créé précédemment.

   2. Choisissez un niveau de gravité.

   3. Saisissez du texte à envoyer avec une notification d'alerte dans le champ Documentation. Ce texte fournit généralement aux utilisateurs les informations nécessaires pour les aider à résoudre le problème. Pour cet exercice, saisissez "Votre utilisation du processeur a dépassé 20 secondes".

   4. Saisissez un nom pour la règle d'alerte dans le champ Nom de la règle d'alerte. Cette valeur vous permet de distinguer les notifications des différentes règles d'alerte.

6. Enregistrez votre règle en cliquant sur Créer une règle.

Effectuer un nettoyage

Pour éviter que les ressources utilisées sur cette page soient facturées sur votre compte Google Cloud, procédez comme suit :

1. Accédez à la page Identity and Access Management dans la console Google Cloud:

   Accéder aux paramètres du projet

2. Cliquez sur Arrêter et suivez les instructions.

Étapes suivantes

• En savoir plus sur l'utilisation de l'éditeur de code
• Explorez un ensemble d'exemples MQL.
• Apprenez-en plus sur les règles d'alerte basées sur MQL.
• Découvrez comment appeler des requêtes MQL à partir de l'API Cloud Monitoring.
• Pour en savoir plus sur MQL, consultez la documentation de référence sur MQL.
• Consultez nos ressources sur DevOps et découvrez le programme de recherche de DORA.