Ajouter du texte et des regroupements à un tableau de bord

Les widgets de texte, d'en-tête de section et de groupe d'un tableau de bord personnalisé dans Cloud Monitoring vous permettent de documenter les étapes de dépannage et d'organiser de grandes collections de graphiques. Vous pouvez utiliser des widgets de texte Markdown pour afficher des liens et des conseils opérationnels, et des en-têtes de section pour générer une table des matières navigable. Pour réduire l'encombrement visuel et améliorer les temps de chargement des tableaux de bord, vous pouvez regrouper les widgets dans des groupes réductibles, déroulants ou à onglets.

Ce document explique comment ajouter ces widgets à l'aide de la consoleGoogle Cloud . Pour en savoir plus sur l'utilisation de l'API Cloud Monitoring, consultez Créer et gérer des tableaux de bord par API.

Avant de commencer

Effectuez les opérations suivantes dans le projet Google Cloud où vous souhaitez créer et modifier des tableaux de bord personnalisés :

Ajouter du texte à un tableau de bord

La capture d'écran suivante illustre un widget de texte :

Exemple de tableau de bord avec un widget Text.

Les informations de cette section concernent la console Google Cloud . Pour en savoir plus sur l'utilisation de l'API Cloud Monitoring, consultez Tableau de bord avec un widget Text.

Pour ajouter un widget de texte à un tableau de bord, procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page  Tableaux de bord :

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte ou le projet de gestion App Hub.
  3. Sélectionnez un tableau de bord ou cliquez sur Créer un tableau de bord.
  4. Dans la barre d'outils, cliquez sur  Ajouter un widget.
  5. Dans la boîte de dialogue Ajouter un widget, accédez à la section Mise en page, puis sélectionnez Texte.
  6. Ajoutez un titre.

  7. Dans le volet Contenu, saisissez le texte que vous souhaitez afficher.

    Pour en savoir plus sur la mise en forme, consultez Syntaxe Markdown.

  8. Facultatif : Utilisez les champs du volet Affichage pour personnaliser votre contenu.

    Par exemple, vous pouvez configurer la visibilité du widget.

  9. Pour appliquer vos modifications au tableau de bord, cliquez sur Appliquer dans la barre d'outils. Pour supprimer vos modifications, cliquez sur Annuler.

  10. Pour enregistrer votre tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Syntaxe Markdown

Cette section décrit la majeure partie de la syntaxe Markdown compatible avec le widget de texte. Les balises HTML ne sont pas acceptées.

  • Headers

    Une ligne commençant par un dièse, #, indique un en-tête. Vous pouvez utiliser plusieurs signes dièse pour différents niveaux d'en-têtes. Par exemple, pour un en-tête de premier niveau, utilisez un seul dièse : # Header. Pour un en-tête de deuxième niveau, utilisez deux dièses : ## Second-level header.

  • Paragraphes

    Pour créer un paragraphe, utilisez une ligne vide.

  • Mise en avant

    • Italique : utilisez *italic* ou _italic_.
    • Gras : utilisez **bold** ou __bold__.
    • Gras et italique : utilisez ***bold and italic***.
    • Police à chasse fixe : utilisez des accents graves, `fixed font`.

  • Liens : format [link text](path).

    Vous pouvez utiliser n'importe quelle valeur pour link text. La valeur de path doit faire référence à une ancre HTML dans le tableau de bord ou être l'URL d'une page externe.

    • Pour créer un lien vers une autre section du tableau de bord, définissez path sur l'ancre de la section. L'ancre d'une section est le titre de la section, converti en minuscules, avec des mots séparés par un trait d'union. Par exemple, pour créer un lien vers une section intitulée "Graphiques utilisant des variables", définissez path sur #charts-using-variables.

    • Pour créer un lien vers une ressource externe, définissez path sur l'URL. Par exemple, pour créer un lien vers example.com, définissez path sur https://example.com/.

  • Listes : vous pouvez créer des listes ordonnées ou non ordonnées, et imbriquer des listes.

    • Pour les listes numérotées, ajoutez le préfixe 1. à chaque élément de la liste. Lorsque le texte est affiché, les éléments sont numérotés de manière séquentielle. Exemple :

      1. Ordered list item 1
1. Ordered list item 2

    • Pour les listes à puces, ajoutez un signe plus (+), un tiret (-) ou un astérisque (*) devant chaque élément de la liste. Exemple :

      + Unordered list item 1
+ Unordered list item 2

    • Pour imbriquer des listes, appliquez un retrait à la liste imbriquée. Exemple :

      1.  Item 1
    + Nested unordered-list item 1
    + Nested unordered-list item 2
1.  Item 2
    1. Nested ordered-list item 1
    1. Nested ordered-list item 2

  • Variables : format ${VARIABLE_NAME}.

    Le widget de texte n'affiche que la ou les valeurs de la variable. Par exemple, si vous avez une variable basée sur des étiquettes dont la clé est zone et la valeur est us-west1, le widget de texte affiche us-west1.

    Lorsque la valeur d'une variable est le caractère générique (*), le widget de texte affiche all.

    Les variables non reconnues sont affichées telles qu'elles sont écrites et ne sont pas affichées.

  • Échappement de caractères

    Certains caractères, comme les signes plus (+), sont convertis en éléments de liste. Si vous souhaitez afficher ces types de caractères littéralement, utilisez une barre oblique inverse pour échapper le caractère, \+.

Organiser les widgets du tableau de bord

Les tableaux de bord personnalisés vous permettent de spécifier la position des graphiques, des règles d'alerte et d'autres widgets. Toutefois, vous pouvez améliorer la facilité d'utilisation d'un tableau de bord comportant de nombreux widgets en créant des sections dans votre tableau de bord ou en regroupant les widgets :

  • Pour créer des sections indexées dans votre tableau de bord, utilisez le widget d'en-tête de section. Lorsque vous ajoutez ce widget à votre tableau de bord, une table des matières est créée et un séparateur horizontal est ajouté au tableau de bord. La table des matières vous permet d'accéder à une section spécifique du tableau de bord. Chaque widget de section contient une ancre. Lorsque vous effectuez un dépannage, vous pouvez partager l'URL de la section avec un collègue. Pour copier l'URL de la section, effectuez un clic droit sur Lien vers l'en-tête, puis sélectionnez Copier l'adresse du lien.

  • Pour réduire le temps de chargement d'un tableau de bord, utilisez des widgets de groupe. Il existe trois types de widgets de groupe : réductible, menu déroulant et onglet. Les widgets de groupe contiennent un ensemble de widgets et améliorent les performances en récupérant les données avec une priorité inférieure pour les membres de l'ensemble qui ne sont pas affichés. Le widget de groupe réductible affiche tous les membres de la collection lorsqu'il est développé. Sinon, tous les membres sont masqués. En revanche, les widgets de groupe de liste déroulante et de groupe d'onglets n'affichent qu'un seul membre de la collection. La différence entre ces widgets est que vous sélectionnez le membre à afficher à l'aide d'un menu ou d'un onglet.

Pour utiliser les widgets décrits dans cette section, votre tableau de bord personnalisé doit utiliser le mode mosaïque, qui est la mise en page par défaut. Si vous modifiez la mise en page pour adopter une grille, ces widgets ne sont pas disponibles.

Pour la plupart des widgets, vous pouvez configurer leur visibilité. Toutefois, les widgets d'organisation sont toujours visibles.

Le reste de cette section explique comment ajouter et configurer des widgets que vous pouvez utiliser pour organiser vos tableaux de bord. Pour en savoir plus sur la modification de ces widgets, consultez Modifier la configuration d'un widget.

Ajouter un widget d'en-tête de section

Pour en savoir plus sur l'utilisation de l'API Cloud Monitoring pour créer un widget d'en-tête de section, consultez Tableau de bord avec un widget SectionHeader.

Pour ajouter un widget d'en-tête de section à l'aide de la console Google Cloud , procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page  Tableaux de bord :

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte ou le projet de gestion App Hub.
  3. Dans la boîte de dialogue Ajouter un widget, accédez à la section Mise en page, puis sélectionnez le widget En-tête de section.

  4. Sur le widget, cliquez sur Modifier la section, puis remplissez la boîte de dialogue :

    • La valeur du champ Nom de la section s'affiche dans la table des matières.
    • La valeur du champ Sous-titre s'affiche sur le tableau de bord.
    • Si vous sélectionnez Ajouter une séparation à la table des matières, une ligne horizontale est ajoutée après l'entrée dans la table des matières.

Ajouter des widgets de groupe réductible

Pour en savoir plus sur l'utilisation de l'API Cloud Monitoring pour créer un widget de groupe réductible, consultez Tableau de bord avec un widget CollapsibleGroup.

Pour ajouter un widget de groupe réductible à l'aide de la console Google Cloud , procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page  Tableaux de bord :

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte ou le projet de gestion App Hub.
  3. Dans la boîte de dialogue Ajouter un widget, accédez à la section Mise en page, puis sélectionnez Groupe réductible.

  4. Pour ajouter un widget au groupe, faites-le glisser vers le groupe.

    Une fois que vous avez ajouté des widgets au groupe, vous pouvez utiliser le pointeur de la souris pour les redimensionner et les repositionner.

  5. Pour ajouter un titre descriptif au groupe, placez votre pointeur sur le widget afin d'activer la barre d'outils, puis cliquez sur Modifier le groupe.

  6. Facultatif : Pour forcer la réduction du groupe par défaut, placez votre pointeur sur le widget afin d'activer la barre d'outils, puis cliquez sur Réduire le groupe.

    Lorsqu'un widget de groupe réductible est réduit, Monitoring récupère les données des widgets du groupe avec une priorité inférieure à celle des autres widgets. Par conséquent, votre tableau de bord se charge plus rapidement.

Ajouter des widgets de groupe de menus déroulants ou de groupe d'onglets

Les widgets de groupe de menus déroulants et de groupe d'onglets contiennent une collection d'autres widgets, mais ils n'affichent qu'un seul membre de la collection. La différence entre ces widgets réside dans la façon dont vous sélectionnez le membre de la collection à afficher. Les groupes déroulants fournissent un menu, tandis que les groupes d'onglets fournissent des onglets dans la barre d'outils.

Pour en savoir plus sur l'utilisation de l'API Cloud Monitoring pour créer ces widgets, consultez Tableau de bord avec un widget SingleViewGroup.

Pour ajouter ces widgets à un tableau de bord, procédez comme suit :

  1. Dans la console Google Cloud , accédez à la page  Tableaux de bord :

    Accéder à la page Tableaux de bord

    Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Monitoring.

  2. Dans la barre d'outils de la console Google Cloud , sélectionnez votre projet Google Cloud . Pour les configurations App Hub, sélectionnez le projet hôte ou le projet de gestion App Hub.
  3. Si nécessaire, créez les widgets que vous souhaitez ajouter au widget de groupe.

  4. Dans la boîte de dialogue Ajouter un widget, accédez à la section Mise en page, puis sélectionnez Groupe de menus déroulants ou Groupe d'onglets.

    Un widget du type sélectionné est ajouté à votre tableau de bord.

  5. Pour ajouter des widgets (comme un graphique en courbes) à un widget de groupe, faites-les glisser dans le widget de groupe ou modifiez le widget de groupe et effectuez une opération d'ajout.

    Par exemple, pour ajouter des widgets à un widget de groupe d'onglets en modifiant le groupe, procédez comme suit :

    1. Dans la barre d'outils du widget, sélectionnez Modifier le groupe d'onglets, puis Modifier le groupe.
    2. Facultatif : saisissez un titre pour le groupe.

    3. Cliquez sur Ajouter un widget, puis faites votre choix dans le menu Ajouter un widget.

      Le menu Ajouter un widget liste les widgets pouvant être ajoutés au groupe.

    4. Répétez l'étape précédente pour chaque widget que vous souhaitez ajouter au widget de groupe d'onglets.

    5. Utilisez les boutons Lower (Descendre) et Higher (Monter) pour ordonner les widgets dans le widget de groupe.

    6. Cliquez sur Appliquer.

    Le tableau de bord est actualisé et un seul des widgets ajoutés au widget de groupe est visible. La barre d'outils du widget affiché vous permet de modifier le widget affiché ou d'effectuer d'autres actions.

  6. Pour enregistrer votre tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Étapes suivantes

Vous pouvez également ajouter des widgets à vos tableaux de bord personnalisés pour afficher les éléments suivants :

Pour en savoir plus sur l'exploration des données représentées graphiquement et le filtrage de vos tableaux de bord, consultez les documents suivants :