MongoDB Flex mit STACKIT Observability verbinden

Um eine visuelle Darstellung Ihrer Metriken zu erhalten und Ihre Metriken zu speichern, können Sie den Service STACKIT Observability nutzen. In den folgenden Schritten erfahren Sie, wie Sie MongoDB in Ihre Instanz des Observability-Service integrieren.

Voraussetzungen

Sie haben eine STACKIT MariaDB-Instanz erstellt. Prüfen Sie Erstellen und Verwalten von MongoDB Flex-Instanzen.
Sie haben einen STACKIT Observability Managed Service konfiguriert und in Betrieb. Prüfen Sie Ihren ersten Observability-Service erstellen und konfigurieren.
Sie verfügen über eine laufende Instanz von Grafana Alloy. Diese Anleitung geht davon aus, dass Sie einen Container verwenden. Aus diesem Grund beziehen wir uns im Text darauf. Sie können auch eine virtuelle Maschine verwenden oder sie in einer anderen Umgebung ausführen.

Vorbereitung

Bevor Sie die Grafana Alloy-Umgebung konfigurieren, müssen Sie den benötigten Service-Account vorbereiten. Diese Anleitung verwendet hierfür das STACKIT Portal. Sie können auch die STACKIT CLI verwenden.

Einen Service-Account erstellen und Zugriff auf die API gewähren

Navigieren Sie zu IAM und Verwaltung > Service-Accounts.
Klicken Sie auf + Service-Account erstellen.
Geben Sie dem neuen Service-Account einen Namen und klicken Sie auf Erstellen. Der Account wurde erstellt.
Wechseln Sie in den Account, indem Sie auf seinen Namen klicken.
Navigieren Sie zu Service-Account-Schlüssel.
Klicken Sie auf + Service-Account-Schlüssel erstellen.
Wählen Sie Neues Schlüsselpaar erstellen und klicken Sie auf Erstellen.
Laden Sie die neu erstellten Zugangsdaten herunter. Sie benötigen mindestens die JSON-Datei, die alle relevanten Informationen enthält.

Speichern Sie die Dateien an einem sicheren Ort, da sie sicherheitsrelevante Informationen enthalten.
Navigieren Sie zu IAM und Verwaltung > Zugriff.
Klicken Sie auf + Zugriff gewähren.
Fügen Sie die E-Mail-Adresse (ID) des neu erstellten Service-Accounts hinzu.
Wählen Sie die Rolle MongoDB Flex Reader aus und klicken Sie auf Speichern.

Observability-API-Zugangsdaten erstellen

Navigieren Sie zu Logging & Monitoring > Observability.
Wählen Sie Ihre Observability-Instanz aus.
Navigieren Sie zu API > Zugangsdaten.
Klicken Sie auf + Zugangsdaten erstellen und anschließend auf Erstellen.

Der Benutzername und das Passwort werden automatisch erstellt. Bewahren Sie diese an einem sicheren Ort auf.

Hilfs-Skripte vorbereiten und Grafana Alloy konfigurieren

Kopieren Sie die JSON-Datei, die Sie unter Vorbereitung heruntergeladen haben, auf Ihre virtuelle Maschine.

In dieser Anleitung kopieren wir sie nach /usr/local/etc/stackit/sa/service-account.json. Wenn Sie einen anderen Ort wählen, müssen Sie die Befehle in den folgenden Schritten anpassen.

Die JSON-Datei enthält sensible Informationen. Schützen Sie diese, z. B. mit chown oder chmod.
Erstellen Sie einen Cronjob zur Aktualisierung des Bearer-Tokens.

Versuchen Sie manuell, ein Token mit der STACKIT CLI abzurufen.
Terminal-Fenster
```
stackit auth activate-service-account --service-account-key-path /usr/local/etc/stackit/sa/service-account.json --only-print-access-token
```
Die maximale Lebensdauer eines Tokens beträgt 60 Minuten, daher muss das Token vorher erneuert werden. Um diesen Schritt zu automatisieren, können Sie diesen Befehl in die Crontab eintragen und das Token in eine neue Datei schreiben. Auch diese Datei sollte geschützt werden.
```
*/5 * * * * /usr/bin/stackit auth activate-service-account --service-account-key-path /usr/local/etc/stackit/sa/service-account.json --only-print-access-token > /run/secrets/bearer_token 2>/dev/null
```

Grafana Alloy konfigurieren Konfigurieren Sie nun Grafana Alloy nach Ihren Bedürfnissen. Verwenden Sie den folgenden Codeschnipsel, um die MongoDB Flex-Metriken abzurufen und sie an STACKIT Observability weiterzuleiten. Ersetzen Sie projectID, region, mongoDBFlexInstanceID, jobName, ObservabilityInstanceID und observabilityAPIUsername durch die entsprechenden Werte.

prometheus.scrape "mongodb" {
  targets = [
    {
    __address__ = "mongodb-prom-proxy.api.stackit.cloud:443",
    __metrics_path__ = "/v2/projects/[projectID]/regions/[region]/instances/[mongoDBFlexInstanceID]/metrics",
    },
  ]

  forward_to    = [
    prometheus.remote_write.observability.receiver,
  ]
  job_name        = "[jobName]"
  scheme          = "https"
  scrape_interval = "5m"


  authorization {
    type             = "Bearer"
    credentials_file = "/run/secrets/bearer_token"
  }
}


prometheus.remote_write "observability" {
  endpoint {
    url = "[https://push.metrics.stackit5.argus.eu01.stackit.cloud/instances/](https://push.metrics.stackit5.argus.eu01.stackit.cloud/instances/)`ObservabilityInstanceID`/api/v1/receive"

    basic_auth {
    username = "[observabilityAPIUsername]"
    password_file = "/run/secrets/observability_write_password"
    }
  }
}

Starten Sie den Container oder Service neu.
Testen Sie Grafana Alloy.

Öffnen Sie Ihre Grafana Alloy-Instanz mit einem Browser. Das Dashboard zeigt die definierten Komponenten mit ihrem Status an. Die Spalte “Health” sollte für Ihre Konfigurationen “healthy” anzeigen, entsprechend dem untenstehenden Screenshot.

Ergebnis mit STACKIT Observability prüfen

Navigieren Sie zu Logging & Monitoring > Observability.
Wählen Sie Ihre Observability-Instanz aus.
Navigieren Sie zu Grafana und folgen Sie dem Link zum Grafana Dashboard.
Melden Sie sich mit Ihren Zugangsdaten (oder SSO) an.
Navigieren Sie in Grafana zu Explore > Metrics.
Klicken Sie auf + New metric exploration.

Suchen Sie auf der Seite für die Metrikerkundung nach mongodb_. Sie sollten nun die MongoDB Flex-Metriken sehen:

Verbessern Sie die Arbeit mit STACKIT Grafana durch den Import unserer Vorlage

Wir bieten eine STACKIT Grafana-Vorlage an, die auf STACKIT MongoDB Flex zugeschnitten ist. Besuchen Sie den Referenzartikel Observability-Metriken von MongoDB Flex, um die Datei herunterzuladen.