Dashboards per API erstellen und verwalten

Console

Informationen zum Erstellen angepinnter Filter und Variablen mit der Google Cloud Console finden Sie in den folgenden Dokumenten:

• Filter erstellen und anpinnen
• Variable erstellen

API

Verwenden Sie die Datenstruktur dashboardFilters, um angepinnte Filter und Variablen zu definieren.

• Um eine Variable zu erstellen, legen Sie den Wert des Felds templateVariable auf den Namen der Variable fest. Lassen Sie dieses Feld weg oder legen Sie den Wert auf einen leeren String fest, wenn Sie einen angepinnten Filter erstellen möchten.
• Wenn Sie einen angepinnten Filter oder eine labelbasierte Variable erstellen möchten, müssen Sie das Feld labelKey angeben. Lassen Sie dieses Feld weg, wenn Sie eine Variable nur mit einem Wert haben möchten.

• Legen Sie den Standardwert für den Filter oder die Variable fest. Die Konfiguration dieses Felds bestimmt, ob ein Nutzer genau eine Option aus dem Menü mit Werten oder mehrere Werte auswählen kann.

  • Wenn Sie einen einzelnen Standardwert festlegen und Nutzer darauf beschränken möchten, genau eine Option im Menü „Werte“ auszuwählen, legen Sie das Feld valueType auf STRING und das Feld stringValue fest:

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

  • Wenn Sie mindestens einen Standardwert festlegen und Nutzern erlauben möchten, mehrere Optionen im Menü „Werte“ auszuwählen, legen Sie das Feld valueType auf STRING_ARRAY fest und legen Sie auch das Feld stringArrayValue fest. Im folgenden Beispiel gibt es drei Standardwerte.

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

• Optional: Wenn Sie die Liste aller möglichen Werte für eine Variable mit nur einem Wert angeben möchten, legen Sie entweder das Feld stringArray oder das Feld timeSeriesQuery fest. Wenn Sie eine Abfrage angeben, muss es sich um eine Analyseabfrage handeln.

Betrachten Sie beispielsweise das folgende dashboardFilters-Objekt:

{
  "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",
  ...
}

Im vorherigen JSON-Code werden ein angepinnter Filter und zwei Variablen definiert:

• Der angepinnte Filter hat den Labelschlüssel zone, der in der Symbolleiste angezeigt wird. Die Felder valueType und stringValue geben den einzelnen Standardwert an. Weitere Informationen finden Sie auf der Seite „API-Referenzen“ für die Datenstruktur dashboardFilters.

• Die labelbasierte Variable hat den Namen my_label_based_variable und den Labelschlüssel instance_id. Der Standardwert für diese Variable ist auf eine bestimmte Instanz-ID festgelegt. Sie können den Standardwert auch mit einem Array konfigurieren. In der Symbolleiste wird der Filter mit dem Namen my_label_based_variable angezeigt.

• Die Variable, die nur den Wert enthält, heißt my_value_only_variable. Für diesen Eintrag ist kein Standardwert angegeben. Daher wird automatisch der Platzhalteroperator (*) angewendet. Außerdem wird für diese Variable eine SQL-Abfrage verwendet, um die Liste der möglichen Werte für die Variable zu generieren.

Im dashboardFilters-Objekt sind die Widgets, auf die sich die Variable bezieht, nicht aufgeführt. Stattdessen aktualisieren Sie die Abfrage eines Widgets, sodass sie von einer Variablen abhängt.

Console

In der folgenden Abfrage wird beispielsweise ein regulärer Ausdruck verwendet, um den Wert des Felds jsonPayload.message mit einem Stringwert zu vergleichen, der den Wert einer labelbasierten Variablen enthält:

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

Nehmen wir als weiteres Beispiel eine Variable mit nur Werten, value_only_severity_variable, an und gehen wir davon aus, dass im Menü der Werte drei Werte ausgewählt sind: ERROR, INFO und NOTICE. Fügen Sie als Nächstes Folgendes in den Abfragebereich des Logbereich-Widgets ein:

severity =~ "${value_only_severity_variable}"

Das folgende Beispiel zeigt die gerenderte Form:

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

API

Das folgende JSON-Beispiel zeigt, wie Sie die Abfrage eines Protokollbereichs-Widgets mit einer labelbasierten Variablen aktualisieren:

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

In der folgenden Abfrage wird beispielsweise ein regulärer Ausdruck verwendet, um den Wert des Felds jsonPayload.message mit einem Stringwert zu vergleichen, der den Wert einer labelbasierten Variablen enthält:

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

Ein weiteres Beispiel: Angenommen, Sie haben eine Variable, die nur Werte enthält, value_only_severity_variable, und im Menü sind drei Werte ausgewählt: ERROR, INFO und NOTICE. Fügen Sie als Nächstes Folgendes in den Abfragebereich des Logbereich-Widgets ein:

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

Das folgende Beispiel zeigt die Abfrage, wie sie vom Widget für den Logbereich ausgeführt wird:

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

Console

In der folgenden Abfrage wird beispielsweise die labelbasierte Variable my_label_based_variable in einen Filterausdruck aufgelöst:

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

Sie können die Abfrage auch so ändern, dass nur der Wert einer Variablen aufgelöst wird. Im folgenden Beispiel wird ein regulärer Ausdruck verwendet, um den Wert einer labelbasierten Abfrage mit instance_id zu vergleichen:

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

Wenn Sie eine Variable haben, die nur einen Wert enthält, lassen Sie die .value-Klausel weg. Wenn Sie beispielsweise nach Zone filtern möchten und dazu eine Variable verwenden, die nur Werte enthält, würde die Abfrage etwa so aussehen:

zone=~"${my_value_only_variable}"

API

Das folgende JSON-Beispiel zeigt eine Abfrage, bei der die labelbasierte Variable my_label_based_variable in einen Filterausdruck aufgelöst wird:

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

Sie können die Abfrage auch so ändern, dass nur der Wert einer Variablen aufgelöst wird. Im folgenden Beispiel wird ein regulärer Ausdruck verwendet, um den Wert einer labelbasierten Abfrage mit instance_id zu vergleichen:

"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
},

Wenn Sie eine Variable haben, die nur einen Wert enthält, lassen Sie die .value-Klausel weg. Wenn Sie beispielsweise nach Zone filtern möchten und dazu eine Variable verwenden, die nur Werte enthält, würde die Abfrage etwa so aussehen:

zone=~\"${my_value_only_variable}\"

Console

Da der Platzhalteroperator in SQL nicht als „beliebiger Wert“ interpretiert wird, empfehlen wir, bei der Verwendung von Variablen in einer SQL-Abfrage immer eine IF-Anweisung zu verwenden. Im folgenden Beispiel wird die Verwendung für eine Variable mit nur einem Wert veranschaulicht, deren Datentyp ein String ist:

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

Wenn Nutzer über die Menüoption für die Variable mehrere Werte auswählen können, müssen Sie den Wert der Variablen mit der Funktion CAST in einen GoogleSQL-Datentyp umwandeln. Die folgende Abfrage veranschaulicht diese Syntax:

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

Die in den vorherigen Beispielen gezeigte IF-Anweisung wird empfohlen, da der Platzhalteroperator in SQL nicht als „beliebiger Wert“ interpretiert wird. Wenn Sie die IF-Anweisung weglassen und den Platzhalteroperator auswählen, ist das Ergebnis der Abfrage also eine leere Tabelle. Im zweiten Beispiel wird das Array mit der Funktion UNNEST in eine Tabelle konvertiert.

So fügen Sie eine korrekt formatierte WHERE-Klausel hinzu:

1. Bearbeiten Sie das Widget.
2. Wählen Sie in der Symbolleiste Variablenfilter einfügen und dann die Variable aus, deren WHERE-Klausel Sie aktualisieren möchten.
3. Sehen Sie sich den generierten Code im angezeigten Dialogfeld an und klicken Sie dann auf Kopieren und schließen.

4. Fügen Sie den kopierten Code in den Bereich Abfrage ein und nehmen Sie die erforderlichen Änderungen vor.

   Angenommen, Sie erstellen eine Variable mit dem Namen LogName, die eine Liste von Log-Namen generiert und das Ergebnis in einer Tabelle mit einer einzelnen Spalte namens log_name ausgibt. Als Nächstes erstellen Sie ein Diagramm, wählen Variablenfilter einfügen aus und wählen dann die Variable LogName aus. Der folgende Code wird generiert:

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

   In diesem Beispiel müssen Sie den generierten Code bearbeiten und LogName = durch log_name = ersetzen, damit die Tabellenverknüpfung erfolgen kann:

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

5. Klicken Sie auf Ausführen und dann auf Anwenden.

6. Klicken Sie zum Speichern des geänderten Dashboards in der Symbolleiste auf Speichern.

API

Da der Platzhalteroperator in SQL nicht als „beliebiger Wert“ interpretiert wird, empfehlen wir, bei der Verwendung von Variablen in einer SQL-Abfrage immer eine IF-Anweisung zu verwenden. Im folgenden Beispiel wird die Verwendung für eine Variable mit nur einem Wert veranschaulicht, deren Datentyp ein String ist:

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

Im Folgenden sehen Sie beispielsweise eine teilweise JSON-Darstellung eines Diagramms, in dem die Ergebnisse einer SQL-Abfrage angezeigt werden. Damit die Ergebnisse nach dem Namen eines Logs gefiltert werden können, wurde eine WHERE-Klausel hinzugefügt, die auf die Variable LogName verweist:

"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"
  }
}

Die Variable LogName führt auch eine Anfrage aus, um die Liste der möglichen Protokollnamen zu ermitteln:

"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
    }
  }
],

Wenn Nutzer über die Menüoption für die Variable mehrere Werte auswählen können, müssen Sie den Wert der Variablen mit der Funktion CAST in einen GoogleSQL-Datentyp umwandeln. Die folgende Abfrage veranschaulicht diese Syntax:

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

Die in den vorherigen Beispielen gezeigte IF-Anweisung wird empfohlen, da der Platzhalteroperator in SQL nicht als „beliebiger Wert“ interpretiert wird. Wenn Sie die IF-Anweisung weglassen und den Platzhalteroperator auswählen, ist das Ergebnis der Abfrage also eine leere Tabelle. Im zweiten Beispiel wird das Array mit der Funktion UNNEST in eine Tabelle konvertiert.

Console

In der folgenden Abfrage wird beispielsweise eine labelbasierte Variable, my_label_based_variable, in einen Filterausdruck aufgelöst:

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

Sie können die Abfrage auch so ändern, dass nur der Wert einer Variablen aufgelöst wird. Im folgenden Beispiel wird ein regulärer Ausdruck verwendet, um den Wert einer labelbasierten Abfrage mit instance_id zu vergleichen:

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

Wenn Sie eine Variable haben, die nur einen Wert enthält, lassen Sie die .value-Klausel weg. Wenn Sie beispielsweise nach Zone filtern möchten und dazu eine Variable verwenden, die nur Werte enthält, würde die Abfrage etwa so aussehen:

resource.zone=~'${my_value_only_variable}'

API

Das folgende JSON-Beispiel zeigt eine Abfrage, bei der eine labelbasierte Variable (my_label_based_variable) in einen Filterausdruck aufgelöst wird:

"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
},

Sie können die Abfrage auch so ändern, dass nur der Wert einer Variablen aufgelöst wird. Im folgenden Beispiel wird ein regulärer Ausdruck verwendet, um den Wert einer labelbasierten Abfrage mit instance_id zu vergleichen:

"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
},

Wenn Sie eine Variable haben, die nur einen Wert enthält, lassen Sie die .value-Klausel weg. Wenn Sie beispielsweise nach Zone filtern möchten und dazu eine Variable verwenden, die nur Werte enthält, würde die Abfrage etwa so aussehen:

resource.zone=~'${my_value_only_variable}'

Console

Wenn Sie die Google Cloud -Konsole zum Erstellen von Diagrammen verwenden und die menügesteuerte Oberfläche nutzen, können Sie die Abfrage des Diagramms über das Feld Auf Diagramme anwenden der Variablen aktualisieren. Alternativ können Sie das Widget bearbeiten und im Menü Filter eine labelbasierte Variable auswählen. Im Menü Filter werden alle labelbasierten Variablen und alle Labelschlüssel aufgeführt.

So aktualisieren Sie die Abfrage eines Diagramms, damit sie von einer wertbasierten Variablen abhängt:

1. Das Diagramm bearbeiten.
2. Klicken Sie im Bereich „Abfrage“ auf Filter hinzufügen und wählen Sie einen Labelschlüssel aus. Sie können beispielsweise Zone auswählen.
3. Wählen Sie im Menü Wert die Variable aus, die nur Werte enthält.
4. Klicken Sie auf Übernehmen.
5. Klicken Sie zum Speichern des geänderten Dashboards in der Symbolleiste auf Speichern.

Das folgende JSON-Beispiel zeigt eine Abfrage, bei der eine labelbasierte Variable (my_label_based_variable) in einen Filterausdruck aufgelöst wird:

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

Bei Widgets, für die eine Abfrage in Form eines Monitoring-Filters verwendet wird, kann die Zeitachse nicht nach dem Wert einer labelbasierten Variablen gefiltert werden. Sie können jedoch nach Variablen filtern, die nur Werte enthalten. Die folgende Abfrage zeigt beispielsweise den Wert des Felds Filters einer Abfrage, die nach zone filtert, basierend auf dem Wert einer Variable, die nur einen Wert enthält:

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

API

Das folgende JSON-Beispiel zeigt eine Abfrage, bei der eine labelbasierte Variable (my_label_based_variable) in einen Filterausdruck aufgelöst wird:

"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
},

Bei Widgets, für die eine Abfrage in Form eines Monitoring-Filters verwendet wird, kann die Zeitachse nicht nach dem Wert einer labelbasierten Variablen gefiltert werden. Sie können jedoch nach Variablen filtern, die nur Werte enthalten. Die folgende Abfrage zeigt beispielsweise das Feld "filter" einer Abfrage, die nach zone gefiltert wird, basierend auf dem Wert einer Variable, die nur einen Wert enthält:

"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

Verwenden Sie den Befehl gcloud monitoring dashboards create, um ein Dashboard in einem Projekt zu erstellen.

gcloud monitoring dashboards create --config-from-file=my-dashboard.json --project=PROJECT_ID

Ersetzen Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• PROJECT_ID: Die Kennung des Projekts. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

Wenn Sie beispielsweise ein Dashboard duplizieren möchten, gehen Sie so vor:

1. Führen Sie die Schritte unter Dashboard abrufen aus, um die Definition des ursprünglichen Dashboards herunterzuladen.
2. Bearbeiten Sie das zurückgegebene JSON, um die Felder etag und name zu entfernen und den Wert des Felds displayName zu ändern.
3. Führen Sie den Befehl aus, um das Dashboard zu erstellen.

Weitere Informationen finden Sie in der Referenz zu gcloud monitoring dashboards create.

Terraform

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle. Weitere Informationen finden Sie in der Anbieterreferenzdokumentation zu Terraform.

So erstellen Sie ein Dashboard mit Terraform:

1. Installieren und konfigurieren Sie Terraform für Ihr Projekt. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

2. Verwenden Sie die Terraform-Ressource google_monitoring_dashboard.

   Legen Sie im Befehl die folgenden Felder fest:

   • dashboard_json: Die JSON-Darstellung des Dashboards im Format Dashboards.

     Beispiele für dieses Format finden Sie entweder, indem Sie Ihre Dashboards mit dem APIs Explorer auflisten, oder indem Sie ein Dashboard in der Google Cloud -Konsole öffnen und sich die JSON-Darstellungen ansehen.

   • parent: Der vollqualifizierte Name Ihres Projekts. Sie können dieses Feld beispielsweise auf "projects/PROJECT_ID" festlegen, wobei PROJECT_ID die ID Ihres Google Cloud Projekts ist. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

REST

Um ein neues Dashboard zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt 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

Konfigurieren Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• ${PROJECT_ID}: Eine Umgebungsvariable, in der die Projekt-ID gespeichert ist, in der das Dashboard erstellt werden soll. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

gcloud

Verwenden Sie zum Löschen eines benutzerdefinierten Dashboards gcloud monitoring dashboards delete und geben Sie die vollständig qualifizierte ID des zu löschenden Dashboards an:

gcloud monitoring dashboards delete DASHBOARD_ID --project=PROJECT_ID

Ersetzen Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• PROJECT_ID: Die Kennung des Projekts. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.
• DASHBOARD_ID: Die ID des Dashboards.

Weitere Informationen finden Sie in der Referenz zu gcloud monitoring dashboards delete.

Terraform

Sie können Ressourcen mit Terraform löschen. Informationen zum Löschen von Ressourcen finden Sie im Terraform-Befehl destroy.

REST

Senden Sie zum Löschen eines benutzerdefinierten Dashboards eine DELETE-Anfrage an den Endpunkt Dashboard, der mit der ID des zu löschenden Dashboards qualifiziert ist.

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

Konfigurieren Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• ${PROJECT_ID}: Eine Umgebungsvariable, in der die Projekt-ID gespeichert ist, in der das Dashboard erstellt werden soll. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.
• ${DASHBOARD_ID}: Eine Umgebungsvariable, in der die ID des Dashboards gespeichert ist.

Bei Erfolg gibt die Methode eine leere Antwort zurück. Andernfalls wird ein Fehler zurückgegeben.

gcloud

Verwenden Sie den Befehl gcloud monitoring dashboards list, um alle benutzerdefinierten Dashboards eines Projekts aufzulisten:

gcloud monitoring dashboards list --project=PROJECT_ID

Ersetzen Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• PROJECT_ID: Die Kennung des Projekts. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

Weitere Informationen finden Sie in der Referenz zu gcloud monitoring dashboards list.

Terraform

Sie können Terraform nicht verwenden, um eine Anfrage an Ihr Projekt zu senden, deren Antwort eine Liste von Dashboards ist. Sie können diese Dashboards jedoch über die Google Cloud Konsole aufrufen.

REST

Wenn Sie alle benutzerdefinierten Dashboards eines Projekts auflisten möchten, senden Sie die Projekt-ID an den Endpunkt Dashboard.

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

Konfigurieren Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• ${PROJECT_ID}: Eine Umgebungsvariable, in der die Projekt-ID gespeichert ist, in der das Dashboard erstellt werden soll. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

gcloud

Um die Anzahl der Ressourcen pro Seite anzugeben, übergeben Sie das Flag --page-size mit dem Befehl. Beispiel:

gcloud monitoring dashboards list --page-size=1 --project=PROJECT_ID

Ersetzen Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• PROJECT_ID: Die Kennung des Projekts. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

Terraform

Sie können Terraform nicht verwenden, um eine Anfrage an Ihr Projekt zu senden, deren Antwort eine paginierte Liste von Dashboards ist. Sie können diese Dashboards jedoch über die Google Cloud Konsole aufrufen.

REST

Geben Sie für die erste Seite der Ergebnisliste den Suchparameter pageSize mit der Anfrage an:

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

Konfigurieren Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• ${PROJECT_ID}: Eine Umgebungsvariable, in der die Projekt-ID gespeichert ist, in der das Dashboard erstellt werden soll. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

Die Methode gibt die erste Seite der Liste und das nextPageToken zurück. Beispiel:

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

Für jede verbleibende Seite müssen Sie das entsprechende nextPageToken in der Anfrage angeben.

gcloud

Wenn Sie ein bestimmtes benutzerdefiniertes Dashboard abrufen möchten, verwenden Sie den Befehl gcloud monitoring dashboards describe und geben Sie die Dashboard-ID an:

gcloud monitoring dashboards describe DASHBOARD_ID --format=json --project=PROJECT_ID

Ersetzen Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• PROJECT_ID: Die Kennung des Projekts. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.
• DASHBOARD_ID: Die ID des Dashboards.

Der Befehl gibt das angeforderte Dashboard zurück:

{
  "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"
}

Weitere Informationen finden Sie in der Referenz zu gcloud monitoring dashboards describe.

Terraform

Sie können Terraform nicht verwenden, um eine Anfrage an Ihr Projekt zu senden, deren Antwort ein einzelnes Dashboard ist. Sie können diese Dashboards jedoch über die Google Cloud Konsole aufrufen.

REST

Wenn Sie ein bestimmtes benutzerdefiniertes Dashboard abrufen möchten, senden Sie die Dashboard-ID an den Endpunkt Dashboard.

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

Konfigurieren Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• ${PROJECT_ID}: Eine Umgebungsvariable, in der die Projekt-ID gespeichert ist, in der das Dashboard erstellt werden soll. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.
• ${DASHBOARD_ID}: Eine Umgebungsvariable, in der die ID des Dashboards gespeichert ist.

Im vorherigen Ausdruck ist ${DASHBOARD_ID} eine Umgebungsvariable, die den voll qualifizierten Namen des Dashboards speichert.

Die Methode gibt eine Antwort in etwa wie im folgenden Beispiel zurück:

{
  "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

Verwenden Sie gcloud monitoring dashboards update zum Aktualisieren eines benutzerdefinierten Dashboards, geben Sie die ID des zu aktualisierenden Dashboards an und geben Sie die Änderungen im Dashboard an.

gcloud monitoring dashboards update DASHBOARD_ID --config-from-file=my-updated-dashboard.json --project=PROJECT_ID

Ersetzen Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• PROJECT_ID: Die Kennung des Projekts. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.
• DASHBOARD_ID: Die ID des Dashboards.

Weitere Informationen finden Sie in der Referenz zu gcloud monitoring dashboards update.

Im vorherigen Beispiel wird ein vorhandenes benutzerdefiniertes Dashboard mithilfe der Datei my-updated-dashboard.json aktualisiert. Die Antwort, die einen neuen etag-Wert enthält, ist eine Kopie des aktualisierten Dashboard-Eintrags.

Terraform

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle. Weitere Informationen finden Sie in der Anbieterreferenzdokumentation zu Terraform.

So aktualisieren Sie ein Dashboard mit Terraform:

1. Installieren und konfigurieren Sie Terraform für Ihr Projekt. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

2. Verwenden Sie die Terraform-Ressource google_monitoring_dashboard.

   Legen Sie im Befehl die folgenden Felder fest:

   • dashboard_json: Die JSON-Darstellung des Dashboards im Format Dashboards.

   • parent: Der vollqualifizierte Name Ihres Projekts. Sie können dieses Feld beispielsweise auf "projects/PROJECT_ID" festlegen, wobei PROJECT_ID die ID Ihres Google Cloud Projekts ist. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.

REST

Senden Sie zum Aktualisieren eines benutzerdefinierten Dashboards eine PATCH-Anfrage an den Endpunkt Dashboard und geben Sie das überarbeitete Dashboard-Objekt und den etag-Wert aus der letzten dashboards.get-Antwort.

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}

Konfigurieren Sie vor dem Ausführen des vorherigen Befehls Folgendes:

• ${PROJECT_ID}: Eine Umgebungsvariable, in der die Projekt-ID gespeichert ist, in der das Dashboard erstellt werden soll. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt des für Apps aktivierten Ordners aus.
• ${DASHBOARD_ID}: Eine Umgebungsvariable, in der die ID des Dashboards gespeichert ist.

Im vorherigen Beispiel wird ein vorhandenes benutzerdefiniertes Dashboard mithilfe der Datei my-updated-dashboard.json aktualisiert. Die Antwort, die einen neuen etag-Wert enthält, ist eine Kopie des aktualisierten Dashboard-Eintrags.