Variables de modèle : filtrer dynamiquement le dashboard

Pour un dashboard personnalisé, vous pouvez utiliser template variables pour filtrer dynamiquement les graphiques et autres widgets. Les variables de modèle rendent votre dashboard plus utile et vous aident à créer plus facilement un dashboard que vous pouvez réutiliser pour différents cas d'utilisation.

Pourquoi utiliser des variables de modèle ?

Les variables de modèle sont un moyen puissant et dynamique de filtrer un dashboard entier en fonction de valeurs de métadonnées spécifiques choisies par un créateur dashboard . Les avantages de l’utilisation de variables de modèle sont les suivants :

Ils rendent le dashboard plus facile à utiliser : votre utilisateur n'a pas besoin de comprendre la structure des données ; il peut simplement choisir parmi les différentes options de filtre que vous avez définies.
Ils vous permettent de créer des modèles de dashboard réutilisables que vous pouvez ensuite dupliquer et personnaliser pour de nombreuses autres utilisations.

Voici un exemple de dashboard avec plusieurs variables de modèle, que vous pouvez voir en haut du dashboard.

Aller à one.newrelic.com > All capabilities > Dashboards

Avec les variables de modèle, vous pouvez configurer une grande variété de variables et de filtres pour créer l'expérience dashboard dont vous avez besoin. Exemples d’expériences que vous pouvez créer :

Une liste déroulante pour choisir un nom d'application
Une liste déroulante pour choisir des régions spécifiques
Une liste déroulante pour sélectionner des durées spécifiques ou d'autres valeurs numériques
Filtres qui utilisent des champs de texte libre pour trouver des chaînes correspondantes

De plus, vous pouvez désormais décider si vous souhaitez inclure la variable ou non sans avoir à modifier votre requête. Voir la section Inclure la variable pour plus de détails.

Inclure et exclure des variables

La bascule Include variable vous permet de définir une valeur souhaitée et d'inclure ou d'exclure cette valeur dans votre dashboard. Consultez la section Variables de modèle pour plus d'informations.

Par exemple, vous pouvez étudier un problème qui n’est pas spécifique à une valeur particulière d’une variable. Dans de tels cas, les valeurs existantes de la variable peuvent limiter les résultats de la requête, même lors de la sélection de toutes les options possibles. Pour résoudre ce problème, vous pouvez exclure la variable de la requête. Cela supprime efficacement la condition de la variable et la remplace par une valeur booléenne neutre (vrai ou faux), garantissant la validité de la requête et renvoyant des résultats complets.

Exemple

Considérez une requête qui filtre les résultats en fonction d’une variable countryCode . Si vous souhaitez afficher les données de tous les pays sans filtrage, vous pouvez exclure la variable :

Requête originale :

FROM PageAction 
SELECT count(*) AS 'views' 
WHERE countryCode IN ({{countryCode}}) AND appName = 'Test App' FACET countryCode

requête avec une variable exclue :

FROM PageAction 
SELECT count(*) AS 'views' 
WHERE true AND appName = 'Test App' FACET countryCode

Cette fonctionnalité est particulièrement utile lorsque :

La variable a plus de valeurs que le maximum autorisé (par instance, 5000 résultats maximum pour les uniques par défaut) ou un nombre très élevé de valeurs. Choisir de désactiver la variable par défaut apportera des améliorations de performances considérables.
La source de données de la variable diffère de la base de données que vous interrogez. Dans ces cas, sélectionner toutes les valeurs de la base de données à l'aide de « Sélectionner tout » n'est pas suffisant. En excluant la variable, vous pouvez récupérer toutes les valeurs de la base de données.

Limitations de la variable d'inclusion :

Lorsqu'elle est utilisée dans les cas FACET, la condition est remplacée par true et la convertit en une condition toujours vraie.
Lorsqu'il est utilisé dans d'autres contextes comme des fonctions ou avec l'instruction SELECT , vous obtiendrez l'erreur suivante : "Unknown function Disable_variable()". Cela est dû au fait que la fonction de désactivation de la variable n'est pas encore implémentée pour ces cas spécifiques.

Exigences et limites

Les variables de modèle ne peuvent être utilisées que dans le cadre de la création de widgets pour dashboard personnalisés. Voir Variables NRQL pour utiliser des variables dans une requête NRQL.

la requête avec des variables de modèle ne peut être utilisée que dans le contexte d'un dashboard. Pour cette raison, certaines fonctionnalités liées aux requêtes ne fonctionnent pas. Par exemple, l'option Export dashboard as PDF ne prend pas en charge les widgets avec des variables.

Points importants à noter lors de l'ajout d'une requête :

La variable que vous avez définie se trouve entre les crochets {{ … }} .
La variable génère une valeur de chaîne.
Pour vous aider lors de la création d'une requête, il existe un code couleur :
- Les clauses FROM, SELECT, FACET et WHERE sont en rose.
- identifiant sont en noir.
- Les fonctions sont en bleu.
- Les cordes sont en vert.
- Les entiers sont en marron.
Consultez notre page Comment utiliser NRQL : les mécanismes de requête si vous souhaitez en savoir plus sur l'écriture de requêtes avec NRQL.

Pour les restrictions liées à l'écriture de requêtes, voir Écriture de requêtes.

Utiliser des variables de modèle

Nous vous guiderons dans la création d'une variable de modèle, puis nous vous donnerons quelques exemples de différents types de variables de modèle.

La création d’une variable de modèle se compose de deux étapes.

Définir la variable de modèle

Tout d’abord, vous allez définir une variable de modèle. Il s'agit de la variable que vous utiliserez dans une requête NRQL pour créer un widget.

Pour définir une variable :

À partir d'un nouveau dashboard sans variables, cliquez sur le bouton Modifier bouton, puis cliquez sur le bouton + Add variable situé dans le coin supérieur gauche. Une fois que vous avez terminé d’ajouter des variables, cliquez sur Done editing.
Si le dashboard inclut un widget, cliquez sur le bouton + Add variable.

Terminez le workflow Add variable. Vous trouverez ci-dessous quelques règles et conseils pour chacun des domaines.

Champ	Détails
Nom à utiliser dans la requête	Le nom de la variable. C'est ce que vous utiliserez dans la requête, entouré de `{{...}}`. Par exemple, si vous utilisez `country` ici comme nom, alors lors de l'écriture d'une requête, vous appellerez la variable avec `{{country}}`. Les noms de variables doivent commencer par une lettre et peuvent contenir des lettres, des chiffres et des traits de soulignement.
Nom d'affichage	Facultatif. Voici comment la variable s'affichera au-dessus du dashboard afin que l'utilisateur dashboard sache ce que la variable représente. Si ce champ est laissé vide, la valeur du nom principal sera utilisée.
Type	Il existe trois options : Query:Vous pouvez écrire une requête qui renverra une liste dynamique d'options utilisées dans le menu déroulant. Par exemple, la requête suivante renverrait une liste dynamique de `country` valeurs : `SELECT uniques(countryCode) FROM PageAction SINCE 2 days ago` Pour les règles et conseils sur l'écriture de requêtes, voir les variables de type requête. List:Une liste de valeurs séparées par des virgules qui sont utilisées pour remplir les options dans le menu déroulant. Par exemple, vous pouvez définir manuellement une liste de valeurs `country` à l'aide d'une liste comme : `ES, US, CA.` Text field:Au lieu d'une liste déroulante de valeurs parmi lesquelles choisir, cela permet à l'utilisateur dashboard de filtrer le texte qu'il saisit.
Compte	Présent uniquement pour le type `query` . Pour les organisations avec plusieurs comptes, cela définit le compte qui fait l'objet de la requête.
Qequête	Écrivez ici votre requête en utilisant `uniques(attribute)`.
Ignorer le sélecteur d'intervalle de temps	Facultatif. Présent uniquement pour le type de requête. En désactivant cette option, la requête sera exécutée en utilisant la valeur du sélecteur d'intervalle de temps sélectionné dans le dashboard. De cette façon, lorsque la valeur du sélecteur d'intervalle de temps change, les résultats de la liste déroulante de la variable répondront dynamiquement à la nouvelle plage de temps sélectionnée.
Sélection multiple	Facultatif. Cette option permet à une liste déroulante d'autoriser plusieurs sélections en même temps au lieu d'une seule sélection.
Valeurs par défaut	Facultatif. Ce sont les valeurs par défaut sur lesquelles le dashboard filtrera. Par exemple, si vous avez utilisé la requête `country` ci-dessus, vous pouvez saisir `ES` comme valeur par défaut et le dashboard filtrera automatiquement sur cette valeur. Vous pouvez également sélectionner toutes les possibilités. Pour utiliser plusieurs valeurs sur une clause `WHERE` , vous devez utiliser `IN` au lieu de `=`. La bascule Inclure la variable déterminera la configuration par défaut, inclure ou exclure, pour cette variable dans le dashboard. Cette configuration peut être modifiée par l'utilisateur visualisant le dashboard en utilisant le bouton Inclure la variable dans le menu déroulant de la liste des variables. La configuration sélectionnée par l'utilisateur sera valable pendant toute la durée de la session. Important Notez que vous ne pouvez configurer les valeurs par défaut que lorsque la bascule est définie pour inclure une variable. Une fois que vous avez sélectionné les valeurs par défaut, vous pouvez basculer la bascule pour que la variable ne soit pas incluse par défaut. Les valeurs par défaut seront présélectionnées lorsqu'un utilisateur tournera la bascule pour inclure la variable dans le menu déroulant de la liste des variables.
Format de sortie	Cela vous permet de modifier la manière dont les données générées par la variable sont traitées dans la requête. L'option sélectionnée que vous choisissez ici est liée à la requête que vous allez ajouter plus tard dans le widget. L'option default est une chaîne car il s'agit de l'option la plus courante utilisée dans la majorité des requêtes. Vous pouvez modifier l'option default par l'une des suivantes : String:Utilisez ceci pour les valeurs de texte non numériques. Number:Utilisez ceci pour les valeurs numériques. Identifier:Utilisez ceci lorsque vous souhaitez remplacer des parties de la requête, comme les noms d'événements ou les noms de facettes.

Voyez cet exemple de ce à quoi ressemblerait une variable de modèle pour les valeurs country :

Une fois que vous avez défini votre variable de modèle, vous pouvez ajouter un widget qui utilise votre variable de modèle créée.

Créer un widget qui utilise la variable de modèle

Une fois que vous avez configuré une variable de modèle, vous aurez besoin d'un widget sur un dashboard qui utilise la variable que vous avez définie dans leur requête.

Pour créer un widget :

Depuis votre dashboard cliquez sur le bouton + Add widget situé dans le coin supérieur droit.
Il y a 2 options :
- Ajouter un graphique. Vous créerez votre widget à l'aide du générateur de requêtes.
- Ajoutez du texte, des images ou des liens. Vous créerez votre widget en ajoutant votre propre contenu à l'aide de notre éditeur Markdown.
Nous choisissons l'option Add a chart .
Ajoutez votre requête et cliquez sur Run.
En suivant notre exemple mentionné à l’étape 1 :
```
SELECT countryCode 
FROM PageAction 
WHERE countryCode IN ({{countryCode}})
```
Notez que ce sont les clauses NRQL qui accepteront les variables de modèle comme valeurs : SELECT, FROM, FACET, ORDER BY et WHERE.
Au lieu de cela, la liste suivante de clauses NRQL n'acceptera pas de variables de modèle comme arguments : AS, COMPARE WITH, LIMIT, OFFSET, SINCE, SLIDE BY, TIMESERIES, UNTIL et WITH....
Cliquez Save

Une fois que vous avez terminé de définir une variable de modèle et d'ajouter un widget qui fait référence à cette variable, vous pouvez vérifier qu'il fonctionne comme prévu en choisissant différentes options dans la barre de variables de modèle et en voyant si le widget change en fonction de votre sélection.

Voici un exemple du widget résultant, à droite, avec la liste déroulante country à gauche.

Règles d'écriture d'une variable de modèle de type requête

Comme indiqué dans la section sur la définition des variables de modèle, il existe trois types de variables : requête, liste et champ de texte. La variable de type requête est la plus complexe à créer car vous devez créer une requête fonctionnelle qui renvoie une liste de valeurs, qui sont ensuite utilisées pour remplir la liste déroulante dans la barre de variables de modèle en haut du dashboard.

Important

Notez qu’il s’agit d’un sujet différent de l’écriture de requêtes qui utilisent une variable de modèle.

Vous pouvez utiliser presque n'importe quelle requête NRQL à condition qu'elle renvoie une liste de valeurs. Pour cela, vous pouvez utiliser soit les fonctions uniques soit keyset .

Avec uniques:

FROM PageAction SELECT uniques(countryCode)

-- you can use the second param to define the maximum number of results to be listed.
FROM PageAction SELECT uniques(countryCode, 10000) --> this will return up to 10k results

Avec keyset:

-- with `keyset`, you'll get a list with all of the attributes from the table you're querying from
FROM PageAction SELECT keyset() SINCE 1 day ago

Gardez à l’esprit que les variables imbriquées ne sont pas prises en charge car il ne peut pas y avoir de variables à l’intérieur des variables.

Quelques exemples

Voici quelques types différents d’implémentations de variables de modèle.

Vous pouvez activer l'option multi-valeurs à partir de la section des options d'affichage lors de la création d'une variable de type NRQL/ENUM.

Voici un exemple de requête qui crée une variable nommée {{MultiValue}} et renvoie une liste de tous les eventId uniques :

SELECT uniques(eventId) FROM AjaxRequest

Ensuite, vous créeriez un widget avec la requête suivante :

SELECT count(*) FROM AjaxRequest WHERE eventId IN ({{MultiValue}})

Vous ne pouvez définir qu'une seule variable de modèle à la fois, mais vous pouvez utiliser plusieurs variables de modèle dans un seul widget.

Voici un exemple de requête qui utilise deux variables de modèle. Notez que cela suppose que les variables de modèle countryCode et city ont déjà été créées et qu'elles ont une valeur unique.

SELECT countryCode, city FROM PageAction 
WHERE countryCode = {{countryCode}} AND city = {{city}}

Creating a widget using multiple variables

Si vous avez plusieurs valeurs pour vos variables, telles que Chicago, New York, Paris pour votre variable city , vous devez utiliser IN:

SELECT countryCode, city FROM PageAction 
WHERE countryCode IN ({{countryCode}}) AND city IN ({{city}})

En utilisant des variables et des expressions régulières, vous pouvez créer un filtre, à condition d'être sûr qu'une partie du filtre est fixe.

Vous devez utiliser cette correspondance partielle si vous souhaitez utiliser LIKE.

Disons que vous souhaitez filtrer par version de sortie. La requête renvoie quelque chose comme : release-1234.

Vous pouvez créer une variable en utilisant aparse pour analyser le numéro de version :

SELECT uniques(aparse(platformVersion, 'release-*')) FROM PageView

Créez ensuite un widget avec la requête suivante :

SELECT count(*) FROM PageAction 
WHERE aparse(platformVersion, 'release-*') IN ({{releaseversion}}) FACET platformVersion

Ou si vous préférez, vous pouvez utiliser la commande capture :

SELECT count(*) FROM PageAction 
WHERE capture(platformVersion, r'release-(?P<platformVersion>\d+)') IN ({{releaseversion}}) FACET platformVersion

Vous pouvez utiliser LIKE et RLIKE comme variables de modèle pour filtrer les données dans un dashboard. Pour utiliser cette fonctionnalité, la valeur que vous ajoutez lors de la création de la variable de modèle doit utiliser les symboles génériques % au début et à la fin de la valeur.

Voici un exemple. Vous définissez une variable de chaîne, comme indiqué ici :

Vous pouvez ensuite créer un graphique widget et utiliser votre variable comme ceci :

FROM NrdbQuery SELECT user WHERE user LIKE {{like_filter}}

ou comme ça :

FROM NrdbQuery SELECT user WHERE user RLIKE {{like_filter}}

Vous pouvez créer une variable de type NRQL avec un format de sortie de chaîne et l'utiliser après une clause FACET pour regrouper par différentes valeurs.

Par exemple, vous pouvez créer une variable nommée {{userAgentName}} qui ressemblerait à :

SELECT uniques(userAgentName) FROM PageAction

Ensuite, vous créerez un widget avec la requête suivante :

SELECT count(*) FROM PageAction 
WHERE userAgentName={{userAgentName}} FACET userAgentName

Vous pouvez créer une variable avec un format de sortie identifier et l'utiliser après une clause FACET pour regrouper par différentes valeurs.

Par exemple, vous pouvez créer une variable {{location}} de type liste avec deux valeurs possibles : countryCode et city. Vous devez définir le format de sortie sur identifier.

Adding the variable for dynamic grouping

Ensuite, vous créerez un widget avec la requête suivante :

SELECT count(*) FROM PageAction FACET {{location}}

Vous pouvez créer une variable avec le format de sortie number et l'utiliser dans une fonction percentile .

Par exemple, vous pouvez créer une variable {{percentile}} de type list avec deux valeurs possibles : 55 et 90. Vous souhaiterez définir le format de sortie sur number.

Adding the variable for dynamically change the percentile

Ensuite, vous créerez un widget avec la requête suivante :

SELECT percentile(duration, {{percentile}}) FROM PageAction

Adding the widget for dynamically change the percentile

Pour utiliser des variables pour le filtrage, il vous suffit d'ajouter la variable créée sur le côté droit d'une clause WHERE , comme ceci :

SELECT countryCode, city FROM PageAction 
WHERE countryCode IN ({{countryCode}})

Par défaut, l'option « ignorer le sélecteur d'intervalle de temps » est activée, ce qui signifie que la requête est toujours exécutée en utilisant la valeur de plage de temps par défaut 1 hour, même si le sélecteur d'intervalle de temps dans le dashboard a une valeur différente sélectionnée (ex. 5 minutes, 3 hours, etc.). L'exception pour ce cas est lorsque la requête a une plage horaire explicite définie avec une clause SINCE , comme par exemple :

SELECT uniques(eventId) 
FROM AjaxRequest 
SINCE 5 minutes ago

Les résultats seront de l'ordre des 5 dernières minutes.

Lorsque l'option "ignorer le sélecteur d'intervalle de temps" est désactivée, la requête s'exécutera avec la valeur sélectionnée dans le sélecteur d'intervalle de temps. Par exemple, si vous réglez le sélecteur d'intervalle de temps à 30 minutes, comme dans la capture d'écran ci-dessous, dans le formulaire d'édition des variables, le champ « ignorer le sélecteur d'intervalle de temps » sera désactivé.

Cela donne les valeurs des 30 dernières minutes. Lorsque vous définissez la valeur du sélecteur d'intervalle de temps sur Default et que votre requête comporte une clause SINCE , la dernière valeur sera utilisée pour exécuter la requête.

Parfois, vous avez des requêtes qui appliquent les mêmes règles à différents types de données. Voici des exemples de deux widgets identiques, à l'exception du type de données :

widget 1:

SELECT count(*) FROM DataType1 SINCE 1 day ago

widget 2:
```
SELECT count(*) FROM DataType2 SINCE 1 day ago
```
Au lieu de créer deux widgets séparés, vous pouvez créer un widget avec une variable qui a l'Identifier pour Output format. Ensuite, vous pouvez l'utiliser dans une clause FROM pour interroger différents types de données.
Par exemple, vous pouvez créer une variable {{dataType}} de type Liste avec deux valeurs possibles : DataType1 et DataType2. Vous définiriez le Output format sur Identifier:
Ensuite, vous devez créer et exécuter le widget :

Cette traduction automatique est fournie pour votre commodité.

Variables de modèle : filtrer dynamiquement le dashboard

Pourquoi utiliser des variables de modèle ?

Inclure et exclure des variables

Exemple

Exigences et limites

Utiliser des variables de modèle

Définir la variable de modèle

Important

Créer un widget qui utilise la variable de modèle

Règles d'écriture d'une variable de modèle de type requête

Important

Quelques exemples

Utiliser l'option à valeurs multiples

Utiliser plusieurs variables pour un widget

Utiliser des variables et une correspondance partielle

Utiliser des variables et des expressions régulières avec LIKE et RLIKE

Utiliser la variable `facet` avec une requête NRQL

Utiliser des variables pour le regroupement dynamique

Utiliser des variables pour modifier dynamiquement le percentile

Utiliser des variables pour filtrer

Utiliser l'option ignorer le sélecteur d'intervalle de temps

Utilisez des variables pour sélectionner votre type de données « FROM »

Cette traduction automatique est fournie pour votre commodité.

Variables de modèle : filtrer dynamiquement le dashboard

Pourquoi utiliser des variables de modèle ? .css-21sua1{background:none;border:none;width:0;padding:0;}

Inclure et exclure des variables

Exemple

Exigences et limites

Utiliser des variables de modèle

Définir la variable de modèle

Important

Créer un widget qui utilise la variable de modèle

Règles d'écriture d'une variable de modèle de type requête

Important

Quelques exemples

Utiliser plusieurs variables pour un widget

Utiliser des variables et une correspondance partielle

Utiliser des variables et des expressions régulières avec LIKE et RLIKE

Utiliser la variable facet avec une requête NRQL

Utiliser des variables pour le regroupement dynamique

Utiliser des variables pour modifier dynamiquement le percentile

Utiliser des variables pour filtrer

Utiliser l'option ignorer le sélecteur d'intervalle de temps

Utilisez des variables pour sélectionner votre type de données « FROM »

Pourquoi utiliser des variables de modèle ?

Utiliser la variable `facet` avec une requête NRQL