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 Apache CouchDB finden Sie unter couchdb.apache.org/.

Vorbereitung

Sie müssen Ops Agent Version 2.11.0 oder höher installieren, um CouchDB-Logs und -Messwerte zu erfassen und aufzunehmen.

Dieser Empfänger unterstützt die Apache CouchDB-Versionen Version 2.3.x und 3.1 und höher.

Ops-Agent für CouchDB konfigurieren

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

Konfigurationsbeispiel

Der folgende Befehl erstellt die Konfigurationsdatei, um Logs und Messwerte für CouchDB zu erfassen und aufzunehmen, und startet den Ops-Agent unter Linux neu.

sudo tee /etc/google-cloud-ops-agent/config.yaml > /dev/null << EOF
logging:
  receivers:
    couchdb:
      type: couchdb
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
metrics:
  receivers:
    couchdb:
      type: couchdb
      username: usr
      password: pwd
  service:
    pipelines:
      couchdb:
        receivers:
          - couchdb
EOF
sudo service google-cloud-ops-agent restart

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
`type`		Der Wert muss `couchdb` betragen.
`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`.
`exclude_paths`		Eine Liste von Dateisystempfadmustern, die aus dem mit `include_paths` übereinstimmenden Satz ausgeschlossen werden sollen.
`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?

Die logName-Logs der Logs couchdb werden von den Empfänger-IDs abgeleitet, die in der Konfiguration angegeben sind. Detaillierte Felder in LogEntry sind:

Feld	Typ	Beschreibung
`httpRequest.serverIp`	String	IP-Adresse des Servers.
`httpRequest.remoteIp`	String	IP-Adresse des Clients.
`httpRequest.requestMethod`	String	HTTP-Methode.
`httpRequest.responseSize`	String (`int64`)	Größe der Antwort
`httpRequest.status`	Zahl	HTTP-Statuscode.
`jsonPayload.remote_user`	String	Authentifizierter Nutzername für die Anfrage.
`jsonPayload.pid`	Zahl	Prozess-ID.
`jsonPayload.message`	String	Log-Nachricht.
`jsonPayload.status_message`	String	Statuscode der Nachricht.
`jsonPayload.node`	String	Knoteninstanzname.
`jsonPayload.host`	String	Host-Instanzname.
`jsonPayload.path`	String	Anfragepfad.
`jsonPayload.remote_user`	String	Nutzer-ID (optional).
`severity`	String (`LogSeverity`)	Ebene des Logeintrags (übersetzt).
`timestamp`	String (`Timestamp`)	Zeitpunkt, zu dem der Eintrag protokolliert wurde

Logeinträge enthalten keine leeren oder fehlenden Felder.

Messwerterfassung konfigurieren

Um Messwerte von CouchDB zu erfassen, müssen Sie einen Empfänger für CouchDB-Messwerte erstellen und dann eine Pipeline für den neuen Empfänger erstellen. Um einen Empfänger für Ihre CouchDB-Messwerte zu konfigurieren, geben Sie die folgenden Felder an:

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

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

Sie können die Messwerte dieser Integration mithilfe eines Cloud Monitoring-Beispiel-Dashboards ansehen. Führen Sie die Schritte unter Beispiel-Dashboards installieren aus, um das CouchDB GCE-Übersichts-Dashboard aus der Beispielbibliothek zu importieren und Diagramme aufzurufen, die Ihre Apache CouchDB-Messwerte anzeigen.

Konfiguration prüfen

Mit dem Log-Explorer und dem Metrics Explorer können Sie prüfen, ob Sie den CouchDB-Empfänger richtig konfiguriert haben. Es kann ein bis zwei Minuten dauern, bis der Ops-Agent beginnt, Logs und Messwerte zu erfassen.

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"
logName=("projects/PROJECT_ID/logs/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.operations'
| align rate(1m)
| 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.