MongoDB

Die MongoDB-Integration erfasst hauptsächlich Datenbankmesswerte wie die Anzahl der Vorgänge und Objekte sowie die Ressourcennutzung. Die Integration erfasst auch MongoDB-Logs und parst sie in eine JSON-Nutzlast. Das Ergebnis enthält Felder für Kontext, Komponente, Ebene und Nachricht.

Weitere Informationen zu MongoDB finden Sie in der MongoDB-Dokumentation.

Vorbereitung

Zum Erfassen von MongoDB-Telemetriedaten müssen Sie den Ops-Agent installieren:

  • Installieren Sie für Messwerte Version 2.19.0 oder höher.
  • Installieren Sie für Logs die Version 2.10.0 oder höher.

Diese Integration unterstützt die MongoDB-Versionen 2.6, 3.x, 4.x und 5.0.

Ops-Agent für MongoDB konfigurieren

Fügen Sie die erforderlichen Elemente zum Erfassen von Telemetriedaten aus den MongoDB-Instanzen gemäß der Anleitung unter Ops-Agent konfigurieren hinzu und starten Sie den Agent neu.

Konfigurationsbeispiel

Der folgende Befehl erstellt die Konfiguration zum Erfassen und Aufnehmen von Telemetriedaten für MongoDB und startet den Ops-Agent neu.

# Configures Ops Agent to collect telemetry from the app and restart Ops Agent.

set -e

# Create a back up of the existing file so existing configurations are not lost.
sudo cp /etc/google-cloud-ops-agent/config.yaml /etc/google-cloud-ops-agent/config.yaml.bak

# Configure the Ops Agent.
sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
metrics:
  receivers:
    mongodb:
      type: mongodb
      insecure: true
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
logging:
  receivers:
    mongodb:
      type: mongodb
  service:
    pipelines:
      mongo:
        receivers: [mongodb]
EOF

sudo service google-cloud-ops-agent restart
sleep 60

Logerfassung konfigurieren

Um Logs von MongoDB aufzunehmen, müssen Sie Empfänger für die von Vault erzeugten Logs erstellen und dann eine Pipeline für die neuen Empfänger erstellen.

Geben Sie die folgenden Felder an, um einen Empfänger für Ihre mongodb-Logs zu konfigurieren:

Feld Standard Beschreibung
exclude_paths Eine Liste von Dateisystempfadmustern, die aus dem mit include_paths übereinstimmenden Satz ausgeschlossen werden sollen.
include_paths [/var/log/mongodb/mongod.log*] Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (*) verwendet werden. Beispiel: /var/log/mongodb/*.log.
record_log_file_path false Wenn true festgelegt ist, wird der Pfad zu der spezifischen Datei, aus der der Logdatensatz abgerufen wurde, im Ausgabelogeintrag als Wert des Labels agent.googleapis.com/log_file_path angezeigt. Bei Verwendung eines Platzhalters wird nur der Pfad der Datei aufgezeichnet, aus der der Eintrag abgerufen wurde.
type Dieser Wert muss mongodb sein.
wildcard_refresh_interval 60s Das Intervall, in dem Platzhalterdateipfade in include_paths aktualisiert werden. Wird als time.ParseDuration angegeben, z. B. 30s oder 2m. Muss ein Mehrfaches von 1s sein. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden.

Was wird protokolliert?

Der logName wird von den Empfänger-IDs abgeleitet, die in der Konfiguration angegeben sind. Detaillierte Felder in LogEntry sind:

mongodb-Logs enthalten die folgenden Felder in LogEntry:

Feld Typ Beschreibung
jsonPayload.attributes Objekt (optional) Objekt, das ein oder mehrere Schlüssel/Wert-Paare für zusätzliche Attribute enthält
jsonPayload.component String Kategorisierung der Lognachricht. Eine vollständige Liste finden Sie in der MongoDB-Dokumentation.
jsonPayload.context String
jsonPayload.ctx String Der Name des Threads, der die Loganweisung ausgibt.
jsonPayload.id Zahl Log-ID.
jsonPayload.message String Log-Nachricht.
jsonPayload.severity String Logeintragsebene.
severity String (LogSeverity) Ebene des Logeintrags (übersetzt).

Messwerterfassung konfigurieren

Um Messwerte von MongoDB aufzunehmen, müssen Sie einen Empfänger für die von MongoDB erzeugten Messwerte erstellen und dann eine Pipeline für den neuen Empfänger erstellen.

Dieser Empfänger unterstützt die Verwendung mehrerer Instanzen in der Konfiguration, z. B. zum Überwachen mehrerer Endpunkte, nicht. Alle diese Instanzen schreiben in dieselbe Zeitachse und Cloud Monitoring kann sie nicht unterscheiden.

Um einen Empfänger für Ihre mongodb-Messwerte zu konfigurieren, geben Sie die folgenden Felder an:

Feld Standard Beschreibung
ca_file Pfad zum CA-Zertifikat. Als Client wird dadurch das Serverzertifikat verifiziert. Wenn leer, verwendet der Empfänger die System-Stammzertifizierungsstelle.
cert_file Pfad zum TLS-Zertifikat, das für TLS-fähige Verbindungen verwendet werden soll.
collection_interval 60s Ein time.Duration-Wert wie 30s oder 5m.
endpoint localhost:27017 Der Hostname, die IP-Adresse oder der UNIX-Domain-Socket. Ein Port kann wie :angegeben werden. Wenn kein Port angegeben ist, wird der Standardport 27017 verwendet.
insecure true Legt fest, ob eine sichere TLS-Verbindung verwendet werden soll. Wenn false festgelegt ist, ist TLS aktiviert.
insecure_skip_verify false Legt fest, ob die Bestätigung des Zertifikats übersprungen werden soll. Wenn unsicher auf true gesetzt ist, wird der Wert insecure_skip_verify nicht verwendet.
key_file Pfad zum TLS-Schlüssel, der für mTLS-erforderliche Verbindungen verwendet werden soll, z. B. der in der Datei tlsCertificateKeyFile verwendete Schlüssel.
password Passwort für die Authentifizierung bei der MongoDB-Instanz. Erforderlich, wenn der Nutzername festgelegt wird.
type Dieser Wert muss mongodb sein.
username Nutzername für die Authentifizierung bei der MongoDB-Instanz. Erforderlich, wenn das Passwort festgelegt ist.

Was wird überwacht?

Die folgende Tabelle enthält die Liste der Messwerte, die der Ops-Agent aus der MongoDB-Instanz erfasst.

Messwerttyp
Art, Typ
Überwachte Ressourcen		 Label
workload.googleapis.com/mongodb.cache.operations
CUMULATIVE, INT64
gce_instance 		type
workload.googleapis.com/mongodb.collection.count
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.connection.count
GAUGE, INT64
gce_instance 		database
type
workload.googleapis.com/mongodb.cursor.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.cursor.timeout.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.data.size
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.database.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.document.operation.count
GAUGE, INT64
gce_instance 		database
operation
workload.googleapis.com/mongodb.global_lock.time
CUMULATIVE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.index.access.count
GAUGE, INT64
gce_instance 		collection
database
workload.googleapis.com/mongodb.index.count
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.index.size
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.memory.usage
GAUGE, INT64
gce_instance 		database
type
workload.googleapis.com/mongodb.network.io.receive
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.network.io.transmit
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.network.request.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.object.count
GAUGE, INT64
gce_instance 		database
workload.googleapis.com/mongodb.operation.count
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mongodb.operation.time
CUMULATIVE, INT64
gce_instance 		operation
workload.googleapis.com/mongodb.session.count
GAUGE, INT64
gce_instance 		 
workload.googleapis.com/mongodb.storage.size
CUMULATIVE, INT64
gce_instance 		database

Konfiguration prüfen

In diesem Abschnitt wird beschrieben, wie Sie prüfen können, ob Sie den MongoDB-Empfänger richtig konfiguriert haben. Es kann ein oder zwei Minuten dauern, bis der Ops-Agent Telemetriedaten erfasst.

So prüfen Sie, ob MongoDB-Logs an Cloud Logging gesendet werden:

  1. Rufen Sie in der Google Cloud Console die Seite Log-Explorer auf.

    Zum Log-Explorer

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

  2. Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen: 
    resource.type="gce_instance"
log_id("mongodb")

So prüfen Sie, ob MongoDB-Messwerte an Cloud Monitoring gesendet werden:

  1. Rufen Sie in der Google Cloud Console die Seite Metrics Explorer auf.

    Zum Metrics Explorer

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

  2. Klicken Sie in der Symbolleiste des Bereichs "Query Builder" auf die Schaltfläche  MQL oder  PromQL.
  3. Prüfen Sie, ob MQL im Schalter Sprache ausgewählt ist. Die Sprachschaltfläche befindet sich in derselben Symbolleiste, mit der Sie Ihre Abfrage formatieren können.
  4. Geben Sie im Editor die folgende Abfrage ein und klicken Sie dann auf Abfrage ausführen: 
    fetch gce_instance
| metric 'workload.googleapis.com/mongodb.memory.usage'
| every 1m

Dashboard aufrufen

Damit Sie Ihre MongoDB-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Die MongoDB-Einbindung enthält ein oder mehrere Dashboards. Alle Dashboards werden automatisch installiert, nachdem Sie die Integration konfiguriert haben und der Ops-Agent mit dem Erfassen von Messwertdaten begonnen hat.

Sie können auch eine statische Vorschau von Dashboards aufrufen, ohne die Integration zu installieren.

So rufen Sie ein installiertes Dashboard auf:

  1. Rufen Sie in der Google Cloud Console die Seite Dashboards auf.

    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 den Tab Dashboard-Liste und dann die Kategorie Integrationen aus.
  3. Wählen Sie den Namen des Dashboards aus, das Sie aufrufen möchten.

Wenn Sie eine Integration konfiguriert haben, das Dashboard jedoch nicht installiert ist, prüfen Sie, ob der Ops-Agent ausgeführt wird. Wenn im Dashboard keine Messwertdaten für ein Diagramm vorhanden sind, schlägt die Installation des Dashboards fehl. Nachdem der Ops-Agent mit dem Erfassen von Messwerten begonnen hat, wird das Dashboard für Sie installiert.

So rufen Sie eine statische Vorschau des Dashboards auf:

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

    Zu „Integrationen“

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

  2. Klicken Sie auf den Filter für die Deployment-Plattform Compute Engine.
  3. Suchen Sie den Eintrag für MongoDB und klicken Sie auf Details ansehen.
  4. Wählen Sie den Tab Dashboards aus, um eine statische Vorschau aufzurufen. Wenn das Dashboard installiert ist, können Sie es aufrufen. Klicken Sie dazu auf Dashboard aufrufen.

Weitere Informationen zu Dashboards in Cloud Monitoring finden Sie unter Dashboards und Diagramme.

Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.

Benachrichtigungsrichtlinien installieren

Durch Benachrichtigungsrichtlinien wird Cloud Monitoring angewiesen, Sie zu benachrichtigen, wenn bestimmte Bedingungen auftreten. Die MongoDB-Integration enthält eine oder mehrere Benachrichtigungsrichtlinien, die Sie verwenden können. Sie können diese Benachrichtigungsrichtlinien auf der Seite Integrationen in Monitoring aufrufen und installieren.

So zeigen Sie die Beschreibungen der verfügbaren Benachrichtigungsrichtlinien an und installieren sie:

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

    Zu „Integrationen“

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

  2. Suchen Sie den Eintrag für MongoDB und klicken Sie auf Details ansehen.
  3. Wählen Sie den Tab Benachrichtigungen aus. Dieser Tab enthält Beschreibungen der verfügbaren Benachrichtigungsrichtlinien und eine Oberfläche für deren Installation.
  4. Installieren Sie Benachrichtigungsrichtlinien. Benachrichtigungsrichtlinien müssen wissen, wohin Benachrichtigungen gesendet werden sollen, dass die Benachrichtigung ausgelöst wurde. Daher benötigen sie Informationen von Ihnen für die Installation. So installieren Sie Benachrichtigungsrichtlinien:
    1. Wählen Sie aus der Liste der verfügbaren Benachrichtigungsrichtlinien die Richtlinien aus, die Sie installieren möchten.

    2. Wählen Sie im Abschnitt Benachrichtigungen konfigurieren einen oder mehrere Benachrichtigungskanäle aus. Sie haben die Möglichkeit, die Verwendung von Benachrichtigungskanälen zu deaktivieren. In diesem Fall werden Ihre Benachrichtigungsrichtlinien jedoch automatisch ausgelöst. Sie können ihren Status in Monitoring prüfen, aber Sie erhalten keine Benachrichtigungen.

      Weitere Informationen zu Benachrichtigungskanälen finden Sie unter Benachrichtigungskanäle verwalten.

    3. Klicken Sie auf Richtlinien erstellen.

Weitere Informationen zu Benachrichtigungsrichtlinien in Cloud Monitoring finden Sie unter Einführung in Benachrichtigungen.

Weitere Informationen zur Verwendung der Seite Integrationen finden Sie unter Integrationen verwalten.

Nächste Schritte

Eine Anleitung zur Installation von Ops-Agent mit Ansible zum Konfigurieren einer Drittanbieteranwendung und zum Installieren eines Beispieldashboards finden Sie im Video Ops-Agent installieren, um Fehler in Drittanbieteranwendungen zu beheben.