Aperçu
Les variables de modèle vous permettent de filtrer ou de regrouper dynamiquement les widgets dans un tableau de bord. Vous pouvez créer des vues enregistrées à partir de vos sélections de variables de modèle pour organiser et naviguer dans vos visualisations via les sélections déroulantes.
Une template variable est définie par les éléments suivants :
- Tag or Attribute :
- Name : Un nom unique pour la variable de modèle qui apparaît dans les requêtes sur le tableau de bord. Les variables de modèle sont automatiquement nommées d’après le tag ou l’attribut sélectionné.
- Default Value : La valeur du tag ou de l’attribut qui apparaît automatiquement lorsque le tableau de bord est chargé. Par défaut, cela correspond à
*. - Available Values : Les valeurs de tag ou d’attribut disponibles pour sélection dans le menu déroulant. Par défaut, cela correspond à
(all). La liste des valeurs disponibles inclut toujours *, qui interroge toutes les valeurs du tag ou de l’attribut.
Valeurs des variables de modèle
Les valeurs des variables de modèle (valeurs disponibles via les menus déroulants des variables de modèle) sont peuplées en fonction des sources utilisées par les widgets dans le tableau de bord. Par exemple, si votre tableau de bord a des widgets interrogeant des journaux, seules les valeurs des journaux sont affichées. Si votre tableau de bord a des widgets interrogeant des journaux, des métriques et du RUM, les valeurs des journaux, des métriques et du RUM sont affichées.
Pour la plupart des sources, les valeurs des variables de modèle sont pertinentes pour le cadre temporel global de votre tableau de bord. Exemple :
- Si le cadre temporel de votre tableau de bord est réglé sur les 15 dernières minutes, seules les valeurs des variables de modèle des 15 dernières minutes sont affichées.
- Si le cadre temporel de votre tableau de bord est réglé sur le 15 août dernier de 00h00 à 23h59, seules les valeurs de ce cadre temporel sont affichées.
| Source de données | Période de requête de données |
|---|
| Métriques | Maintenant - 48 heures |
| Coût du cloud | Maintenant - 48 heures |
| Toutes les autres sources | Cadre temporel du tableau de bord |
Remarque : Si vous ne voyez pas le tag ou l’attribut que vous recherchez, cela peut être dû au fait que ces données n’ont pas été récemment signalées à Datadog. De plus, toutes les données interrogées pour les variables de modèle sont soumises à la politique de conservation des données. Pour plus d’informations, voir Données historiques.
Disposition du tableau de bord
Pour éviter que les variables n’encombrent l’en-tête, le tableau de bord affiche un petit sous-ensemble. Vous pouvez cliquer sur le bouton + N pour voir les N variables supplémentaires présentes sur votre tableau de bord.
Si vous avez besoin de voir toutes les variables en même temps en faisant défiler, cliquez sur Développer les variables de modèle.
Ajouter une variable de modèle
Pour ajouter une template variable dans un dashboard :
- Cliquez sur Add Variable (ou + s’il y a des variables de modèle existantes)
- Sélectionnez dans une liste de variables de modèle recommandées ou recherchez le tag spécifique que vous avez en tête.
- Sélectionnez les widgets auxquels appliquer cette variable de modèle.
- Cliquez sur Save.
Lorsque le panneau latéral de la variable de modèle est ouvert, vous pouvez :
- Appliquer (ou retirer) cette variable aux widgets sélectionnés : notez les options Select All ou Deselect All
- Basculer entre le filtrage et le regroupement
- Modifier le nom d’affichage de la variable (affiché dans l’en-tête et la requête du widget)
- Sélectionner une valeur par défaut dans le menu déroulant
- Aperçu des valeurs du menu déroulant et configuration supplémentaire avec une requête de recherche
Modifier une variable de modèle
- Survolez la variable de modèle dans l’en-tête du tableau de bord et cliquez sur Modifier. Le panneau latéral de la variable de modèle apparaît.
- Utilisez les options dans le panneau pour personnaliser la variable ou appliquer la variable à d’autres widgets.
Vues enregistrées
Créer
- Cliquez sur le menu déroulant Saved Views à gauche des variables de modèle dans votre tableau de bord. Lorsque vous mettez à jour une valeur de variable de modèle, la valeur ne se sauvegarde pas automatiquement dans une vue.
- Pour enregistrer les valeurs actuelles de vos variables de modèle dans une vue, sélectionnez Save selections as view dans le menu déroulant Saved Views.
- Entrez un nom unique pour la vue avec une description optionnelle.
- Cliquez sur Save.
Votre vue enregistrée apparaît dans le menu déroulant. Cliquez sur la vue pour récupérer les valeurs de variable de modèle que vous avez précédemment enregistrées.
Supprimer
- Cliquez sur le menu déroulant des vues enregistrées et survolez la vue enregistrée souhaitée.
- Cliquez sur Delete View.
Modifier
Le Default view ne peut être modifié qu’en changeant les valeurs par défaut des variables de modèle. Pour modifier la Vue par Défaut :
- Survolez les modèles.
- Cliquez Edit lorsque le bouton apparaît.
- Cliquez Done pour enregistrer.
Pour modifier les valeurs des variables de modèle pour d’autres vues enregistrées :
- Sélectionnez la vue enregistrée souhaitée dans le menu déroulant.
- Modifiez les variables de modèle pour obtenir les nouveaux modèles souhaités.
- Ouvrez à nouveau le menu déroulant.
- Cliquez Save Changes.
Pour modifier le titre et la description :
- Survolez la vue enregistrée souhaitée dans le menu déroulant.
- Cliquez Edit.
- Modifiez le titre ou la description.
- Cliquez sur Save.
Utilisation
Les templates variables peuvent être utilisées dans les widgets et dans les recherches d’événements à superposer.
Journaux, APM et requêtes RUM
Les variables de modèle fonctionnent avec les widgets de journaux, APM et RUM car elles partagent les mêmes tags. Vous pouvez définir des variables de modèle de journaux, APM et RUM en fonction des facettes. Ces variables commencent par @, par exemple : @http.status_code.
Sur les widgets de journaux, APM et RUM, vous pouvez utiliser des jokers au milieu d’une valeur (par exemple, eng*@example.com) ou utiliser plusieurs jokers dans une valeur (par exemple, *prod*).
Remarque : L’utilisation de Add to all pour ce type de variable de modèle ajoute la variable à tous les widgets de journaux, APM et RUM.
Lors de la création ou de la modification d’un widget, les variables de modèle de filtre existantes s’affichent comme options dans le champ from, et les variables de modèle de regroupement existantes s’affichent comme options après le champ by. Par exemple, si vous configurez la variable de modèle environment, l’option $environment est disponible en tant que variable dynamique dans le widget.
Sélectionner production pour la valeur environment limite dynamiquement les widgets avec la variable $environment à l’environnement de production.
Lorsque vous changez la valeur d’une variable de modèle, l’URL du tableau de bord se met à jour pour refléter la valeur de la variable de modèle au format &tpl_var_<TEMPLATE_VARIABLE_NAME>=<TEMPLATE_VARIABLE_VALUE>. Par exemple, un tableau de bord avec la variable de modèle $env changée en prod aurait le paramètre d’URL &tpl_var_env=prod.
Pour inclure la valeur dans la requête, ajoutez-la avec la syntaxe $<TEMPLATE_VARIABLE_NAME>.value. Par exemple, avec une variable de modèle nommée service, utilisez env:staging-$service.value.
Survolez les champs des template variable pour voir d’un coup d’œil les widgets qui utilisent cette variable surlignée sur le dashboard.
Variables de modèle associées
Lors de la sélection d’une valeur de variable de modèle, les valeurs associées s’affichent en haut du sélecteur. Les valeurs associées sont calculées à partir d’autres valeurs de variables de modèle sélectionnées sur la page et identifient de manière transparente les valeurs connexes sans aucune configuration.
Texte
Pour les widgets basés sur du texte, vous pouvez afficher le tag/attribut et la valeur d’une variable de modèle avec $<TEMPLATE_VARIABLE_NAME>, sa clé avec $<TEMPLATE_VARIABLE_NAME>.key, ou sa valeur avec $<TEMPLATE_VARIABLE_NAME>.value. Cela peut venir après tout caractère non alphanumérique et peut être suivi d’un espace ou de l’un des caractères suivants : #, $, %, =, ;, ", (, ), [, ], {, }, ^, *, +, | et ?.
Remarque : La syntaxe des jokers n’est pas prise en charge après une variable de modèle.
Par exemple, avec une variable de modèle nommée env, avec le tag/attribut environment, et avec une valeur sélectionnée de dev :
$env affiche environment:dev$env.key affiche environment$env.value affiche dev$env* recherche la valeur exacte dev* PAS dev{dynamic-wildcard-value}
Superposition des événements
Utilisez la recherche de superposition des événements avec des variables de modèle pour trouver des événements qui partagent certains tags avec les métriques de votre tableau de bord. La recherche de superposition des événements est appliquée à travers un graphique individuel.
Les valeurs des variables de modèle du tableau de bord peuvent être directement capturées en utilisant la syntaxe $<TEMPLATE_VARIABLE_KEY>.value dans le champ de recherche d’événements.
Remarque : Les variables de modèle du tableau de bord doivent être des tags de métriques, pas des tags d’événements.
Dashboard
Pour rechercher des événements à l’aide de template variables depuis votre dashboard, utilisez le format suivant :
<TAG_KEY>:$<TEMPLATE_VARIABLE_NAME>.value
Par exemple, rechercher region:$region.value avec une valeur de us-east1 pour la variable de modèle region affiche des événements avec le tag region:us-east1. De plus, le timing des événements est marqué par des barres roses dans les graphiques.
Utilisez des virgules pour rechercher en utilisant plusieurs variables de modèle, par exemple : role:$role.value,env:$env.value
Remarque : Une fois que vous appuyez sur enter pour rechercher, $region.value se met à jour avec la valeur dans le menu déroulant de la variable de modèle.
Depuis un widget, utilisez les template variables pour visualiser à quel moment les événements se sont produits. Utilisez le format suivant :
$<TEMPLATE_VARIABLE_NAME>
Par exemple, entrez $region dans la boîte de recherche des superpositions d’événements. Cela recherche des événements avec la valeur dans le menu déroulant de la variable de modèle region.
Lectures complémentaires
Documentation, liens et articles supplémentaires utiles:
