Grafana-Dashboards in Cloud Monitoring importieren

In diesem Dokument wird beschrieben, wie Sie Dashboard-Dateien im Grafana-JSON-Format in Cloud Monitoring importieren. Sie können Grafana-Dashboards auf folgende Arten importieren:

Der Importer konvertiert Dashboard-Dateien im JSON-Format, das von Grafana verwendet wird, in das von Cloud Monitoring verwendete JSON-Format. Ein konvertiertes Dashboard kann sich vom ursprünglichen Grafana-Dashboard unterscheiden. Wenn in einem Grafana-Dashboard beispielsweise Funktionen verwendet werden, die in Cloud Monitoring-Dashboards nicht verfügbar sind, werden diese Aspekte des Grafana-Dashboards nicht konvertiert. Diese Unterschiede werden in den Import-Ergebnissen aufgeführt.

Sie können nur Dashboards importieren, die PromQL-Ausdrücke und Prometheus-Datenquellen verwenden. Dashboards, in denen andere Arten von Abfragen oder Datenquellen verwendet werden, lassen sich möglicherweise nicht importieren.

Informationen zum Importieren von Prometheus-Benachrichtigungen in Cloud Monitoring finden Sie unter Benachrichtigungsregeln und Empfänger aus Prometheus migrieren.

Allgemeine Informationen zum Verwalten importierter Dashboards finden Sie unter Benutzerdefinierte Dashboards erstellen und verwalten.

Hinweise

Unabhängig davon, ob Sie die Google Cloud -Konsole oder das Importtool zum Importieren Ihrer Dashboards verwenden, benötigen Sie eine ausreichende Autorisierung und Dashboards, die importiert werden sollen. Bei Verwendung des Importtools gelten zusätzliche Voraussetzungen.

Autorisierung

Bitten Sie Ihren Administrator, Ihnen die IAM-Rolle Monitoring Editor (roles/monitoring.editor) für Ihr Projekt zuzuweisen, um die Berechtigungen zu erhalten, die Sie zum Erstellen und Ändern benutzerdefinierter Dashboards benötigen. Weitere Informationen zum Zuweisen von Rollen finden Sie unter Zugriff auf Projekte, Ordner und Organisationen verwalten.

Sie können die erforderlichen Berechtigungen auch über benutzerdefinierte Rollen oder andere vordefinierte Rollen erhalten.

Weitere Informationen zu Rollen finden Sie unter Zugriff mit Identity and Access Management steuern.

Grafana-Dashboards zum Importieren sammeln

Wenn Sie Grafana-Dashboards importieren möchten, müssen sie lokal als Dateien im JSON-Format gespeichert sein. Es empfiehlt sich, ein Verzeichnis speziell für diese Dashboard-Dateien zu erstellen.

Dashboards mit der Google Cloud Console importieren

Sie können Grafana-Dashboards über die Seite Monitoring-Dashboards in der Google Cloud Console in Cloud Monitoring importieren.

Grafana-Dashboards importieren

So importieren Sie ein oder mehrere Grafana-Dashboards:

  1. Öffnen Sie in der Google Cloud Console die Seite Dashboards :

    Dashboards aufrufen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Wählen Sie in der Symbolleiste der Google Cloud Console Ihr Google Cloud -Projekt aus. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt aus.

  3. Klicken Sie auf Dashboard importieren.

  4. Klicken Sie auf Durchsuchen, um zu dem Verzeichnis zu wechseln, in dem Sie Ihre Grafana-Dashboards im JSON-Format gespeichert haben, und wählen Sie die Dashboards aus, die Sie importieren möchten.

    Jede JSON-Datei wird nach der Auswahl bereitgestellt. Im Bereich Bereitgestellte Dateien wird angezeigt, ob bei der Konvertierung Probleme aufgetreten sind.

    • Klicken Sie auf  Konvertiertes JSON ansehen, um die Ergebnisse der Konvertierung zu sehen.
    • Klicken Sie auf  Datei entfernen, um ein Dashboard aus dem Importvorgang zu entfernen.

  5. Klicken Sie auf  Importieren. Im Bereich Importergebnisse sehen Sie, ob die einzelnen Dashboards erfolgreich importiert wurden.

  6. Klicken Sie auf  Ansehen, um ein erfolgreich importiertes Dashboard aufzurufen.

Importierte Dashboards ansehen

So rufen Sie Ihre importierten Dashboards auf:

  1. Öffnen Sie in der Google Cloud Console die Seite Dashboards :

    Dashboards aufrufen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Wählen Sie in der Symbolleiste der Google Cloud Console Ihr Google Cloud -Projekt aus. Wählen Sie für App Hub-Konfigurationen das App Hub-Hostprojekt oder das Verwaltungsprojekt aus.

  3. Suchen Sie in der Liste nach dem Dashboard, das Sie aufrufen möchten. So filtern Sie die Liste der Dashboards:

    • Wählen Sie im Menü Typ die Option Benutzerdefiniert aus.

    • Wählen Sie im Bereich Labels das Label cloud-monitoring-dashboard-importer aus, um nur Grafana-Dashboards zu sehen, die über die Google Cloud Console importiert wurden.

    • Verwenden Sie die Filterleiste, um nach Namen zu suchen.

Benutzerdefinierte Labels hinzufügen oder entfernen

Sie können Labels nur benutzerdefinierten Dashboards hinzufügen, einschließlich Dashboards, die Sie importieren. Wenn auf einem Dashboard die Schaltfläche Labels in Dashboard aufnehmen angezeigt wird, können Sie konfigurieren, welche Labels auf das Dashboard angewendet werden.

So fügen Sie einem Dashboard benutzerdefinierte Labels hinzu oder entfernen sie:

  1. Öffnen Sie in der Google Cloud Console die Seite Dashboards :

    Dashboards aufrufen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Suchen Sie in der Liste der Dashboards nach dem gewünschten Dashboard und klicken Sie dann auf  Labels zum Dashboard hinzufügen.
  3. Führen Sie einen der folgenden Schritte aus:

    • Wenn Sie ein Label erstellen und Ihrem Dashboard hinzufügen möchten, geben Sie im Bereich Neues Label erstellen den Namen des Labels in das Textfeld ein und klicken Sie dann auf Erstellen und anwenden.

    • Wenn Sie festlegen möchten, welche Labels Ihrem Dashboard hinzugefügt werden, klicken Sie auf  Labels zum Anwenden auswählen, wählen Sie die Labels aus und klicken Sie dann auf Ok.
  4. Klicken Sie auf Bestätigen, um die Änderungen zu speichern.

Dashboards mit dem Importtool importieren

Sie können mit dem Importer-Tool in einem einzelnen Vorgang Grafana-Dashboards konvertieren und in Cloud Monitoring hochladen oder die Konvertierungs- und Uploadschritte separat ausführen. Möglicherweise wählen Sie diesen Ansatz, wenn Sie die konvertierten Dashboards bearbeiten möchten, bevor Sie sie hochladen.

Zusätzliche Voraussetzungen

Bevor Sie den Dashboard-Importer installieren und ausführen können, müssen Sie Folgendes tun:

  1. Verwenden Sie eine Umgebung, die Bash-Shell-Scripts unterstützt.
  2. Sie müssen Git installieren oder verfügen bereits darüber.
  3. Sie müssen Node.js Version 20.4.1 oder höher installieren oder verfügen bereits darüber.
  4. Sie müssen die Google Cloud CLI installieren oder verfügen bereits darüber. Wenn bei Ihnen die gcloud CLI bereits installiert ist, vergewissern Sie sich, dass Sie die neueste Version haben. Führen Sie dazu den Befehl gcloud components update aus.

Dashboard-Importtool herunterladen

Der Dashboard-Importer ist im GitHub-Repository monitoring-dashboard-samples gespeichert. So rufen Sie das Importtool ab und richten es ein:

  1. Klonen Sie das Repository:

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

  2. Wechseln Sie in das Verzeichnis für den Dashboard-Importer:

    cd monitoring-dashboard-samples/scripts/dashboard-importer

  3. Knotenmodule installieren und Dateien erstellen 

    npm install && npm run build

Der Dashboard-Importer enthält die folgenden Scripts:

  • import.sh, mit dem Dashboards konvertiert und optional in Cloud Monitoring hochgeladen werden.

  • upload.sh, mit dem die konvertierten Dashboards oder beliebige Monitoring-Dashboards in Cloud Monitoring hochgeladen werden. Das Script import.sh ruft dieses Script auf, um den Upload durchzuführen.

Wenn Sie das Script import.sh verwenden, müssen Sie den Speicherort der Grafana-Dashboards angeben, die konvertiert werden sollen. Der Importer erstellt ein Verzeichnis, das die konvertierten Dashboards und andere Informationen enthält. In den folgenden Abschnitten werden diese Verzeichnisse beschrieben.

Grafana-Dashboards, die konvertiert werden sollen

Mit dem Dashboard-Importer können Sie ein oder mehrere Dashboards gleichzeitig konvertieren, indem Sie einen Pfad zu den Dashboard-Dateien angeben.

  • Sie können den Pfad zu einem Verzeichnis mit Dashboards angeben. Es werden nur Dateien im Verzeichnis mit der Erweiterung .json verarbeitet.

  • Sie können den Pfad zu einer einzelnen JSON-Datei angeben. Der Dateiname muss die Erweiterung .json haben.

Konvertierte Dashboards und andere Informationen

Wenn der Importer zum ersten Mal ausgeführt wird, wird ein Unterverzeichnis reports erstellt. Jedes Mal, wenn Sie den Importer ausführen, wird ein neues Ausgabeverzeichnis unter dem Verzeichnis reports erstellt, das nach Datum und Uhrzeit benannt ist. Der Name des Ausgabeverzeichnisses hat die folgende Struktur:
reports/YYYY-M-D/HH:MM:SS

Für jeden Aufruf des Importers enthält das Ausgabeverzeichnis Folgendes:

  • Eine oder mehrere Dateien mit denselben Namen wie die ursprünglichen Grafana-Dashboards, aber jetzt im Cloud Monitoring-JSON-Format.
  • Eine report.json-Datei, in der die folgenden Informationen für jedes konvertierte Dashboard aufgezeichnet werden:
    • Der Name und der Speicherort der konvertierten Grafana-Dashboard-Datei.
    • Der Name und der Speicherort der konvertierten Monitoring-Dashboard-Datei.
    • Hinweise zu allen Funktionen im Grafana-Dashboard, die keine entsprechende Funktion in Cloud Monitoring haben und daher nicht in das konvertierte Dashboard aufgenommen werden konnten.
    • Alle Fehler, die bei der Konvertierung aufgetreten sind.

Wenn Sie die Dashboards hochgeladen haben, enthält das Berichtsverzeichnis auch eine upload_HH:MM:SS.txt-Datei mit der URL, unter der das Dashboard hochgeladen wurde.

Grafana-Dashboards importieren

Verwenden Sie das Script import.sh, um Grafana-Dashboards zu konvertieren und in Cloud Monitoring hochzuladen:

./import.sh PATH_TO_DIRECTORY_OR_FILE PROJECT_ID

Dieses Script tut Folgendes:

  1. Konvertiert Dashboards in PATH_TO_DIRECTORY_OR_FILE vom JSON-Format, das von Grafana verwendet wird, in das von Cloud Monitoring verwendete JSON-Format.

  2. Die konvertierten Dashboards werden mit der Google Cloud CLI in Ihr Google Cloud Projekt PROJECT_ID hochgeladen.

    Wenn Sie sich nicht bei der gcloud CLI authentifiziert haben, führen Sie den Befehl gcloud auth login aus, bevor Sie das Script import.sh ausführen.

Sie können alle Grafana-Dashboards in einem Verzeichnis oder ein einzelnes Dashboard im Verzeichnis importieren.

  • Wenn Sie alle Dashboards im Verzeichnis GRAFANA_DASHBOARDS_DIR in das Projekt PROJECT_ID Google Cloud importieren möchten, geben Sie beim Aufrufen des Scripts das Verzeichnis relativ zum Importerverzeichnis sowie die Zielprojekt-ID an:

    ./import.sh GRAFANA_DASHBOARDS_DIR PROJECT_ID

  • Wenn Sie nur das Dashboard MY_GRAFANA_DASHBOARD.json im Verzeichnis GRAFANA_DASHBOARDS_DIR konvertieren möchten, fügen Sie beim Aufrufen des Scripts den Dateinamen des Dashboards relativ zum Importerverzeichnis hinzu:

    ./import.sh GRAFANA_DASHBOARDS_DIR/MY_GRAFANA_DASHBOARD.json PROJECT_ID

Der Dashboard-Importer enthält ein Beispiel-Grafana-Dashboard als examples/k8s_cluster_example.json. Mit dem folgenden Befehl wird das Dashboard in das angegebene Projekt importiert:

./import.sh examples/k8s_cluster_example.json PROJECT_ID

Bei Aufruf mit der PROJECT_ID my-project-test-1 sieht die Ausgabe etwa so aus:

Converting: Kubernetes Cluster Overview
✓ Kubernetes Cluster Overview converted successfully

Conversion of examples/k8s_cluster_example.json complete. Conversion Report located at: reports/2023-9-28/22:14:57/report.json

To upload these dashboard(s) manually, you can run:
./upload.sh reports/2023-9-28/22:14:57/ <PROJECT_ID>

Conversion Complete. Proceeding to uploading...

Now running: ./upload.sh reports/2023-9-28/22:14:57/ my-project-test-1

Uploading 1 dashboard(s) from a directory with the following args:
Directory: reports/2023-9-28/22:14:57/
Project: my-project-test-1

The following are your dashboards:
- k8s_cluster_example.json

Nachdem das Script import.sh das Ausgabeverzeichnis erstellt und die Dashboards konvertiert hat, werden Sie vor dem Hochladen der konvertierten Dashboards in Ihr Projekt aufgefordert, den Vorgang zu bestätigen. Geben Sie y ein. Das Script lädt das Dashboard hoch und gibt die URL für das neue Dashboard aus:

Would you like to continue? (y/n) y

✓ k8s_cluster_example.json successfully uploaded:
https://console.cloud.google.com/monitoring/dashboards/builder/9c341ef8-cfef-4bdd-98d5-821571c520ef?project=my-project-test-1

Upload log created in reports/2023-9-28/22:14:57/upload_22:14:57.txt

Need to troubleshoot? Please visit:
https://github.com/GoogleCloudPlatform/monitoring-dashboard-samples/tree/master/scripts/dashboard-importer/README.md#troubleshooting

Grafana-Dashboards konvertieren, ohne sie hochzuladen

Wenn Sie die konvertierten Dashboards vor dem Hochladen prüfen oder bearbeiten möchten, lassen Sie den Wert PROJECT_ID beim Aufrufen des Scripts import.sh weg:

./import.sh PATH_TO_DIRECTORY_OR_FILE

Der Importer konvertiert die Dashboards, wie unter Grafana-Dashboards importieren beschrieben, lädt die konvertierten Dashboards jedoch nicht in Cloud Monitoring hoch.

Sie können den Uploadschritt später mithilfe des Scripts upload.sh manuell ausführen.

Dashboards manuell hochladen

Verwenden Sie das Script upload.sh, um Dashboards im Cloud Monitoring-JSON-Format manuell hochzuladen.

    ./upload.sh PATH_TO_DIRECTORY_OR_FILE PROJECT_ID

Das Script upload.sh verwendet die Google Cloud CLI, um die JSON-Dateien hochzuladen. Wenn Sie sich nicht bei der gcloud CLI authentifiziert haben, führen Sie den Befehl gcloud auth login aus, bevor Sie das Script upload.sh ausführen.

  • Geben Sie beim Hochladen aller Dashboards in einem reports/YYYY-M-D/HH:MM:SS-Verzeichnis das Verzeichnis relativ zum Importerverzeichnis sowie die Zielprojekt-ID an, wenn Sie das Script aufrufen:

    ./upload.sh reports/YYYY-M-D/HH:MM:SS PROJECT_ID

    Wenn Sie alle Dashboards aus einem Verzeichnis hochladen, werden Sie vom Script aufgefordert, den Vorgang fortzusetzen oder zu beenden, bevor Sie die Dashboards hochladen.

  • Wenn Sie ein bestimmtes Dashboard in ein reports/YYYY-M-D/HH:MM:SS-Verzeichnis hochladen möchten, geben Sie beim Aufrufen des Scripts das Verzeichnis und den Dateinamen relativ zum Importerverzeichnis sowie die Zielprojekt-ID an:

    ./upload.sh reports/YYYY-M-D/HH:MM:SS/MY_MONITORING_DASHBOARD.json PROJECT_ID

    Wenn Sie ein einzelnes Dashboard aus einem Verzeichnis hochladen, wird das Script ausgeführt, ohne dass Sie zu einer Aktion aufgefordert werden, bevor die Dashboards hochgeladen werden.

Mit dem folgenden Befehl wird beispielsweise ein in einem Unterverzeichnis reports gespeichertes Dashboard in das Projekt Google Cloud my-project-test-1 hochgeladen:

./upload.sh reports/2023-9-26/22:48:31/k8s_cluster_example.json my-project-test-1
Uploading json file: k8s_cluster_example.json to project: my-project-test-1...

✓ k8s_cluster_example.json successfully uploaded:
https://console.cloud.google.com/monitoring/dashboards/builder/25956d9a-93e2-410c-ada1-ec6872cb6665?project=my-project-test-1

Hochgeladene Dashboards ansehen

So rufen Sie Ihre hochgeladenen Dashboards auf:

  1. Öffnen Sie in der Google Cloud Console die Seite Dashboards :

    Dashboards aufrufen

    Wenn Sie diese Seite über die Suchleiste suchen, wählen Sie das Ergebnis aus, dessen Zwischenüberschrift Monitoring ist.

  2. Suchen Sie in der Liste nach dem Dashboard, das Sie aufrufen möchten. So filtern Sie die Liste der Dashboards:

    • Wählen Sie die Kategorie Benutzerdefiniert aus, um nur benutzerdefinierte Dashboards zu sehen.
    • Wählen Sie das Label cloud-ops-grafana-importer aus, um nur Grafana-Dashboards zu sehen, die mit dem Importtool importiert wurden.
    • Verwenden Sie die Filterleiste, um nach Namen zu suchen.

Fehlerbehebung

Wir veröffentlichen gelegentlich kleine Updates und Fehlerkorrekturen für das Tool. Bevor Sie weitere Schritte zur Fehlerbehebung unternehmen, sollten Sie versuchen, das Problem zu beheben, indem Sie mit git pull die neueste Version des Repository herunterladen und dann noch einmal importieren.

Informationen zu Problemen mit den konvertierten Dashboards, z. B. Diagrammen, die keine Daten anzeigen, finden Sie in der Datei README des Importers.

Nächste Schritte