Apache CouchDB

Die Apache CouchDB-Integration erfasst trafficbezogene Messwerte, z. B. die Anzahl der Anfragen an einen Knoten und Antworten vom Knoten. Außerdem werden Datenbankmesswerte erfasst, wie die Anzahl der offenen Vorgänge und die Anzahl der Vorgänge. Die Integration erfasst allgemeine CouchDB- und Zugriffslogs und parst sie in eine JSON-Nutzlast. Das Ergebnis enthält Felder für Nutzer, Host, Ebene und Nachricht.

Weitere Informationen zu CouchDB finden Sie in der Dokumentation zu Apache CouchDB.

Vorbereitung

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

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

Diese Integration unterstützt die CouchDB-Versionen 2.3.x und 3.1 und höher.

Ops-Agent für CouchDB konfigurieren

Fügen Sie die erforderlichen Elemente zum Erfassen von Telemetriedaten aus den CouchDB-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 CouchDB 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:
    couchdb:
      type: couchdb
      username: admin
      password: otelp
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb

logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF

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

Logerfassung konfigurieren

Um Logs von CouchDB aufzunehmen, müssen Sie Empfänger für die von CouchDB 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 couchdb-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/couchdb/couchdb.log]`	Eine Liste mit Dateisystempfaden, die durch Tailing jeder Datei gelesen werden sollen. In den Pfaden kann ein Platzhalter (``) verwendet werden. Beispiel: `/var/log/couchdb/*.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`		Der Wert muss `couchdb` betragen.
`wildcard_refresh_interval`	`60s`	Das Intervall, in dem Platzhalterdateipfade in `include_paths` aktualisiert werden. Wird als Zeitdauer angegeben, z. B. `30s` oder `2m`. Dieses Attribut kann bei hohen Logging-Durchsätzen nützlich sein, wenn Logdateien schneller als das Standardintervall rotiert werden. Muss ein Vielfaches von 1s sein.

Was wird protokolliert?

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

couchdb-Logs enthalten die folgenden Felder in LogEntry:

Feld	Typ	Beschreibung
`httpRequest`	Objekt	Siehe `HTTPRequest`
`jsonPayload.host`	String	Host-Instanzname
`jsonPayload.level`	String	Logeintragsebene
`jsonPayload.message`	String	Log-Nachricht
`jsonPayload.node`	String	Knoteninstanzname
`jsonPayload.path`	String	Anfragepfad
`jsonPayload.pid`	String	Prozess-ID
`jsonPayload.remote_user`	String	Authentifizierter Nutzername für die Anfrage
`jsonPayload.status_message`	String	Statuscode der Nachricht
`severity`	String (`LogSeverity`)	Ebene des Logeintrags (übersetzt).

Logeinträge enthalten keine leeren oder fehlenden Felder.

Messwerterfassung konfigurieren

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

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

Feld	Standard	Beschreibung
`collection_interval`	`60s`	Ein Wert für time.Duration, wie z. B. `30s` oder `5m`.
`password`		Das Passwort für die Verbindung mit dem Server.
`server_status_url`	`http://localhost:5984`	Die von CouchDB bereitgestellte URL.
`type`		Der Wert muss `couchdb` betragen.
`username`		Das Nutzername für die Verbindung mit dem Server.

Was wird überwacht?

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

Messwerttyp
Art, Typ Überwachte Ressourcen	Label
`workload.googleapis.com/couchdb.average_request_time`
`GAUGE`, `DOUBLE` gce_instance
`workload.googleapis.com/couchdb.database.open`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.database.operations`
`CUMULATIVE`, `INT64` gce_instance	`operation`
`workload.googleapis.com/couchdb.file_descriptor.open`
`GAUGE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.bulk_requests`
`CUMULATIVE`, `INT64` gce_instance
`workload.googleapis.com/couchdb.httpd.requests`
`CUMULATIVE`, `INT64` gce_instance	`http_method`
`workload.googleapis.com/couchdb.httpd.responses`
`CUMULATIVE`, `INT64` gce_instance	`http_status_code`
`workload.googleapis.com/couchdb.httpd.views`
`CUMULATIVE`, `INT64` gce_instance	`view`

Beispieldashboard

Damit Sie Ihre CouchDB-Messwerte aufrufen können, müssen Sie ein Diagramm oder ein Dashboard konfiguriert haben. Cloud Monitoring bietet eine Bibliothek mit Beispiel-Dashboards für Integrationen, die vorkonfigurierte Diagramme enthalten. Informationen zum Installieren dieser Dashboards finden Sie unter Beispiel-Dashboards installieren.

Konfiguration prüfen

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

Um zu prüfen, ob die Logs aufgenommen wurden, rufen Sie den Log-Explorer auf. Führen Sie dann die folgende Abfrage aus, um die CouchDB-Logs aufzurufen:

resource.type="gce_instance"
log_id("couchdb")

Um zu prüfen, ob die Messwerte aufgenommen wurden, rufen Sie den Metrics Explorer auf und führen Sie die folgende Abfrage auf dem Tab MQL aus:

fetch gce_instance
| metric 'workload.googleapis.com/couchdb.database.open'
| every 1m

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.