Google verwendet KI-Technologie, um Inhalte in Ihre bevorzugte Sprache zu übersetzen. KI-Übersetzungen können Fehler enthalten.

Visualisierungs-Dashboards erstellen

Auf dieser Seite wird beschrieben, wie Sie Dashboards in Ihrer Grafana-Instanz erstellen und verwalten, die für die Visualisierung von Logs und Messwerten aus Ihrem GDC-Projekt (Google Distributed Cloud) mit Air Gap verwendet werden.

Ein Dashboard bietet eine dynamische visuelle Darstellung der Systemleistung. Es besteht aus einem oder mehreren anpassbaren Feldern, die jeweils so konfiguriert sind, dass sie bestimmte Messwerte aus Ihren GDC-Komponenten abfragen und anzeigen. Mit diesen Feldern können Sie Folgendes tun:

Messwerte mit verschiedenen Diagrammtypen visualisieren
Benachrichtigungsgrenzwerte definieren, um Benachrichtigungen basierend auf Messwerten auszulösen
Anzeigeeigenschaften wie Labels, Einheiten und Zeiträume anpassen
Einheitliche Zeitauflösungen für genaue Vergleiche festlegen

Wenn Sie Grafana-Dashboards effektiv nutzen, können Sie wertvolle Einblicke in die Leistung und den Zustand Ihrer GDC-Umgebung gewinnen.

Hinweis

Zum Verwalten benutzerdefinierter Dashboard- und ConfigMap-Ressourcen benötigen Sie die erforderlichen Berechtigungen.

IAM-Organisationsrollen anfordern

Wenden Sie sich an Ihren IAM-Administrator der Organisation, um die folgenden Rollen für die Arbeit mit Dashboards in einer Organisation anzufordern:

Dashboard PA Creator (dashboard-pa-creator): Benutzerdefinierte Dashboards erstellen.
Dashboard PA Editor (dashboard-pa-editor): Benutzerdefinierte Dashboards bearbeiten oder löschen.
Dashboard PA Viewer (dashboard-pa-viewer): Benutzerdefinierte Dashboards ansehen.

IAM-Projektrollen anfordern

Wenden Sie sich an Ihren IAM-Administrator des Projekts, um die folgenden Rollen für die Arbeit mit Dashboards und Konfigurationen in einem Projekt anzufordern:

Dashboard Editor (dashboard-editor): Benutzerdefinierte Dashboards im Projekt-Namespace erstellen, bearbeiten und löschen.
Dashboard Viewer (dashboard-viewer): Benutzerdefinierte Dashboards im Projekt-Namespace ansehen.
ConfigMap Editor (observabilitypipeline-configmap-editor): ConfigMap im Projekt-Namespace erstellen und bearbeiten.

Umgebung vorbereiten

Nachdem Sie die entsprechenden Rollen erhalten haben, führen Sie die folgenden Schritte aus, bevor Sie Dashboards erstellen:

Erfassen Sie Messwerte aus Ihren Arbeitslasten.
Legen Sie den Pfad der kubeconfig-Datei als Umgebungsvariable fest:
```
export KUBECONFIG=KUBECONFIG_PATH
```
Ersetzen Sie KUBECONFIG_PATH durch den Pfad zur kubeconfig-Datei für den Management API-Server, auf dem Sie das Dashboard erstellen möchten.

Grafana-Endpunkt ermitteln

Die folgende URL ist der Endpunkt der Grafana-Instanz Ihres Projekts:

https://GDC_URL/PROJECT_NAMESPACE/grafana

Ersetzen Sie Folgendes:

GDC_URL: die URL Ihrer Organisation in GDC.
PROJECT_NAMESPACE: Ihr Projekt-Namespace.

Der Grafana-Endpunkt für das platform-obs Projekt in der org-1 Organisation ist https://org-1/platform-obs/grafana.

Benutzerdefiniertes Dashboard erstellen

So erstellen Sie ein Grafana-Dashboard und passen die Einstellungen an:

Öffnen Sie Ihren Grafana-Endpunkt, um die Benutzeroberfläche aufzurufen.
Klicken Sie im Navigationsmenü auf Hinzufügen.
Klicken Sie im Drop-down-Menü auf Dashboard. Grafana erstellt ein leeres Dashboard.
Fügen Sie dem leeren Dashboard alle gewünschten Felder hinzu.
Wählen Sie im Menü Datenquelle jedes Felds die gewünschte Datenquelle aus, einschließlich Messwerte (prometheus), Audit-Logs (auditloki) und Betriebs-Logs (oploki).

Für Universen mit mehreren Zonen bietet Grafana Datenquellen mit Zonenlabels, mit denen Sie Dashboard-Visualisierungen mit Messwerten und Logs aus mehreren Zonen erstellen können. Diese Datenquellen werden im Format DATA_SOURCE-ZONE_ID benannt, wobei gilt:
- DATA_SOURCE kann einen der folgenden Werte annehmen:
  - Prometheus (prometheus oder metrics) zum Anzeigen von Messwerten.
  - Audit-Logs (auditloki) zum Anzeigen von Audit-Logs.
  - Betriebs-Logs (oploki) zum Anzeigen von Betriebs-Logs.
- ZONE_ID ist die ID der Zone, aus der Sie Daten im Dashboard anzeigen möchten.
Wenn Sie ein Visualisierungs-Dashboard für zonenübergreifende Ressourcen erstellen möchten, lautet der Name der Datenquelle --Mixed--. Mit dieser Datenquelle können Sie mehrere Abfragen pro Zone hinzufügen und zonenübergreifende Datenvisualisierungen in einem einzigen Dashboard erstellen. Mit dieser Funktion können Sie beispielsweise Verhaltensvergleiche zwischen einer einzelnen Messwert- oder Log-Abfrage in mehreren Zonen Ihres Universums durchführen.
Passen Sie die Details an und bearbeiten Sie die Felder, um Ihre Abfragen einzugeben oder andere Aktualisierungen vorzunehmen.

Tipp: Wenn Sie Ihr Dashboard anpassen, implementieren Sie Best Practices für Ihren Anwendungs fall, um die Visualisierung und Interpretation von Daten zur Beobachtbarkeit Ihrer Komponenten zu erleichtern. Legen Sie beispielsweise Akzeptanzschwellen fest, zeigen Sie nützliche Signale an, fügen Sie Diagrammen Labels hinzu und wählen Sie eine einheitliche Zeitauflösung aus.
Klicken Sie in der Menüleiste auf Dashboard-Einstellungen, um die Seite Einstellungen zu öffnen.
Wählen Sie im Navigationsmenü JSON-Modell aus.
Kopieren Sie das JSON-Modell des Dashboards und fügen Sie es zur späteren Verwendung in eine Nur-Text-Datei ein.

`ConfigMap`-Objekt erstellen

So erstellen Sie ein ConfigMap-Objekt, das das JSON-Modell des Dashboards enthält:

Öffnen Sie ein Terminalfenster.
Erstellen Sie ein ConfigMap-Objekt. Fügen Sie im Abschnitt data Ihres ConfigMap-Objekts das zuvor kopierte JSON-Modell ein:
```
apiVersion: v1
kind: ConfigMap
metadata:
  namespace: PROJECT_NAMESPACE
  name: CONFIGMAP_NAME
data:
  JSON_FILE_NAME.json: |
    {
    JSON_MODEL
    }
```
Ersetzen Sie Folgendes:
- PROJECT_NAMESPACE: Ihr Projekt-Namespace.
- CONFIGMAP_NAME: der Name, den Sie Ihrem ConfigMap-Objekt geben möchten.
- JSON_FILE_NAME: der Name, den Sie der Datei für das JSON-Modell des Dashboards geben möchten.
- JSON_MODEL: das JSON-Modell Ihres benutzerdefinierten Dashboards.
Ein Beispiel dafür, wie dieses Objekt aussehen muss, finden Sie unter ein ConfigMap Beispiel.

Wenden Sie das ConfigMap-Objekt auf den Management API-Server an:

kubectl --kubeconfig ${KUBECONFIG} apply -f CONFIGMAP_NAME.yaml

`ConfigMap`-Beispiel

Die folgende YAML-Datei zeigt ein Beispiel für das ConfigMap-Objekt eines Dashboards im Namespace platform-obs:

  apiVersion: v1
  kind: ConfigMap
  metadata:
    namespace: platform-obs
    name: my-project-dashboard-configmap
  data:
    my-project-dashboard.json: |
      {
      "annotations": {
        "list": [
          {
            "builtIn": 1,
            "datasource": "--",
            "enable": true,
            "hide": true,
            "iconColor": "rgba(0, 211, 255, 1)",
            "name": "Annotations & Alerts",
            "type": "dashboard"
          }
        ]
      },
      "editable": true,
      "graphTooltip": 0,
      "id": null,
      "links": [],
      "panels": [],
      "schemaVersion": 27,
      "style": "dark",
      "tags": [],
      "templating": {
        "list": []
      },
      "time": {
        "from": "now-6h",
        "to": "now"
      },
      "timepicker": {},
      "timezone": "",
      "title": "Sample dashboard",
      "uid": null,
      "version": 0
      }

Benutzerdefinierte `Dashboard`-Ressource erstellen

So erstellen Sie eine benutzerdefinierte Dashboard-Ressource und importieren Ihr benutzerdefiniertes Dashboard in die Grafana-Instanz Ihres Projekts:

Öffnen Sie ein Terminalfenster.
Erstellen Sie eine benutzerdefinierte Dashboard-Ressource und konfigurieren Sie die Datei mit dem Namen, den Sie dem ConfigMap-Objekt gegeben haben:
```
apiVersion: observability.gdc.goog/v1
kind: Dashboard
metadata:
  namespace: PROJECT_NAMESPACE
  name: DASHBOARD_NAME
spec:
  configMapRef:
    name: CONFIGMAP_NAME
    namespace: PROJECT_NAMESPACE
    key: JSON_FILE_NAME.json
  foldername: Default
```
Ersetzen Sie Folgendes:
- PROJECT_NAMESPACE: Ihr Projekt-Namespace.
- DASHBOARD_NAME: der Name, den Sie Ihrer benutzerdefinierten Dashboard-Ressource geben möchten.
- CONFIGMAP_NAME: der Name, den Sie dem ConfigMap Objekt gegeben haben.
- JSON_FILE_NAME: der Name, den Sie der Datei gegeben haben, die das JSON-Modell des Dashboards im ConfigMap-Objekt enthält.
Hinweis: Wenn Sie Dashboards in Ordnern organisieren möchten, geben Sie die foldername im spec Abschnitt der Dashboard Ressource an. Wenn Sie dieses Feld weglassen, wird standardmäßig der Default Ordner verwendet. Ordner werden automatisch erstellt, wenn sie nicht vorhanden sind.
Wenden Sie die benutzerdefinierte Dashboard-Ressource auf den Management API-Server an:
```
kubectl --kubeconfig ${KUBECONFIG} apply -f DASHBOARD_NAME.yaml
```

Das System überwacht Änderungen an der benutzerdefinierten Dashboard-Ressource und am zugehörigen ConfigMap-Objekt. Wenn Sie ein Dashboard aktualisieren oder löschen möchten, ändern Sie diese Ressourcen. Alle Änderungen lösen eine Aktualisierung von Grafana aus. In der Grafana-Benutzeroberfläche vorgenommene Aktualisierungen können nicht gespeichert werden.