Installer un modèle de tableau de bord

Cloud Monitoring fournit un ensemble organisé de modèles de tableau de bord sur GitHub spécifiques à divers Google Cloud services, tels que Compute Engine, Cloud Storage, BigQuery, etc. Les graphiques de ces tableaux de bord présentent une sélection de métriques pertinentes pour un service spécifique. Vous pouvez installer ces modèles dans votre Google Cloud projet en tant que tableaux de bord personnalisés à l'aide de l'API Cloud Monitoring ou de la Google Cloud console.

Cette page explique comment installer un modèle disponible dans la Google Cloud console ou stocké dans le dépôt GitHub monitoring-dashboard-samples. Chaque modèle est stocké sous forme de fichier JSON. Cette page explique également comment afficher le tableau de bord dans la Google Cloud console.

Cette fonctionnalité n'est compatible qu'avec les Google Cloud projets. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion.

Installer un modèle de tableau de bord

Remarque : Certaines des définitions de tableaux de bord stockées dans le dépôt GitHub monitoring-dashboard-samples affichent des données de métriques personnalisées. Pour installer ces tableaux de bord, vous devez créer les métriques définies par l'utilisateur nécessaires. Pour en savoir plus, consultez la documentation par service du dépôt.

Google Cloud Console

Pour installer un modèle de tableau de bord à l'aide de la Google Cloud console, procédez comme suit :

1. Dans la Google Cloud console, 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 Google Cloud console, sélectionnez votre Google Cloud projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion.

3. Effectuez l'une des opérations suivantes :

   • Pour installer un modèle à partir de la bibliothèque disponible dans la Google Cloud console, procédez comme suit :

     1. Cliquez sur Modèles de tableau de bord.
     2. Recherchez le tableau de bord que vous souhaitez installer.
     3. (Facultatif) Pour afficher un aperçu du tableau de bord, sélectionnez-le.
     4. Cliquez sur Ajouter un tableau de bord à votre liste et puis remplissez la boîte de dialogue.

     La boîte de dialogue vous permet de sélectionner le nom du tableau de bord et d'y ajouter des libellés.

   • Pour installer un tableau de bord en important un fichier JSON, procédez comme suit :

     1. (Facultatif) Pour installer un modèle de tableau de bord organisé, téléchargez le dépôt GitHub :

     git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples.git

     1. Cliquez sur Créer un tableau de bord.
     2. Dans la barre d'outils du tableau de bord, Paramètres, puis JSON, puis sélectionnez Éditeur JSON.

     Pour un nouveau tableau de bord, le code affiché est semblable à celui-ci :

     {
         "displayName": "New Dashboard",
         "mosaicLayout": {
           "columns": 12,
           "tiles": []
         },
         "dashboardFilters": [],
         "labels": {}
     }
     

     1. Dans la barre d'outils de l'éditeur, cliquez sur upload Importation de fichiers.
     2. Sélectionnez le fichier contenant le modèle, puis cliquez sur Ouvrir.

     Une fois le fichier importé, le fichier JSON du tableau de bord est mis à jour.

     Si le message suivant s'affiche "Impossible d'enregistrer le tableau de bord : Field mosaicLayout.tiles[0] possède une valeur non valide", sélectionnez Grille dans la barre d'outils du tableau de bord.

     1. (Facultatif) Personnalisez le tableau de bord. Par exemple, vous pouvez mettre à jour le titre, ajouter un widget de texte indiquant la source du tableau de bord, supprimer les graphiques indésirables ou ajouter des graphiques.
     2. Pour enregistrer le tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Gcloud CLI

Pour installer une définition de tableau de bord à l'aide de la Google Cloud CLI, procédez comme suit :

1. Assurez-vous que la définition du tableau de bord est accessible à votre système local.

   Pour les tableaux de bord stockés dans le dépôt GitHub, vous pouvez enregistrer des tableaux de bord spécifiques ou télécharger l'intégralité du dépôt :

   git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples.git
   

2. Identifiez les tableaux de bord que vous souhaitez installer.

   Par exemple, dans le dépôt GitHub, le répertoire monitoring-dashboard-samples/dashboards/compute contient un fichier nommé gce-vm-instance-monitoring.json.

3. Exécutez la gcloud monitoring dashboards create commande et fournissez la représentation JSON du tableau de bord.

   Par exemple, pour installer le tableau de bord gce-vm-instance-monitoring.json, exécutez la commande suivante :

   gcloud monitoring dashboards create --config-from-file=gce-vm-instance-monitoring.json --project=PROJECT_ID
   

   Avant d'exécuter la commande précédente, remplacez les éléments suivants :

   • PROJECT_ID : identifiant du projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion.

REST

Pour installer une définition de tableau de bord à l'aide de la Google Cloud CLI, procédez comme suit :

1. Assurez-vous que la définition du tableau de bord est accessible à votre système local.

   Pour les tableaux de bord stockés dans le dépôt GitHub, vous pouvez enregistrer des tableaux de bord spécifiques ou télécharger l'intégralité du dépôt :

   git clone https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples.git
   

2. Identifiez les tableaux de bord que vous souhaitez installer.

   Par exemple, dans le dépôt GitHub, le répertoire monitoring-dashboard-samples/dashboards/compute contient un fichier nommé gce-vm-instance-monitoring.json.

3. Appelez dashboards.create et fournissez la représentation JSON du tableau de bord. Dans l'appel d'API, le parent est le projet dans lequel créer le moniteur synthétique. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion. Ce champ présente le format suivant :

   projects/PROJECT_ID
   

Pour en savoir plus, consultez la section Créer et gérer des tableaux de bord.

Afficher le tableau de bord installé

Chaque fichier du dépôt crée un tableau de bord personnalisé. Par exemple, le fichier gce-vm-instance-monitoring.json crée un tableau de bord intitulé "GCE VM Instance Monitoring" (Surveillance des instances de VM GCE). Pour afficher ce tableau de bord, procédez comme suit :

1. Dans la Google Cloud console, 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 Google Cloud console, sélectionnez votre Google Cloud projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion.
3. Dans la liste des tableaux de bord, cliquez sur "GCE VM Instance Monitoring" (Surveillance des instances de VM GCE). Si vous disposez d'un grand nombre de tableaux de bord, vous pouvez appliquer un filtre pour n'afficher que les tableaux de bord personnalisés ou le nom du nouveau tableau de bord.

La capture d'écran suivante montre la partie du tableau de bord installé :

Ajouter ou supprimer des libellés définis par l'utilisateur

Les libellés peuvent vous aider à localiser les tableaux de bord en fonction du type de contenu qu'ils affichent. Par exemple, vous pouvez ajouter le libellé prod aux tableaux de bord qui affichent des informations sur les systèmes de production. De même, vous pouvez ajouter le libellé staging pour indiquer que le tableau de bord affiche des informations sur les systèmes de préproduction.

Vous ne pouvez ajouter des libellés qu'aux tableaux de bord personnalisés. Lorsqu'un tableau de bord affiche le bouton Ajouter des libellés au tableau de bord, vous pouvez configurer les libellés à appliquer au tableau de bord.

Pour ajouter ou supprimer des libellés définis par l'utilisateur dans un tableau de bord personnalisé, procédez comme suit :

1. Dans la Google Cloud console, 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 liste des tableaux de bord, recherchez le tableau de bord, puis cliquez sur Ajouter des libellés au tableau de bord.
3. Effectuez l'une des opérations suivantes :

   • Pour créer un libellé et l'ajouter à votre tableau de bord, dans la section Créer un libellé, saisissez le nom du libellé dans la zone de texte, puis cliquez sur Créer et appliquer.

   • Pour configurer les libellés à ajouter à votre tableau de bord, cliquez sur Sélectionner les libellés à appliquer, sélectionnez les libellés, puis cliquez sur OK.
4. Pour enregistrer vos modifications, cliquez sur Confirmer.