Présentation
Les dashboards recueillent des données à partir d’une multitude de sources et les affichent sous forme de visualisations.
Vous pouvez joindre des dashboards aux notifications de monitor, les utiliser comme screenboards pour observer des indicateurs techniques ou commerciaux clés, ou les référencer dans des runbooks pour fournir un contexte supplémentaire. Avec les dashboards, vous pouvez voir des instantanés de l’état actuel de votre plateforme ainsi que des interactions, afin de pouvoir anticiper les problèmes et les analyser plus en profondeur dans des pages spécialisées.
Dans la vidéo ci-dessous, un utilisateur consulte un dashboard récapitulatif pour une application Web. Cet utilisateur identifie un pic pour une métrique technique, agrandit l’intervalle pertinent pour obtenir plus de détails et accède au dashboard du host sous-jacent pour découvrir les causes potentielles à l’origine de ce problème.
Ce guide présente les liens contextuels dans vos dashboards et couvre les points suivants :
- Comment fonctionnent les liens contextuels et comment les adapter à vos besoins exacts.
- Exemples de cas d’usage de la configuration des liens contextuels.
Présentation des liens de contexte
Les liens de contexte permettent de passer des widgets d’un dashboard à d’autres pages Datadog ou à des applications tierces intégrées à vos workflows.
Les utilisateurs disposant d’autorisations de modification pour les dashboards peuvent configurer les liens disponibles dans la liste de liens.
Liens de contexte par défaut
Par défaut, le menu d’un widget affiche des liens vers votre host, vos traces et vos logs, ainsi que vers les sources de données du widget. Par exemple, si votre widget utilise des données RUM, son menu comporte un lien vers le RUM Explorer. Cliquez sur More Related Data Actions pour afficher des liens supplémentaires dans le menu déroulant.
Le widget inclut des liens vers les pages suivantes :
Les liens de contexte incluent, le cas échéant, les éléments suivants :
- Un filtre qui combine les filtres du widget avec les éventuelles template variables et, pour les requêtes groupées, avec la série avec laquelle l’utilisateur interagit.
- Un intervalle. Pour les widgets Série temporelle et Carte thermique, l’intervalle correspond au compartiment de temps du point de donnée. Pour les autres widgets, il s’agit de l’intervalle global du widget.
Personnaliser des liens de contexte
Pour tout widget générique, accédez à son mode de modification pour accéder à sa section Context Links. Vous pouvez créer vos propres liens contextuels, remplacer les liens par défaut et promouvoir ou masquer des liens.
Pour définir des liens personnalisés ou remplacer les liens par défaut, spécifiez le nom du lien dans le champ Label et le chemin du lien dans le champ URL. Cliquez sur + Add URL Parameter pour utiliser l’assistant clé-valeur.
Variables des liens de contexte
Vous pouvez utiliser les types de variables suivants pour les liens de contexte :
- Variables de plage temporelle
{{timestamp_start}} et {{timestamp_end}}. Ces variables correspondent à la plage temporelle du widget. - Les variables de requête (
{{@MerchantTier}} et {{@MerchantTier.value}} dans l’exemple ci-dessus). Ces variables peuvent être utilisées pour les widgets comportant des requêtes groupées. Elles identifient le groupe avec lequel l’utilisateur a interagi. - Les template variables de dashboard (
{{$env}} et {{$env.value}} dans l’exemple ci-dessus). Ces variables identifient la valeur actuelle d’une template variable avec laquelle l’utilisateur a interagi. {{tags}}, la combinaison par défaut de toutes les variables ci-dessus.
Pour choisir entre la variable {{exemple}} et {{exemple.value}}, tenez compte de ce qui suit :
Pour cet exemple, lorsque vous cliquez sur View in Acme, vous êtes redirigé vers https://prod.acme.io/search?what=basic&when=1643021787564.
The context link:
- remplace
{{env.value}} par prod ; - remplace
{{@MerchantTier.value}} par basic ; et - remplace
{{timestamp_end}} par 1643021787564.
Copier/coller des liens de contexte pour amorcer une configuration
Pour utiliser des liens de contexte avancés qui encodent un grand nombre de paramètres, il peut s’avérer plus pratique de copier/coller toute l’URL dans le champ URL, afin d’amorcer la configuration, puis de modifier les variables à partir du résultat obtenu.
Encodage des URL
Datadog prend en charge l’encodage des URL dans les liens de contexte.
Le lien de l’exemple ci-dessus comporte un paramètre de requête, à savoir status:error source:nginx {{@shopist.webstore.merchant.tier}}. Pour ce paramètre, {{@shopist.webstore.merchant.tier}} est interprété comme @shopist.webstore.merchant.tier:basic. Le paramètre de requête complet est ensuite remplacé par &query=status%3Aerror%20source%3Anginx%20%40shopist.webstore.merchant.tier%3Abasic.
Exemples de cas d’utilisation
Les exemples de cette section vous permettent de comprendre comment intégrer vos dashboards à vos workflows grâce aux liens de contexte.
Ajouter à des dashboards des liens vers la solution d’assistance d’un client
L’exemple suivant décrit la procédure à suivre pour créer un lien depuis un utilisateur dans un dashboard vers la page Zendesk de cet utilisateur.
Contexte
Imaginons que vous utilisez Datadog pour surveiller votre site d’e-commerce. Votre équipe d’assistance clientèle se sert d’un dashboard configuré par vos équipes Frontend et Sécurité afin d’identifier de façon proactive vos clients les plus engagés, ou vos clients qui rencontrent des problèmes, et d’interagir potentiellement avec eux.
Pour accélérer ce workflow de dépannage, votre équipe d’assistance clientèle souhaiterait bénéficier d’un lien direct entre les dashboards et la solution d’assistance, par exemple Zendesk.
Approche
L’adresse e-mail des utilisateurs constitue le principal identifiant permettant de surveiller dans Datadog les utilisateurs connectés à votre plateforme. Il s’agit d’une facette qui est disponible dans certains widgets de dashboard.
Voici un exemple de lien Zendesk permettant de rechercher un utilisateur : https://acme.zendesk.com/agent/search/1?type=user&q=email%3Ashane%40doe.com. L’adresse e-mail de l’utilisateur représente le paramètre de recherche.
Ajoutez une variable à l’URL, pour que le lien du modèle soit remplacé par https://acme.zendesk.com/agent/search/1?type=user&q=email:{{@usr.email.value}}.
Résultat
Le widget de dashboard de votre équipe d’assistance clientèle contient un lien de contexte permettant d’accéder à la plateforme d’assistance sans perdre le contexte pertinent.
Si vous cliquez sur le lien Zendesk User Page, vous êtes redirigé vers la page Zendesk de l’utilisateur en question.
Ajouter à un dashboard des liens vers la console AWS
L’exemple suivant explique comment créer un lien depuis un host dans un widget de dashboard vers sa page d’instance Amazon EC2 correspondante dans la console AWS.
Contexte
Votre plateforme est hébergée sur des instances Amazon EC2, et les procédures pour augmenter et réduire l’échelle de votre plateforme sont principalement manuelles.
Vous disposez d’un dashboard Datadog présentant des métriques de santé clés sur votre infrastructure.
Pour accélérer ce workflow opérationnel, vous souhaitez bénéficier d’un lien direct entre ce dashboard et votre console AWS, par exemple pour passer d’une instance t2.micro à t2.large.
Approche
Un lien de résumé d’instance Amazon EC2 typique est https://eu-west-3.console.aws.amazon.com/ec2/v2/home?region=eu-west-3#InstanceDetails:instanceId=i-04b737b9f8bf94a94, où vous pouvez lire :
eu-west-3 : la région du centre de données, affichée sous la forme d’un sous-domaine et d’un paramètre d’URL.i-04b737b9f8bf94a94 : l’ID du host, affiché sous la forme d’un paramètre de hachage.
Si votre plateforme s’exécute uniquement dans une région, injectez l’ID de host dans le lien de contexte, afin d’obtenir le lien suivant : https://eu-west-3.console.aws.amazon.com/ec2/v2/home?region=eu-west-3#InstanceDetails:instanceId={{host.value}}.
Si votre plateforme s’exécute dans plusieurs régions, la configuration de votre widget varie en fonction de ce qui suit :
- Si la région est intégrée dans l’agrégation de la requête (comme dans la capture d’écran ci-dessous), le lien du modèle correspond à
https://{{region.value}}.console.aws.amazon.com/ec2/v2/home?region={{region.value}}#InstanceDetails:instanceId={{host.value}}. {{region.value}} est alors une variable de requête.
- Si la région est intégrée à l’agrégation de la requête (comme dans la capture d’écran ci-dessous), le lien du modèle correspond à
https://{{$region.value}}.console.aws.amazon.com/ec2/v2/home?region={{$region.value}}#InstanceDetails:instanceId={{host.value}}, {{region.value}} est alors une template variable.
Résultat
Le widget de votre dashboard contient un lien redirigeant vers le host pertinent dans la console AWS.
Cliquer sur le lien Amazon EC2 Instance Summary vous dirige vers la page de l’instance Amazon EC2 dans la console AWS.
Ajouter à un dashboard des liens vers des vues enregistrées et des attributs remappés dans Datadog
L’exemple suivant décrit la procédure à suivre pour créer un lien depuis un événement RUM d’un widget de dashboard vers les logs correspondants.
Contexte
Imaginons que vous surveillez le site de votre entreprise avec Datadog. Vous pouvez utiliser la solution RUM pour mieux comprendre le comportement de vos utilisateurs et les logs pour superviser la dimension technique de vos API Gateways.
Vos ingénieurs frontend utilisent régulièrement des dashboards comportant des données RUM globales. Votre équipe responsable des API Gateways gère une vue enregistrée dans le Log Explorer. Cette ressource a été personnalisée afin de permettre à l’équipe de surveillance du frontend d’accéder aux informations dont elle a réellement besoin.
Pour accélérer ce workflow de dépannage, l’équipe de surveillance du frontend souhaiterait pouvoir accéder à la vue enregistrée tout en conservant le contexte actuel du dashboard.
Approche à suivre pour les vues enregistrées
Les vues enregistrées vous permettent de définir la requête par défaut, la visualisation et les options de configuration du Log Explorer. Voici un exemple de lien vers une vue enregistrée : https://app.datadoghq.com/logs?saved_view=305130. Ce lien encode l’URL du Log Explorer.
Vous pouvez ajouter des informations à la fin du lien court de la vue enregistrée afin de remplacer des paramètres de l’URL du Log Explorer obtenue.
Par exemple, le lien https://app.datadoghq.com/logs?saved_view=305130&query=@source:nginx @network.client.ip:123.123.12.1 renvoie vers la vue Log Explorer obtenue si vous aviez ouvert la vue enregistrée, à l’exception près que le filtre de requête par défaut a été remplacé par @source:nginx @network.client.ip:123.123.12.1.
Approche à suivre pour le remappage d’attributs
Si la navigation sur votre site Web est anonyme, vous pouvez utiliser une adresse IP comme proxy pour identifier vos utilisateurs.
Imaginons que vous cherchiez à identifier les utilisateurs pour l’attribut @session.ip de vos événements RUM avec l’attribut @network.client.ip de vos logs. Ces attributs ne possèdent pas le même nom, car ils n’ont pas la même signification. Toutefois, pour les logs d’authentification, vous pouvez identifier les utilisateurs pour les deux les deux.
Pour ce faire, injectez l’attribut @session.ip dans un filtré basé sur @network.client.ip, puis créez le filtre @network.client.ip:{{@session.ip.value}} approprié.
Si vous utilisez un widget de dashboard RUM qui présente des informations sur l’IP des sessions pour certains pays, utilisez la configuration suivante pour vos liens.
Résultat
Si l’équipe responsable des API Gateways modifie la vue enregistrée afin de tenir compte des derniers changements apportés aux logs entrants, le lien de contexte continue à fonctionner.
Le remappage de l’adresse IP crée un lien de contexte qui permet d’associer vos événements RUM aux logs correspondants.
L’exemple suivant explique comment configurer plusieurs variables et conditions dans votre requête de lien contextuel.
Contexte
Ajoutez des liens contextuels pour investiguer des logs ou des conditions spécifiques.
- Vous avez plusieurs valeurs de tag avec le même contexte (par exemple,
env:production OR env:prod). - Vous souhaitez filtrer les logs selon plusieurs conditions (par exemple,
env:prod AND service:backend)
Approche
Après avoir sélectionné les template variables que vous souhaitez dépanner, la configuration du lien contextuel prend ces template variables et les insère dans la requête. Remarque : la syntaxe et l’encadrement par des parenthèses impactent la requête.
Par exemple, si vous souhaitez configurer un lien contextuel avec service:backend AND (env:production OR env:prod), utilisez la configuration suivante :
service:backend (env:{{$env.value}})
Résultat
Les parenthèses traduisent le (env:{{$env.value}}) en (env:*), ce qui vous permet d’entrer plusieurs variables dans votre requête de liens contextuels.
Pour aller plus loin
Documentation, liens et articles supplémentaires utiles:
