Créer et gérer des tableaux de bord à l'aide d'API

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Console

Pour savoir comment utiliser la console Google Cloud pour créer des filtres et des variables épinglés, consultez les documents suivants:

• Créer et épingler un filtre
• Créer une variable

API

Pour définir des filtres et des variables épinglés, utilisez la structure de données dashboardFilters.

• Pour créer une variable, définissez la valeur du champ templateVariable sur le nom de la variable. Omettez ce champ ou définissez sa valeur sur une chaîne vide lorsque vous souhaitez créer un filtre épinglé.
• Pour créer un filtre épinglé ou une variable basée sur un libellé, vous devez spécifier le champ labelKey. Omettre ce champ lorsque vous souhaitez une variable à valeur unique.

• Définissez la valeur par défaut du filtre ou de la variable. La configuration de ce champ détermine si un utilisateur peut sélectionner exactement une option dans le menu de valeurs ou s'il peut sélectionner plusieurs valeurs.

  • Pour définir une seule valeur par défaut et limiter les utilisateurs à la sélection d'une seule option dans le menu des valeurs, définissez le champ valueType sur STRING et définissez également le champ stringValue:

  "valueType": "STRING",
  "stringValue": "my-default-value",
  

  • Pour définir au moins une valeur par défaut et permettre aux utilisateurs de sélectionner plusieurs options dans le menu des valeurs, définissez le champ valueType sur STRING_ARRAY et définissez également le champ stringArrayValue. Dans l'exemple suivant, il existe trois valeurs par défaut.

  "valueType": "STRING_ARRAY",
  "stringArrayValue": {
    "values": [ "a", "b", "c" ]
  },
  

• Facultatif: pour spécifier la liste de toutes les valeurs possibles pour une variable à valeur unique, définissez le champ stringArray ou le champ timeSeriesQuery. Si vous spécifiez une requête, il doit s'agir d'une requête d'analyse.

Prenons l'exemple de l'objet dashboardFilters suivant:

{
  "dashboardFilters": [
      {
        "labelKey": "zone"
        "stringValue": "us-central1-c",
        "valueType": "STRING",
        "filterType": "RESOURCE_LABEL"
      },
      {
        "labelKey": "instance_id",
        "stringValue": "3133577226154888113",
        "valueType": "STRING",
        "filterType": "RESOURCE_LABEL",
        "templateVariable": "my_label_based_variable"
      },
      {
        "filterType": "VALUE_ONLY",
        "templateVariable": "my_value_only_variable",
        timeSeriesQuery: {
          opsAnalyticsQuery: {
            sql: "
              SELECT log_name
              FROM `MY_TABLE`
              GROUP BY log_name
            ",
          }
        }
      }
    ],
  "displayName": "Illustrate Variables",
  ...
}

Le code JSON précédent définit un filtre épinglé et deux variables:

• Le filtre épinglé a la clé de libellé zone, qui s'affiche dans la barre d'outils. Les champs valueType et stringValue spécifient la valeur par défaut unique. Pour en savoir plus, consultez la page de la documentation de référence de l'API pour la structure de données dashboardFilters.

• La variable basée sur une étiquette s'appelle my_label_based_variable, et sa clé d'étiquette est instance_id. La valeur par défaut de cette variable est définie sur un ID d'instance spécifique. Vous pouvez également configurer la valeur par défaut à l'aide d'un tableau. Dans la barre d'outils, le filtre s'affiche sous le nom my_label_based_variable.

• La variable à valeur unique est nommée my_value_only_variable. Cette entrée ne spécifie pas de valeur par défaut. L'opérateur générique, (*), est donc appliqué automatiquement. De plus, cette variable utilise une requête SQL pour générer la liste des valeurs possibles.

Notez que l'objet dashboardFilters ne liste pas les widgets auxquels la variable s'applique. Vous devez plutôt mettre à jour la requête d'un widget pour qu'elle dépende d'une variable.

Console

Par exemple, la requête suivante utilise une expression régulière pour comparer la valeur du champ jsonPayload.message à une valeur de chaîne qui inclut la valeur d'une variable basée sur un libellé:

jsonPayload.message=~"Connected to instance: ${my_label_based_variable.value}"

Prenons un autre exemple. Considérons une variable à valeur unique, value_only_severity_variable, et supposons que trois valeurs sont sélectionnées dans le menu des valeurs: ERROR, INFO et NOTICE. Ajoutez ensuite ce qui suit au volet de requête du widget de panneau des journaux:

severity =~ "${value_only_severity_variable}"

Voici un exemple de formulaire affiché:

severity =~ "^(ERROR|INFO|NOTICE)$"

API

Par exemple, le code JSON suivant montre comment modifier la requête d'un widget de panneau de journaux avec une variable basée sur un libellé:

"logsPanel": {
  "filter": "${my_label_based_variable}",
  "resourceNames": [
    "projects/1234512345"
  ]
},

Par exemple, la requête suivante utilise une expression régulière pour comparer la valeur du champ jsonPayload.message à une valeur de chaîne qui inclut la valeur d'une variable basée sur un libellé:

"logsPanel": {
  "filter": "resource.type=\"gce_instance\"\n
             resource.labels.project_id=~\"${my_label_based_variable.value}\"\n",
  "resourceNames": [
    "projects/012345"
  ]
}

Prenons un autre exemple. Imaginons une variable à valeur unique, value_only_severity_variable, et supposons que trois valeurs sont sélectionnées dans le menu: ERROR, INFO et NOTICE. Ajoutez ensuite ce qui suit au volet de requête du widget de panneau des journaux:

"logsPanel": {
  "filter": "severity =~ \"${value_only_severity_variable}\"\n",
  ...
}

L'illustration suivante montre la requête exécutée par le widget du panneau des journaux:

severity =~ "^(ERROR|INFO|NOTICE)$"

Console

Par exemple, la requête suivante repose sur la résolution de la variable basée sur le libellé, my_label_based_variable, en une expression de filtre:

compute_googleapis_com:instance_cpu_utilization{
    monitored_resource="gce_instance", ${my_label_based_variable} }

Vous pouvez également modifier la requête pour ne résoudre que la valeur d'une variable. L'exemple suivant utilise une expression régulière pour comparer la valeur d'une requête basée sur un libellé à instance_id:

compute_googleapis_com:instance_cpu_utilization{
    instance_id=~"${my_label_based_variable.value}"
}

Si vous disposez d'une variable à valeur unique, omettez la clause .value. Par exemple, pour filtrer par zone à l'aide d'une variable à valeur unique, la requête inclurait quelque chose comme ce qui suit:

zone=~"${my_value_only_variable}"

API

Par exemple, le code JSON suivant illustre une requête qui repose sur la résolution de la variable basée sur le libellé, my_label_based_variable, en une expression de filtre:

"timeSeriesQuery": {
  "prometheusQuery": "avg_over_time(
    compute_googleapis_com:instance_cpu_utilization{
      monitored_resource=\"gce_instance\",
      ${my_label_based_variable}
      }[${__interval}])",
  "unitOverride": "",
  "outputFullDuration": false
},

Vous pouvez également modifier la requête pour ne résoudre que la valeur d'une variable. L'exemple suivant utilise une expression régulière pour comparer la valeur d'une requête basée sur un libellé à instance_id:

"timeSeriesQuery": {
  "prometheusQuery": "avg_over_time(
    compute_googleapis_com:instance_cpu_utilization{
    monitored_resource=\"gce_instance\",
    instance_id=~\"${my_label_based_variable.value}\"
    }[${__interval}])",
  "unitOverride": "",
  "outputFullDuration": false
},

Si vous disposez d'une variable à valeur unique, omettez la clause .value. Par exemple, pour filtrer par zone à l'aide d'une variable à valeur unique, la requête inclurait quelque chose comme ce qui suit:

zone=~\"${my_value_only_variable}\"

Console

Étant donné que SQL n'interprète pas l'opérateur générique comme signifiant "n'importe quelle valeur", nous vous recommandons de toujours utiliser une instruction IF lorsque vous utilisez des variables dans une requête SQL. L'exemple suivant illustre l'utilisation d'une variable à valeur unique dont le type de données est une chaîne:

WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)

Lorsque l'option de menu de la variable permet aux utilisateurs de sélectionner plusieurs valeurs, vous devez caster la valeur de la variable en type de données GoogleSQL à l'aide de la fonction CAST. La requête suivante illustre cette syntaxe:

IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE,
   severity IN UNNEST(@my_value_only_variable))

L'instruction IF indiquée dans les exemples précédents est recommandée, car SQL n'interprète pas l'opérateur générique comme signifiant "n'importe quelle valeur". Par conséquent, si vous omettez l'instruction IF et si vous sélectionnez l'opérateur de caractères génériques, le résultat de la requête est une table vide. Dans le deuxième exemple, la fonction UNNEST convertit le tableau en table.

Pour ajouter une clause WHERE correctement formatée, procédez comme suit:

1. Modifiez le widget.
2. Dans la barre d'outils, sélectionnez Insérer un filtre de variable, puis sélectionnez la variable dont vous souhaitez modifier la clause WHERE.
3. Dans la boîte de dialogue qui s'affiche, vérifiez le code généré, puis cliquez sur Copier et fermer.

4. Collez le code copié dans le volet Requête, puis apportez les modifications nécessaires.

   Par exemple, supposons que vous créiez une variable nommée LogName qui génère une liste de noms de journaux et affiche le résultat dans un tableau avec une seule colonne nommée log_name. Vous créez ensuite un graphique, sélectionnez Insérer un filtre de variable, puis la variable LogName. Le code suivant est généré:

   WHERE IF(@LogName = '*', TRUE, LogName = @LogName)
   

   Dans cet exemple, vous devez modifier le code généré et remplacer LogName = par log_name = pour que la jointure de tables puisse avoir lieu:

   WHERE IF(@LogName = '*', TRUE, log_name = @LogName)
   

5. Cliquez sur Run (Exécuter), puis sur Apply (Appliquer).

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

API

Étant donné que SQL n'interprète pas l'opérateur générique comme signifiant "n'importe quelle valeur", nous vous recommandons de toujours utiliser une instruction IF lorsque vous utilisez des variables dans une requête SQL. L'exemple suivant illustre l'utilisation d'une variable à valeur unique dont le type de données est une chaîne:

WHERE IF(@my_value_only_variable = "*", TRUE, log_name = @my_value_only_variable)

Par exemple, voici une représentation JSON partielle d'un graphique qui affiche les résultats d'une requête SQL : Pour permettre de filtrer les résultats par nom de journal, une clause WHERE a été ajoutée qui fait référence à la variable nommée LogName:

"plotType": "STACKED_BAR",
"targetAxis": "Y1",
"timeSeriesQuery": {
  "opsAnalyticsQuery": {
    "queryExecutionRules": {},
    "queryHandle": "",
    "sql": "SELECT\n timestamp, severity, resource.type, log_name, text_payload, proto_payload, json_payload\n
            FROM\n `my-project.global._Default._Default`\n
            WHERE \n IF (@LogName = \"*\", TRUE, log_name=@LogName)\nLIMIT 10000"
  }
}

La variable LogName émet également une requête pour déterminer la liste des noms de journaux possibles:

"dashboardFilters": [
  {
    "filterType": "VALUE_ONLY",
    "templateVariable": "LogName",
    "valueType": "STRING",
    "timeSeriesQuery": {
      "opsAnalyticsQuery": {
        "savedQueryId": "",
        "sql": "SELECT log_name FROM `my-project.global._Default._Default` GROUP BY log_name LIMIT 1000",
        "queryHandle": ""
      },
      "unitOverride": "",
      "outputFullDuration": false
    }
  }
],

Lorsque l'option de menu de la variable permet aux utilisateurs de sélectionner plusieurs valeurs, vous devez caster la valeur de la variable en type de données GoogleSQL à l'aide de la fonction CAST. La requête suivante illustre cette syntaxe:

IF(ARRAY_LENGTH(CAST(@my_value_only_variable)) = 0, TRUE,
   severity IN UNNEST(@my_value_only_variable))

L'instruction IF indiquée dans les exemples précédents est recommandée, car SQL n'interprète pas l'opérateur générique comme signifiant "n'importe quelle valeur". Par conséquent, si vous omettez l'instruction IF et si vous sélectionnez l'opérateur de caractères génériques, le résultat de la requête est une table vide. Dans le deuxième exemple, la fonction UNNEST convertit le tableau en table.

Console

Par exemple, la requête suivante repose sur une variable basée sur un libellé, my_label_based_variable, qui est résolue en expression de filtre:

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| every 1m
| ${my_label_based_variable}

Vous pouvez également modifier la requête pour ne résoudre que la valeur d'une variable. L'exemple suivant utilise une expression régulière pour comparer la valeur d'une requête basée sur un libellé à instance_id:

fetch gce_instance
| metric 'compute.googleapis.com/instance/cpu/utilization'
| filter resource.instance_id=~'${my_label_based_variable.value}'
| group_by 1m, [value_utilization_mean: mean(value.utilization)]
| every 1m

Si vous disposez d'une variable à valeur unique, omettez la clause .value. Par exemple, pour filtrer par zone à l'aide d'une variable à valeur unique, la requête inclurait quelque chose comme ce qui suit:

resource.zone=~'${my_value_only_variable}'

API

Par exemple, le code JSON suivant illustre une requête qui s'appuie sur une variable basée sur un libellé, my_label_based_variable, qui est résolue en expression de filtre:

"timeSeriesQuery": {
  "timeSeriesQueryLanguage": "fetch gce_instance\n
    | metric 'compute.googleapis.com/instance/cpu/utilization'\n
    | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n
    | every 1m\n
    | ${my_label_based_variable}",
  "unitOverride": "",
  "outputFullDuration": false
},

Vous pouvez également modifier la requête pour ne résoudre que la valeur d'une variable. L'exemple suivant utilise une expression régulière pour comparer la valeur d'une requête basée sur un libellé à instance_id:

"timeSeriesQuery": {
  "timeSeriesQueryLanguage": "fetch gce_instance\n
    | metric 'compute.googleapis.com/instance/cpu/utilization'\n
    | filter resource.instance_id=~'${my_label_based_variable.value}'\n
    | group_by 1m, [value_utilization_mean: mean(value.utilization)]\n
    | every 1m\n",
  "unitOverride": "",
  "outputFullDuration": false
},

Si vous disposez d'une variable à valeur unique, omettez la clause .value. Par exemple, pour filtrer par zone à l'aide d'une variable à valeur unique, la requête inclurait quelque chose comme ce qui suit:

resource.zone=~'${my_value_only_variable}'

Console

Si vous utilisez la console Google Cloud pour créer vos graphiques et si vous utilisez l'interface basée sur les menus, vous pouvez mettre à jour la requête du graphique à l'aide du champ Appliquer aux graphiques de la variable ou en modifiant le widget et en sélectionnant la variable basée sur les libellés dans le menu Filtrer. Le menu Filtrer liste toutes les variables basées sur des étiquettes et toutes les clés d'étiquette.

Pour modifier la requête d'un graphique afin qu'elle dépende d'une variable basée sur la valeur, procédez comme suit:

1. Modifier le graphique
2. Dans le volet de requête, cliquez sur Ajouter un filtre, puis sélectionnez une clé de libellé. Par exemple, vous pouvez sélectionner zone.
3. Dans le menu Valeur, sélectionnez votre variable à valeur unique.
4. Cliquez sur Appliquer.
5. Pour enregistrer le tableau de bord modifié, cliquez sur Enregistrer dans la barre d'outils.

Par exemple, le code JSON suivant illustre une requête qui s'appuie sur une variable basée sur un libellé, my_label_based_variable, qui est résolue en expression de filtre:

metric.type="compute.googleapis.com/instance/cpu/utilization"
resource.type="gce_instance" ${my_label_based_variable}"

Les widgets qui utilisent une requête sous la forme d'un filtre de surveillance ne peuvent pas filtrer la série temporelle en fonction de la valeur d'une variable basée sur des étiquettes. Toutefois, vous pouvez filtrer en fonction de variables de type "Valeur uniquement". Par exemple, la requête suivante affiche la valeur du champ Filtres d'une requête qui filtre par zone, en fonction de la valeur d'une variable à valeur unique:

metric.type="compute.googleapis.com/instance/cpu/utilization"
resource.type="gce_instance"
resource.label."zone"=monitoring.regex.full_match(${my_value_only_variable})

API

Par exemple, le code JSON suivant illustre une requête qui s'appuie sur une variable basée sur un libellé, my_label_based_variable, qui est résolue en expression de filtre:

"timeSeriesQuery": {
  "timeSeriesFilter": {
    "filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
               resource.type=\"gce_instance\"
               ${my_label_based_variable} ",
    "aggregation": {
      "alignmentPeriod": "60s",
      "perSeriesAligner": "ALIGN_MEAN",
      "groupByFields": []
    }
  },
  "unitOverride": "",
  "outputFullDuration": false
},

Les widgets qui utilisent une requête sous la forme d'un filtre de surveillance ne peuvent pas filtrer la série temporelle en fonction de la valeur d'une variable basée sur des étiquettes. Toutefois, vous pouvez filtrer en fonction de variables de type "Valeur uniquement". Par exemple, la requête suivante affiche le champ "filter" d'une requête qui filtre par zone, en fonction de la valeur d'une variable à valeur unique:

"filter": "metric.type=\"compute.googleapis.com/instance/cpu/utilization\"
          resource.type=\"gce_instance\"
          resource.labels.\"zone\"=monitoring.regex.full_match(${my_value_only_variable})"

gcloud

Pour créer un tableau de bord dans un projet, utilisez la commande gcloud monitoring dashboards create.

gcloud monitoring dashboards create --config-from-file=my-dashboard.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 du dossier compatible avec les applications.

Par exemple, si vous souhaitez dupliquer un tableau de bord, procédez comme suit:

1. Suivez la procédure de la section Obtenir un tableau de bord pour télécharger la définition du tableau de bord d'origine.
2. Modifiez le code JSON renvoyé pour supprimer les champs etag et name, et modifiez la valeur du champ displayName.
3. Exécutez la commande pour créer le tableau de bord.

Pour en savoir plus, consultez la référence gcloud monitoring dashboards create.

Terraform

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base. Pour en savoir plus, consultez la documentation de référence du fournisseur Terraform.

Pour créer un tableau de bord à l'aide de Terraform, procédez comme suit:

1. Installez et configurez Terraform pour votre projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

2. Utilisez la ressource Terraform google_monitoring_dashboard.

   Dans la commande, définissez les champs suivants:

   • dashboard_json: représentation JSON du tableau de bord, au format Dashboards.

     Pour obtenir des exemples de ce format, vous pouvez lister vos tableaux de bord à l'aide de l'explorateur d'API, ou ouvrir un tableau de bord dans la console Google Cloud et afficher les représentations JSON.

   • parent: nom complet de votre projet. Par exemple, vous pouvez définir ce champ sur "projects/PROJECT_ID", où PROJECT_ID correspond à l'ID de votre projet Google Cloud. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

REST

Pour créer un tableau de bord, envoyez une requête POST au point de terminaison Dashboard.

curl -d @my-dashboard.json -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' -X POST https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards

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

• ${PROJECT_ID}: variable d'environnement qui stocke l'ID du projet dans lequel créer le tableau de bord. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

gcloud

Pour supprimer un tableau de bord personnalisé, utilisez gcloud monitoring dashboards delete et spécifiez l'ID complet du tableau de bord à supprimer:

gcloud monitoring dashboards delete DASHBOARD_ID --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 du dossier compatible avec les applications.
• DASHBOARD_ID: ID du tableau de bord.

Pour en savoir plus, consultez la référence gcloud monitoring dashboards delete.

Terraform

Vous pouvez supprimer des ressources à l'aide de Terraform. Pour en savoir plus sur la suppression de ressources, consultez la commande Terraform destroy.

REST

Pour supprimer un tableau de bord personnalisé, envoyez une requête DELETE au point de terminaison Dashboard incluant l'ID du tableau de bord à supprimer.

curl -H "Authorization: Bearer $ACCESS_TOKEN" -X DELETE https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

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

• ${PROJECT_ID}: variable d'environnement qui stocke l'ID du projet dans lequel créer le tableau de bord. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
• ${DASHBOARD_ID}: variable d'environnement qui stocke l'ID du tableau de bord.

Si l'opération réussit, l'API renvoie une réponse vide. Sinon, l'appel renvoie une erreur.

gcloud

Pour répertorier tous les tableaux de bord personnalisés d'un projet, utilisez la commande gcloud monitoring dashboards list:

gcloud monitoring dashboards list --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 du dossier compatible avec les applications.

Pour en savoir plus, consultez la documentation de référence sur gcloud monitoring dashboards list.

Terraform

Vous ne pouvez pas utiliser Terraform pour envoyer une requête à votre projet, la réponse étant une liste de tableaux de bord. Toutefois, vous pouvez afficher ces tableaux de bord à l'aide de la console Google Cloud.

REST

Pour répertorier tous les tableaux de bord personnalisés d'un projet, envoyez l'ID du projet au point de terminaison Dashboard.

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards

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

• ${PROJECT_ID}: variable d'environnement qui stocke l'ID du projet dans lequel créer le tableau de bord. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

gcloud

Pour spécifier le nombre de ressources par page, transmettez l'option --page-size à l'aide de la commande. Exemple :

gcloud monitoring dashboards list --page-size=1 --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 du dossier compatible avec les applications.

Terraform

Vous ne pouvez pas utiliser Terraform pour envoyer une requête à votre projet, la réponse étant une liste paginée de tableaux de bord. Toutefois, vous pouvez afficher ces tableaux de bord à l'aide de la console Google Cloud.

REST

Pour la première page de la liste de résultats, spécifiez le paramètre pageSize (taille de page) dans la requête :

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards?page_size=1

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

• ${PROJECT_ID}: variable d'environnement qui stocke l'ID du projet dans lequel créer le tableau de bord. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

La méthode renvoie la première page de la liste ainsi que le jeton nextPageToken. Exemple :

{
  "dashboards" : [
    {
       "displayName" : "Grid Layout Example",
       "gridLayout" : {
         "widgets" : [
            { ... },
            { ... },
            { ... },
          ]
       }
    }
  ]
},
"nextPageToken": "ChYqFDEyMzkzMzUwNzg0OTE1MDI4MjM3"

Pour chacune des pages restantes, vous devez inclure le jeton nextPageToken correspondant dans la requête.

gcloud

Pour obtenir un tableau de bord personnalisé spécifique, utilisez la commande gcloud monitoring dashboards describe et spécifiez l'ID du tableau de bord:

gcloud monitoring dashboards describe DASHBOARD_ID --format=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 du dossier compatible avec les applications.
• DASHBOARD_ID: ID du tableau de bord.

La commande renvoie le tableau de bord demandé :

{
  "columnLayout": {
    "columns": [
      {
        "widgets": [
          {
            "text": {
              "content": "Text Widget 1",
              "format": "RAW"
            }
          },
          {
            "text": {
              "content": "**Text Widget 2**",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "_Text Widget 3_",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  },
  "displayName": "Column-layout example",
  "etag": "cb3070baf15de7c79d78761baac3a386",
  "name": "projects/730041941835/dashboards/e4cd063e-5414-4e07-9e1e-450d6d3a531d"
}

Pour en savoir plus, consultez la documentation de référence sur gcloud monitoring dashboards describe.

Terraform

Vous ne pouvez pas utiliser Terraform pour envoyer une requête à votre projet, la réponse étant un tableau de bord individuel. Toutefois, vous pouvez afficher ces tableaux de bord à l'aide de la console Google Cloud.

REST

Pour récupérer un tableau de bord personnalisé spécifique, envoyez l'ID du tableau de bord au point de terminaison Dashboard.

curl -H "Authorization: Bearer $ACCESS_TOKEN" https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

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

• ${PROJECT_ID}: variable d'environnement qui stocke l'ID du projet dans lequel créer le tableau de bord. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
• ${DASHBOARD_ID}: variable d'environnement qui stocke l'ID du tableau de bord.

Dans l'expression précédente, ${DASHBOARD_ID} est une variable d'environnement qui stocke le nom complet du tableau de bord.

La méthode renvoie une réponse semblable à l'exemple ci-dessous :

{
  "columnLayout": {
    "columns": [
      {
        "widgets": [
          {
            "text": {
              "content": "Text Widget 1",
              "format": "RAW"
            }
          },
          {
            "text": {
              "content": "**Text Widget 2**",
              "format": "MARKDOWN"
            }
          },
          {
            "text": {
              "content": "_Text Widget 3_",
              "format": "MARKDOWN"
            }
          }
        ]
      }
    ]
  },
  "displayName": "Column-layout example",
  "etag": "cb3070baf15de7c79d78761baac3a386",
  "name": "projects/730041941835/dashboards/e4cd063e-5414-4e07-9e1e-450d6d3a531d"
}

gcloud

Pour mettre à jour un tableau de bord personnalisé, utilisez gcloud monitoring dashboards update, spécifiez l'ID du tableau de bord à mettre à jour et effectuez les modifications.

gcloud monitoring dashboards update DASHBOARD_ID --config-from-file=my-updated-dashboard.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 du dossier compatible avec les applications.
• DASHBOARD_ID: ID du tableau de bord.

Pour en savoir plus, consultez la documentation de référence sur gcloud monitoring dashboards update.

L'exemple précédent met à jour un tableau de bord personnalisé existant à l'aide du fichier my-updated-dashboard.json. La réponse, qui inclut une nouvelle valeur etag, est une copie de la liste de tableaux de bord mise à jour.

Terraform

Pour savoir comment appliquer ou supprimer une configuration Terraform, consultez la page Commandes Terraform de base. Pour en savoir plus, consultez la documentation de référence du fournisseur Terraform.

Pour mettre à jour un tableau de bord à l'aide de Terraform, procédez comme suit:

1. Installez et configurez Terraform pour votre projet. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

2. Utilisez la ressource Terraform google_monitoring_dashboard.

   Dans la commande, définissez les champs suivants:

   • dashboard_json: représentation JSON du tableau de bord, au format Dashboards.

   • parent: nom complet de votre projet. Par exemple, vous pouvez définir ce champ sur "projects/PROJECT_ID", où PROJECT_ID correspond à l'ID de votre projet Google Cloud. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.

REST

Pour mettre à jour un tableau de bord personnalisé, envoyez une requête PATCH au point de terminaison Dashboard et fournissez l'objet Dashboard révisé et la valeur etag de la dernière réponse dashboards.get.

curl -d @my-updated-dashboard.json -H "Authorization: Bearer $ACCESS_TOKEN" -H 'Content-Type: application/json' -X PATCH https://monitoring.googleapis.com/v1/projects/${PROJECT_ID}/dashboards/${DASHBOARD_ID}

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

• ${PROJECT_ID}: variable d'environnement qui stocke l'ID du projet dans lequel créer le tableau de bord. Pour les configurations App Hub, sélectionnez le projet hôte App Hub ou le projet de gestion du dossier compatible avec les applications.
• ${DASHBOARD_ID}: variable d'environnement qui stocke l'ID du tableau de bord.

L'exemple précédent met à jour un tableau de bord personnalisé existant à l'aide du fichier my-updated-dashboard.json. La réponse, qui inclut une nouvelle valeur etag, est une copie de la liste de tableaux de bord mise à jour.