Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Ajouter et gérer des variables

Le tableau suivant répertorie les types de variables fournis avec Grafana.

Saisie des options générales

Vous devez saisir des options générales pour tous les types de variables que vous créez.

Ajouter une variable de requête

Les variables de requête vous permettent d'écrire une requête de source de données qui peut renvoyer une liste de noms de métriques, de valeurs de balises ou de clés. Par exemple, une variable de requête peut renvoyer une liste de noms de serveurs, d'identifiants de capteurs ou de centres de données. Les valeurs des variables changent lorsqu'elles extraient des options de manière dynamique avec une requête de source de données.

Les variables de requête ne sont généralement prises en charge que pour les chaînes. Si votre requête renvoie des nombres ou tout autre type de données, vous devrez peut-être les convertir en chaînes afin de les utiliser comme variables. Pour la source de données Azure, par exemple, vous pouvez utiliser la fonction tostring à cette fin.

Les expressions de requête peuvent contenir des références à d'autres variables et créer ainsi des variables liées. Grafana le détecte et actualise automatiquement une variable lorsque l'une de ses variables liées change.

Ajouter une variable personnalisée

Utilisez une variable personnalisée pour une valeur qui ne change pas, telle qu'un nombre ou une chaîne.

Par exemple, si vous avez des noms de serveurs ou de régions qui ne changent jamais, vous souhaiterez peut-être les créer sous forme de variables personnalisées plutôt que sous forme de variables de requête. Comme elles ne changent pas, vous pouvez les utiliser dans des variables chaînées plutôt que dans d'autres variables de requête. Cela réduirait le nombre de requêtes que Grafana doit envoyer lorsque les variables chaînées sont mises à jour.

Ajouter une variable de zone de texte

Les variables de zone de texte affichent un champ de saisie de texte libre avec une valeur par défaut facultative. Il s'agit de la variable la plus flexible, car vous pouvez saisir n'importe quelle valeur. Utilisez ce type de variable si vous disposez de métriques présentant une cardinalité élevée ou si vous souhaitez mettre à jour plusieurs panneaux d'un tableau de bord en même temps.

Ajouter une variable constante

Les variables constantes vous permettent de définir une constante cachée. Cela est utile pour les préfixes de chemins métriques des tableaux de bord que vous souhaitez partager. Lorsque vous exportez un tableau de bord, les variables constantes sont converties en options d'importation.

Les variables constantes ne sont pas flexibles. Chaque variable constante ne contient qu'une seule valeur, et elle ne peut pas être mise à jour à moins que vous ne mettiez à jour les paramètres de la variable.

Les variables constantes sont utiles lorsque vous avez des valeurs complexes que vous devez inclure dans des requêtes, mais que vous ne souhaitez pas les saisir à nouveau dans chaque requête. Par exemple, si le chemin d'un serveur est appeléi-0b6a61efe2ab843gg, vous pouvez le remplacer par une variable appelée$path_gg.

Ajouter une variable de source de données

Les variables de source de données vous permettent de modifier rapidement la source de données d'un tableau de bord complet. Ils sont utiles si vous disposez de plusieurs instances d'une source de données, par exemple dans différents environnements.

Ajouter une variable d'intervalle

Utilisez une variable d'intervalle pour représenter des périodes telles que 1m1h, ou1d. Vous pouvez les considérer comme un groupe à l'échelle du tableau de bord par commande temporelle. Les variables d'intervalle modifient la façon dont les données sont regroupées dans la visualisation. Vous pouvez également utiliser l'option Auto pour renvoyer un nombre défini de points de données par période.

Vous pouvez utiliser une variable d'intervalle comme paramètre à regrouper par heure (pour InfluxDB), par intervalle d'histogramme de date (pour Elasticsearch) ou comme paramètre de fonction de synthèse (pour Graphite).

Exemples de variables d'intervalle

L'exemple suivant montre une variable de modèle myinterval dans une fonction Graphite :

summarize($myinterval, sum, false)

Ajouter des filtres ad hoc

Les filtres ad hoc vous permettent d'ajouter des filtres clé-valeur qui sont automatiquement ajoutés à toutes les requêtes métriques utilisant la source de données spécifiée. Contrairement aux autres variables, vous n'utilisez pas de filtres ad hoc dans les requêtes. Vous utilisez plutôt des filtres ad hoc pour écrire des filtres pour les requêtes existantes.

Création de filtres ad hoc

Les filtres ad hoc constituent l'une des options variables les plus complexes et les plus flexibles disponibles. Au lieu d'une liste classique d'options de variables, cette variable vous permet de créer une requête ad hoc à l'échelle du tableau de bord. Les filtres que vous appliquez de cette manière sont appliqués à tous les panneaux du tableau de bord.

Configurer les options de sélection des variables

Les options de sélection sont une fonctionnalité que vous pouvez utiliser pour gérer les sélections d'options variables. Toutes les options de sélection sont facultatives et sont désactivées par défaut.

Variables à valeurs multiples

L'interpolation d'une variable avec plusieurs valeurs sélectionnées est délicate car il n'est pas simple de formater les multiples valeurs dans une chaîne valide dans le contexte donné dans lequel la variable est utilisée. Grafana essaie de résoudre ce problème en permettant à chaque plug-in de source de données d'indiquer au moteur d'interpolation de modèles le format à utiliser pour plusieurs valeurs.

Variables à valeurs multiples avec une source de données Graphite

Graphite utilise des expressions globulaires. Dans ce cas, une variable comportant plusieurs valeurs serait interpolée comme {host1,host2,host3} si la valeur actuelle de la variable était host1, host2 et host3.

Variables à valeurs multiples avec une source de données Prometheus ou InfluxDB

InfluxDB et Prometheus utilisent des expressions regex, de sorte que la même variable serait interpolée comme. (host1|host2|host3) Chaque valeur serait également échappée à une regex. Dans le cas contraire, une valeur avec un caractère de contrôle regex briserait l'expression regex.

Variables à valeurs multiples avec une source de données Elastic

Elasticsearch utilise la syntaxe de requête Lucene, de sorte que la même variable serait formatée comme suit. ("host1" OR "host2" OR "host3") Dans ce cas, chaque valeur doit être ignorée afin qu'elle ne contienne que des mots de contrôle du lucene et des guillemets.

Résolution des problèmes liés aux variables à valeurs multiples

L'échappement et le formatage automatiques peuvent poser des problèmes et il peut être difficile d'en saisir la logique. Surtout pour InfluxDB et Prometheus où l'utilisation de la syntaxe regex nécessite que la variable soit utilisée dans le contexte de l'opérateur regex.

Si vous ne voulez pas que Grafana effectue cet échappement et ce formatage automatiques des regex, vous devez effectuer l'une des opérations suivantes :

Option Tout inclure

Grafana ajoute une All option à la liste déroulante des variables. Si un utilisateur sélectionne cette option, toutes les options variables sont sélectionnées.

Toutes les valeurs personnalisées

Cette option n'est visible que si l'option Tout inclure est sélectionnée.

Entrez la syntaxe regex, globs ou lucene dans le champ Personnaliser toutes les valeurs pour définir la valeur de l'option. All

Par défaut, la All valeur inclut toutes les options d'une expression combinée. Cela peut devenir très long et entraîner des problèmes de performance. Parfois, il peut être préférable de spécifier une valeur complète personnalisée, comme une expression régulière générique.

Pour avoir une syntaxe regex, globs ou lucene personnalisée dans l'option Personnaliser toutes les valeurs, elle n'est jamais évitée. Vous devrez donc déterminer quelle est une valeur valide pour votre source de données.

Variables globales

Grafana possède des variables intégrées globales qui peuvent être utilisées dans les expressions de l'éditeur de requêtes. Cette rubrique les répertorie par ordre alphabétique et les définit. Ces variables sont utiles dans les requêtes, les liens de tableau de bord, les liens de panneaux et les liens de données.

$__tableau de bord

Cette variable est le nom du tableau de bord actuel.

$__from et $__to

Grafana possède deux variables de plage de temps intégrées : $__from et. $__to Elles sont actuellement toujours interpolées en millisecondes d'époque par défaut, mais vous pouvez contrôler le formatage des dates.

La syntaxe ci-dessus fonctionne également avec${__to}.

$__interval

Vous pouvez utiliser la $__interval variable comme paramètre à regrouper par heure (pour InfluxDB, MySQL, Postgres, MSSQL), par intervalle d'histogramme de date (pour Elasticsearch) ou comme paramètre de fonction de synthèse (pour Graphite).

Grafana calcule automatiquement un intervalle qui peut être utilisé pour regrouper par heure dans les requêtes. Lorsque le nombre de points de données est supérieur à ce qui peut être affiché sur un graphique, les requêtes peuvent être rendues plus efficaces en les regroupant selon un intervalle plus long. Par exemple, si vous regardez un graphique représentant 3 mois de données, il se peut que vous ne puissiez pas voir les détails à la minute près. Le regroupement par heure ou par jour rend la requête plus efficace sans affecter l'affichage du graphique. Le $__interval est calculé en utilisant la plage de temps et la largeur du graphique (le nombre de pixels).

Calcul approximatif : (to - from) / resolution

Par exemple, lorsque l'intervalle de temps est d'une heure et que le graphique est affiché en plein écran, l'intervalle peut être calculé comme suit 2m : les points sont regroupés par intervalles de 2 minutes. Si l'intervalle de temps est de 6 mois et que le graphique est affiché en plein écran, l'intervalle peut être de 1d (1 jour) : les points sont regroupés par jour.

Dans la source de données InfluxDB, la variable héritée $interval est la même variable. $__intervaldevrait être utilisé à la place.

Les sources de données InfluxDB et Elasticsearch contiennent des Group by time interval champs utilisés pour coder en dur l'intervalle ou pour définir la limite minimale de la $__interval variable (en utilisant la > syntaxe ->). >10m

$__interval_ms

Cette variable est la $__interval variable exprimée en millisecondes, et non une chaîne formatée par intervalle de temps. Par exemple, si le $__interval est20m, alors le $__interval_ms est1200000.

$__org

Cette variable est l'ID de l'organisation actuelle. ${__org.name}est le nom de l'organisation actuelle.

$__utilisateur

${__user.id}est l'ID de l'utilisateur actuel. ${__user.login}est le nom d'utilisateur de connexion de l'utilisateur actuel. ${__user.email}est l'adresse e-mail de l'utilisateur actuel.

$__range

Actuellement uniquement compatible avec les sources de données Prometheus et Loki. Cette variable représente la plage du tableau de bord actuel. Il est calculé parto - from. Il comporte une milliseconde et une seconde représentation appelée et. $__range_ms $__range_s

$__rate_interval

Actuellement uniquement pris en charge pour les sources de données Prometheus. La $__rate_interval variable est destinée à être utilisée dans la fonction de taux.

$timeFilter ou $__timeFilter

La $timeFilter variable renvoie la plage de temps actuellement sélectionnée sous forme d'expression. Par exemple, l'Last 7 daysexpression de l'intervalle de temps esttime > now() - 7d.

Ceci est utilisé à plusieurs endroits, notamment :

Variables enchaînées

Les variables chaînées, également appelées variables liées ou variables imbriquées, sont des variables de requête contenant une ou plusieurs autres variables dans leur requête variable. Cette section explique le fonctionnement des variables chaînées et fournit des liens vers des exemples de tableaux de bord utilisant des variables chaînées.

Les requêtes de variables chaînées sont différentes pour chaque source de données, mais le principe est le même pour toutes. Vous pouvez utiliser des requêtes variables chaînées dans toutes les sources de données qui les autorisent.

Des tableaux de bord modélisés liés extrêmement complexes sont possibles, d'une profondeur de 5 ou 10 niveaux. Techniquement, il n'y a aucune limite quant à la profondeur ou à la complexité que vous pouvez atteindre, mais plus vous avez de liens, plus la charge de requête est importante.

Bonnes pratiques et conseils

Les pratiques suivantes faciliteront l'utilisation de vos tableaux de bord et de vos variables.

Création de nouvelles variables liées

Ordre variable

Vous pouvez modifier l'ordre des variables dans la liste des variables du tableau de bord en cliquant sur les flèches haut et bas à droite de chaque entrée. Grafana répertorie les listes déroulantes variables de gauche à droite selon cette liste, avec la variable en haut à l'extrême gauche.

Considération de complexité

Plus vous avez de niveaux de dépendance dans les variables, plus la mise à jour des tableaux de bord prend du temps après avoir modifié les variables.

Par exemple, si vous avez une série de quatre variables liées (pays, région, serveur, métrique) et que vous modifiez la valeur d'une variable racine (pays), Grafana doit exécuter des requêtes pour toutes les variables dépendantes avant de mettre à jour les visualisations dans le tableau de bord.

Gérer les variables

La page des variables permet d'ajouter des variables et de gérer les variables existantes. Il vous permet également d'inspecter les variables et de déterminer si une variable est référencée (ou utilisée) dans d'autres variables ou dans le tableau de bord.

Déplacer : vous pouvez déplacer une variable vers le haut ou vers le bas de la liste par glisser-déposer.

Cloner : pour cloner une variable, cliquez sur l'icône de clonage dans le jeu d'icônes de droite. Cela crée une copie de la variable avec le nom de la variable d'origine préfixé parcopy_of_.

Supprimer : pour supprimer une variable, cliquez sur l'icône de corbeille dans le jeu d'icônes de droite.

Filtrer les variables avec regex

À l'aide de l'option Regex Query, vous filtrez la liste des options renvoyées par la variable query ou vous modifiez les options renvoyées.

Cette page montre comment utiliser une expression régulière pour filtrer/modifier les valeurs dans la liste déroulante des variables.

À l'aide de l'option de requête Regex, vous filtrez la liste des options renvoyées par la requête Variable ou vous modifiez les options renvoyées. Pour plus d'informations, consultez le guide de Mozilla sur les expressions régulières.

Les exemples suivants illustrent le filtrage dans la liste d'options suivante.

backend_01
backend_02
backend_03
backend_04

Filtrer de manière à ce que seules les options se terminant par 01 ou 02 soient renvoyées

Régex :

/
(
01|02 
) 
$/

Résultat:

backend_01
backend_02

Filtrez et modifiez les options à l'aide d'un groupe de capture regex pour renvoyer une partie du texte

Régex :

/.* 
(
01|02 
)
/

Résultat:

01
02

Filtrer et modifier - Prometheus Example

Liste des options :

up{instance="demo.robustperception.io:9090",job="prometheus"} 1 1521630638000
up{instance="demo.robustperception.io:9093",job="alertmanager"} 1 1521630638000
up{instance="demo.robustperception.io:9100",job="node"} 1 1521630638000

Régex :

/. *instance="
(
[^"]*
)
.*/

Résultat:

demo.robustperception.io:9090
demo.robustperception.io:9093
demo.robustperception.io:9100

Filtrer et modifier à l'aide de groupes de capture de texte et de valeurs nommés

À l'aide de groupes de capture nommés, vous pouvez capturer des parties « texte » et « valeur » distinctes à partir des options renvoyées par la requête variable. Cela permet à la liste déroulante des variables de contenir un nom convivial pour chaque valeur pouvant être sélectionnée.

Par exemple, lorsque vous interrogez la métrique node_hwmon_chip_names Prometheus, la valeur est beaucoup plus chip_name conviviale que la valeur. chip Le résultat de la requête variable suivant est donc :

node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_0",chip_name="enp216s0f0np0"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_1",chip_name="enp216s0f0np1"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_2",chip_name="enp216s0f0np2"} 1
node_hwmon_chip_names{chip="0000:d7:00_0_0000:d8:00_3",chip_name="enp216s0f0np3"} 1

Transmis par le Regex suivant :

/chip_name="(?<text>[ ^ " ] + ) |chip=" (?<value >[ ^ " ] + )/g

Cela produirait la liste déroulante suivante :

Display Name          Value
------------          -------------------------
enp216s0f0np0         0000:d7:00_0_0000:d8:00_0
enp216s0f0np1         0000:d7:00_0_0000:d8:00_1
enp216s0f0np2         0000:d7:00_0_0000:d8:00_2
enp216s0f0np3         0000:d7:00_0_0000:d8:00_3

Seuls text les noms de groupes de value capture et de capture sont pris en charge.

La page des variables vous permet d'identifier facilement si une variable est référencée (ou utilisée) dans d'autres variables ou dans le tableau de bord.

Toute variable référencée ou utilisée est cochée par une coche verte, tandis que les variables non référencées sont accompagnées d'une icône d'avertissement orange. En outre, toutes les variables référencées ont une icône de dépendance à côté de la coche verte. Vous pouvez sélectionner l'icône pour afficher la carte des dépendances. La carte des dépendances peut être déplacée. Vous pouvez zoomer ou dézoomer avec la molette de la souris ou un outil équivalent.