Utiliser l'éditeur de code pour PromQL

Cette page explique comment utiliser l'éditeur de code pour PromQL. L'éditeur est disponible dans la console Google Cloud, et propose des suggestions ainsi que d'autres outils pour créer des requêtes PromQL valides.

Cette page ne traite pas du langage PromQL. pour obtenir des informations PromQL, nous vous recommandons de consulter la documentation Open Source. Les éléments suivants : ressources peuvent vous aider à démarrer:

Accéder à l'éditeur de code

Vous pouvez accéder à PromQL à partir des pages suivantes de la console Google Cloud:

  • Explorateur de métriques
  • Ajouter un widget lors de la création de tableaux de bord

Pour ouvrir l'éditeur de code lorsque vous utilisez l'explorateur de métriques, procédez comme suit:

  1. Dans la console Google Cloud, accédez à la page Explorateur de métriques :

    Accéder à l'explorateur de métriques

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Surveillance.

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

  4. Une fois votre requête terminée, vous pouvez configurer la légende ou modifier la façon dont où les données s'affichent. Pour en savoir plus, consultez les pages suivantes :

Utiliser l'éditeur de code

Pour utiliser l'éditeur de code, saisissez votre requête dans la zone de texte et cliquez sur Exécuter la requête.

Saisie semi-automatique

Lorsque vous saisissez une requête, l'éditeur affiche une liste d'achèvements valides d'un point de vue syntaxique. Vous pouvez afficher manuellement le menu de saisie semi-automatique en appuyant sur Control+Space et le fermer en appuyant sur Escape.

Pour parcourir la liste des options, utilisez les touches fléchées. Appuyez sur Enter pour insérer le choix sélectionné.

Pour insérer le préfixe commun à tous les choix disponibles, appuyez sur Tab.

Rechercher et remplacer

L'éditeur est compatible avec une fonctionnalité de recherche et de remplacement. Pour rechercher et, éventuellement, remplacer des termes dans votre requête, appuyez sur Control+F (ou Command+F sur Mac). La capture d'écran suivante montre cette fonctionnalité:

l'éditeur de code prend en charge une fonctionnalité de recherche et de remplacement.

Commandes de l'éditeur

L'éditeur dispose de deux commandes qui déterminent la manière dont il interagit avec votre requête.

Par défaut, votre requête n'est exécutée que lorsque vous cliquez sur Run query (Exécuter la requête). Vous pouvez configurer l'éditeur pour qu'il exécute automatiquement votre requête en tant que lorsque vous saisissez du texte, mais cette option est désactivée par défaut.

Pour activer l'option d'exécution automatique, cliquez sur le bouton Exécution automatique. Lorsque cette option est activée, l'éditeur fonctionne comme suit :

  • Le bouton Run query (Exécuter la requête) ne s'affiche pas.
  • Les messages d'erreur s'affichent en continu pendant la saisie.

  • Si votre curseur se trouve à la fin d'une requête incomplète, mais n'est associée à aucun s'affiche, l'éditeur affiche un triangle jaune dans la barre de commandes. S'il y a le texte Requête incomplète s'affiche également.

    L'éditeur ne tente pas d'évaluer les requêtes incomplètes.

Il existe également une barre de progression entre l'éditeur de code et la région du graphique. Utilisez cette barre pour modifier les tailles relatives des deux régions.

Enregistrer les graphiques

La façon dont vous enregistrez un graphique dépend du contexte dans lequel vous avez créé le graphique:

  • Dans l'explorateur de métriques
  • Dans le cadre de la création ou de la modification d'un tableau de bord personnalisé.

Enregistrer des graphiques à partir de l'Explorateur de métriques

Dans l'éditeur de code de l'Explorateur de métriques, vous pouvez enregistrer votre graphique dans un tableau de bord personnalisé. Pour enregistrer votre graphique, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Explorateur de métriques :

    Accéder à l'explorateur de métriques

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Surveillance.

  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 PromQL 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.
  4. Saisissez votre requête dans l'éditeur.

  5. Si l'option d'exécution automatique de l'éditeur de code n'est pas activée, exécutez votre requête en cliquant sur Exécuter la requête avant d'enregistrer le graphique. Par défaut, les tableaux de bord personnalisés enregistrent régulièrement vos modifications. Lorsque vous n'exécutez pas votre requête, l'éditeur de code enregistre la dernière requête exécutée.

  6. Cliquez sur Enregistrer le graphique.

  7. Pour continuer à enregistrer le graphique, procédez comme suit :

    1. Donnez un titre descriptif au graphique.
    2. Sélectionnez le tableau de bord pour le nouveau graphique.
    3. Cliquez sur Save (Enregistrer) dans la boîte de dialogue.

Enregistrer des graphiques dans un tableau de bord personnalisé

Pour enregistrer un nouveau graphique dans votre tableau de bord, procédez comme suit:

  1. Donnez un titre descriptif au graphique.

  2. Si l'option d'exécution automatique de l'éditeur de code n'est pas activée, exécutez votre requête en cliquant sur Exécuter la requête avant d'enregistrer le graphique. Par défaut, les tableaux de bord personnalisés enregistrent régulièrement vos modifications. Lorsque vous n'exécutez pas votre requête, l'éditeur de code enregistre la dernière requête exécutée.

  3. Si l'enregistrement automatique n'est pas activé pour votre tableau de bord, cliquez sur Enregistrer.

La console Google Cloud accepte les filtres au niveau de la page pour les tableaux de bord. Ces filtres sont compatibles avec PromQL dans vos tableaux de bord personnalisés.

Quitter l'éditeur de code

Pour quitter l'éditeur de code sans enregistrer votre requête, cliquez sur l'un des autres onglets de sélection. Tout texte de requête dans l'éditeur est supprimé, mais vous pouvez l'enregistrer dans le presse-papiers.