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.
Cette rubrique de documentation est conçue pour les espaces de travail Grafana compatibles avec la version 10.x de Grafana.
Pour les espaces de travail Grafana compatibles avec la version 9.x de Grafana, voir. Travailler dans la version 9 de Grafana
Pour les espaces de travail Grafana compatibles avec la version 8.x de Grafana, voir. Travailler dans la version 8 de Grafana
Les annotations permettent de marquer des points sur une visualisation à l'aide d'événements riches. Ils sont visualisés sous forme de lignes verticales et d'icônes sur tous les panneaux graphiques. Lorsque vous survolez une annotation, vous pouvez obtenir la description de l'événement et les balises de l'événement. Le champ de texte peut inclure des liens vers d'autres systèmes plus détaillés.
Vous pouvez annoter les visualisations de trois manières :
-
Directement dans le panneau, à l'aide de la requête d'annotations intégrée.
-
Utilisation de l'API HTTP de Grafana.
-
Configuration des requêtes d'annotation dans les paramètres du tableau de bord.
Dans les deux premiers cas, vous créez de nouvelles annotations, tandis que dans le dernier, vous interrogez des annotations existantes à partir de sources de données. La requête d'annotation intégrée prend également cela en charge.
Cette section explique les première et troisième options ; pour plus d'informations sur l'utilisation de l'API HTTP Grafana, reportez-vous à. API d'annotations
Les annotations sont prises en charge pour les types de visualisation suivants :
-
Séries chronologiques
-
Chronologie de l'État
-
Candlestick (Chandelier)
Création d'annotations dans des panneaux
Grafana permet d'ajouter des événements d'annotation directement à partir d'un panneau à l'aide de la requête d'annotations intégrée qui existe sur tous les tableaux de bord. Les annotations que vous créez de cette manière sont stockées dans Grafana.
Pour ajouter des annotations directement dans le panneau :
-
Le tableau de bord doit déjà être enregistré.
-
La requête intégrée doit être activée.
Pour ajouter une annotation
-
Dans le tableau de bord, sélectionnez le panneau dans lequel vous souhaitez ajouter l'annotation. Un menu contextuel s'affichera.
-
Dans le menu contextuel, sélectionnez Ajouter une annotation.
-
(Facultatif) Ajoutez une description de l'annotation et des balises.
-
Sélectionnez Save.
Sinon, pour ajouter une annotation, appuyez sur Ctrl (ouCmd) pendant que vous sélectionnez le panneau, et la fenêtre contextuelle Ajouter une annotation apparaîtra.
Annotations régionales
Vous pouvez également créer des annotations qui couvrent une région ou une période dans une visualisation.
Pour ajouter une annotation de région
-
Dans le tableau de bord, appuyez sur
Ctrl(ouCmd) tout en sélectionnant une zone du panneau. -
Ajoutez une description de l'annotation et des balises (facultatif).
-
Cliquez sur Sauvegarder
Pour modifier une annotation
-
Dans le tableau de bord, survolez un indicateur d'annotation sur un panneau.
-
Sélectionnez l'icône Modifier (crayon) dans l'infobulle d'annotation.
-
Modifiez la description et/ou les balises.
-
Sélectionnez Save.
Pour supprimer une annotation
-
Dans le tableau de bord, survolez un indicateur d'annotation sur un panneau.
-
Sélectionnez l'icône Supprimer (corbeille) dans l'infobulle d'annotation.
Récupérez les annotations via les paramètres du tableau de bord
Dans les paramètres du tableau de bord, sous Annotations, vous pouvez ajouter de nouvelles requêtes pour récupérer des annotations à l'aide de n'importe quelle source de données, y compris la source de données d'annotation de données intégrée. Les requêtes d'annotation renvoient des événements qui peuvent être visualisés sous forme de marqueurs d'événements dans les graphiques du tableau de bord.
Pour ajouter une nouvelle requête d'annotation
-
Sélectionnez l'icône Paramètres (engrenage) dans l'en-tête du tableau de bord pour ouvrir le menu des paramètres.
-
Sélectionnez Annotations.
-
Cliquez sur Ajouter une requête d'annotation.
-
Entrez le nom de la requête d'annotation.
Ce nom est donné au bouton (case à cocher) qui vous permettra d'activer l'affichage des événements d'annotation issus de cette requête.
-
Sélectionnez la source de données pour les annotations.
Vous pouvez également choisir Ouvrir le sélecteur de source de données avancé pour voir d'autres options, notamment l'ajout d'une nouvelle source de données (disponible uniquement pour les administrateurs).
-
Si vous ne souhaitez pas utiliser la requête d'annotation immédiatement, décochez la case Activé.
-
Si vous ne souhaitez pas que le bouton de requête d'annotation soit affiché dans le tableau de bord, cochez la case Masqué.
-
Sélectionnez une couleur pour les marqueurs d'événements.
-
Dans le menu déroulant Afficher dans, choisissez l'une des options suivantes :
-
Tous les panneaux — Les annotations sont affichées sur tous les panneaux qui prennent en charge les annotations.
-
Panneaux sélectionnés : les annotations sont affichées sur tous les panneaux que vous sélectionnez.
-
Tous les panneaux sauf : les annotations sont affichées sur tous les panneaux sauf ceux que vous sélectionnez.
-
-
Configurez la requête.
Les options de requête d'annotation sont différentes pour chaque source de données. Pour plus d'informations sur les annotations dans une source de données spécifique, consultezConnexion aux sources de données.
Requête intégrée
Une fois que vous avez ajouté une annotation, elle sera toujours visible. Cela est dû à la requête d'annotation intégrée qui existe sur tous les tableaux de bord. Cette requête d'annotation récupérera tous les événements d'annotation provenant du tableau de bord actuel, qui sont stockés dans Grafana, et les affichera sur le panneau où ils ont été créés. Cela inclut les annotations de l'historique de l'état des alertes.
Par défaut, la requête d'annotation intégrée utilise la source de données Grafana spéciale, et les annotations manuelles ne sont prises en charge qu'avec cette source de données. Vous pouvez utiliser une autre source de données dans la requête d'annotation intégrée, mais vous ne pourrez créer des annotations automatisées qu'à l'aide de l'éditeur de requêtes correspondant à cette source de données.
Pour ajouter des annotations directement au tableau de bord, cette requête doit être activée.
Pour confirmer que la requête intégrée est activée
-
Sélectionnez l'icône des paramètres du tableau de bord (engrenage) dans l'en-tête du tableau de bord pour ouvrir le menu des paramètres du tableau de bord.
-
Sélectionnez Annotations.
-
Trouvez la requête Annotations et alertes (intégrée).
S'il est indiqué Désactivé avant le nom de la requête, vous devrez sélectionner le nom de la requête pour l'ouvrir et mettre à jour le paramètre.
Pour empêcher les annotations d'être extraites et dessinées
-
Sélectionnez l'icône des paramètres du tableau de bord (engrenage) dans l'en-tête du tableau de bord pour ouvrir le menu des paramètres du tableau de bord.
-
Sélectionnez Annotations.
-
Sélectionnez la requête Annotations et alertes (intégrée).
-
Sélectionnez le bouton Activé pour le désactiver.
Lorsque vous copiez un tableau de bord à l'aide de la fonctionnalité Enregistrer sous, il obtient un nouvel identifiant de tableau de bord, de sorte que les annotations créées sur le tableau de bord source ne seront plus visibles sur la copie. Vous pouvez toujours les afficher si vous ajoutez une nouvelle requête d'annotation et que vous filtrez par balises. Toutefois, cela ne fonctionne que si les annotations du tableau de bord source contenaient des balises à filtrer.
Filtrer les requêtes par tag
Vous pouvez créer de nouvelles requêtes pour récupérer des annotations à partir de la requête d'annotation intégrée à l'aide de la source de Grafana données en définissant Filter by sur. Tags
Par exemple, créez un nom de requête d'annotation outages et spécifiez une baliseoutage. Cette requête affichera toutes les annotations (depuis n'importe quel tableau de bord ou via une API) avec le outage tag. Si plusieurs balises sont définies dans une requête d'annotation, Grafana n'affichera que les annotations correspondant à toutes les balises. Pour modifier le comportement, activez Match any, et Grafana affichera les annotations contenant l'une des balises que vous avez fournies.
Vous pouvez également utiliser des variables de modèle dans la requête de balise. Cela signifie que si vous disposez d'un tableau de bord affichant les statistiques de différents services et d'une variable de modèle qui indique les services à afficher, vous pouvez utiliser la même variable de modèle dans votre requête d'annotation pour n'afficher que les annotations relatives à ces services.
