Requêtes enregistrées

Cette rubrique de documentation est conçue pour les espaces de travail Grafana compatibles avec la version 8.x de Grafana.

Pour les espaces de travail Grafana compatibles avec la version 10.x de Grafana, voir. Travailler dans la version 10 de Grafana

Pour les espaces de travail Grafana compatibles avec la version 9.x de Grafana, voir. Travailler dans la version 9 de Grafana

Vous pouvez voir les tendances au fil du temps en prenant un instantané d'un point de données à un intervalle défini à l'aide de requêtes enregistrées. Cela peut vous donner un aperçu des tendances historiques.

Pour les plugins qui ne renvoient pas de séries chronologiques, il peut être utile de tracer des données historiques. Par exemple, vous souhaiterez peut-être effectuer une requête ServiceNowpour consulter l'historique des temps de réponse aux demandes, mais celle-ci ne peut renvoyer que point-in-time les mesures actuelles.

Fonctionnement des requêtes enregistrées

Les requêtes enregistrées ne fonctionnent qu'avec les plugins de source de données principaux. Pour plus d'informations, reportez-vous à la section Plug-in de source de données principal. Vous pouvez enregistrer trois types de requêtes :

• ligne et colonne uniques : requête renvoyant une seule ligne et une seule colonne.

• nombre de lignes : requête qui renvoie des lignes significatives à compter.

• expression : n'importe quelle expression. Pour en savoir plus sur la création et l'utilisation d'expressions, consultez la section Expressions.

Une fois qu'une requête enregistrée est créée ou activée, elle crée immédiatement un instantané et continue à créer des instantanés à l'intervalle défini. La requête enregistrée arrête de prendre des instantanés lorsqu'elle est désactivée, supprimée ou lorsque Grafana n'est pas en cours d'exécution. Les points de données sont collectés dans le backend en exécutant la requête enregistrée et en transmettant chaque résultat à une instance Prometheus compatible avec l'écriture à distance.

Note

Vous devez configurer une source de données Prometheus et l'associer à une cible d'écriture distante avant de pouvoir utiliser les requêtes enregistrées.

Création d'une requête enregistrée

Pour créer une requête enregistrée, procédez comme suit :

1. Recherchez ou créez une requête que vous souhaitez enregistrer sur un tableau de bord dans un panneau d'édition. La requête ne doit renvoyer qu'une seule ligne et une seule colonne. S'il renvoie plus, vous pouvez toujours enregistrer le nombre de résultats renvoyés à l'aide de l'option count. La source de données de la requête doit être une source de données principale. Les expressions peuvent être utilisées pour agréger les données d'une requête de série chronologique. Pour en savoir plus sur la création et l'utilisation d'expressions, reportez-vous à la section Expressions.

2. Choisissez le menu de requête d'enregistrement situé dans l'éditeur de requêtes.

3. Entrez les informations de requête enregistrées. Tous les champs sont obligatoires sauf indication contraire.

   • Nom : nom de la requête enregistrée.

   • Description - (facultatif) Décrivez la requête enregistrée telle que vous souhaitez qu'elle apparaisse dans la liste des requêtes enregistrées.

   • Intervalle : intervalle auquel le cliché sera pris. L'intervalle commence lorsque vous créez la requête enregistrée et s'arrête si vous interrompez ou supprimez la requête enregistrée. Pour plus d'informations sur la suspension et la suppression des requêtes enregistrées, reportez-vous à la section Gestion des requêtes enregistrées.

   • Plage : plage de temps relative de la requête. Si vous sélectionnez une plage de 30 m et un intervalle d'une heure, la requête prendra un instantané toutes les heures des 30 dernières minutes.

   • Compter les résultats de la requête : si vous souhaitez compter les lignes renvoyées par votre requête, activez cette option. Si cette option est désactivée, votre requête doit renvoyer une ligne avec une seule valeur.

4. Testez votre requête enregistrée en cliquant sur le bouton Tester la requête enregistrée.

5. Choisissez Commencer l'enregistrement de la requête.

Ajouter une requête enregistrée

Vous pouvez ajouter des requêtes enregistrées existantes aux panneaux d'un tableau de bord. Pour chaque requête enregistrée que vous ajoutez, une requête Prometheus est créée :. generated_recorded_query_name{id="generated_id", name="recorded query name"} La requête créée par Prometheus renvoie tous les instantanés collectés de la requête enregistrée.

1. Accédez à un panneau d'un tableau de bord dans lequel vous souhaitez ajouter une requête enregistrée.

2. Choisissez le menu + Requête enregistrée.

3. Si vous souhaitez filtrer les requêtes enregistrées par source de données, sélectionnez une source de données dans le menu déroulant Filtrer par source de données.

4. Choisissez Ajouter un menu sur votre requête enregistrée pour l'ajouter au panneau.

Après avoir ajouté votre requête enregistrée au panneau, la source de données du panneau deviendra-- Mixed --. Votre requête enregistrée est représentée par une Prometheus requête dont le nom correspond au nom de votre requête enregistrée. Reportez-vous à Prometheus pour en savoir plus sur la source de données Prometheus.

Si, après avoir ajouté une requête enregistrée, une requête contenant une source de -- Mixed -- données au lieu de la source de données Prometheus apparaît, cela peut signifier qu'aucune cible d'écriture Prometheus distante n'a été configurée pour les requêtes enregistrées. Reportez-vous à la section Cible d'écriture distante pour configurer un point d'écriture distant.

Utilisation d'une requête enregistrée

Pour utiliser une requête enregistrée, créez-en une et ajoutez-la à un tableau de bord. Ensuite, il peut être géré dans les préférences de l'onglet Requêtes enregistrées.

Gestion des requêtes enregistrées

Les requêtes enregistrées peuvent être suspendues ou activées et supprimées depuis l'onglet Requêtes enregistrées dans les préférences. La suppression d'une requête enregistrée la supprimera de Grafana, mais les informations recueillies dans Prometheus seront toujours présentes. La suspension d'une requête enregistrée ne permet plus de recueillir de nouveaux points de données tant qu'elle n'est pas reprise.

Cible d'écriture distante

La cible d'écriture à distance est la source de données Prometheus dans laquelle les points de données de requête enregistrés sont écrits. Vous aurez besoin d'un Prometheus avec l'écriture à distance activée et vous devrez créer une source de données pour ce Prometheus.

Pour modifier la cible d'écriture à distance, choisissez Modifier la cible d'écriture à distance dans le menu de la console, sous l'onglet Requêtes enregistrées dans les préférences. Sélectionnez la source de données Prometheus pour laquelle l'écriture à distance est activée et entrez le chemin d'écriture à distance.