CouchDB Plugin

CouchDB is an open-source NoSQL database that uses JSON to store data. It uses JavaScript as its query language using MapReduce, and HTTP for an API. For more information visit couchdb.apache.org.

Discovery

Even if the CouchDB plugin is not configured, Stackdriver Monitoring will discover CouchDB services running in your Cloud Platform project by:

  • searching instance names for couchdb
  • checking for ports opened to 5984 via firewall rules

The services discovered are displayed on the CouchDB Services page in the Resources menu. After you install the monitoring agent and configure the CouchDB plugin on your instances, Stackdriver Monitoring populates the CouchDB Services page with inventory and metrics.

Configuring Stackdriver Monitoring to monitor CouchDB

After you install the monitoring agent, use the following instructions to configure the CouchDB plugin on your instances.

Prerequisites

The CouchDB plugin requires version 5.5.0-315 or later of the monitoring agent. To update the agent, see Upgrading the agent.

Enabling the CouchDB monitoring plugin

On your VM instance, download couchdb.conf from the GitHub configuration repository and place it in the directory /opt/stackdriver/collectd/etc/collectd.d/:

(cd /opt/stackdriver/collectd/etc/collectd.d/ && curl -O https://raw.githubusercontent.com/Stackdriver/stackdriver-agent-service-configs/master/etc/collectd.d/couchdb.conf)

After adding the configuration file, restart the monitoring agent by running the following command:

sudo service stackdriver-agent restart

Information on other plugin configuration options can be found at collectd.org.

What is monitored

The CouchDB plugin monitors the following metrics:

  • Database Writes (count/s): Number of times a database was changed.
  • Database Reads (count/s): Number of times a document was read from a database.
  • Open Databases (count): Number of open databases.
  • Open OS Files (count): Number of file descriptors CouchDB has open.
  • Request Time (s): Length of a request inside CouchDB without MochiWeb.
  • Bulk Requests (count/s): Number of bulk requests.
  • Requests (count/s): Number of HTTP requests.
  • Temporary View Reads (count/s): Number of temporary view reads.
  • View Reads (count/s): Number of view reads.
  • COPY Request Methods (count/s): Number of HTTP COPY requests.
  • DELETE Request Methods (count/s): Number of HTTP DELETE requests.
  • GET Request Methods (count/s): Number of HTTP GET requests.
  • HEAD Request Methods (count/s): Number of HTTP HEAD requests.
  • MOVE Request Methods (count/s): Number of HTTP MOVE requests.
  • POST Request Methods (count/s): Number of HTTP POST requests.
  • PUT Request Methods (count/s): Number of HTTP PUT requests.
  • 200 Status Code (count/s): Number of HTTP 200 OK responses.
  • 201 Status Code (count/s): Number of HTTP 201 Created responses.
  • 202 Status Code (count/s): Number of HTTP 202 Accepted responses.
  • 301 Status Code (count/s): Number of HTTP 301 Moved Permanently responses.
  • 304 Status Code (count/s): Number of HTTP 304 Not Modified responses.
  • 400 Status Code (count/s): Number of HTTP 400 Bad Request responses.
  • 401 Status Code (count/s): Number of HTTP 401 Unauthorized responses.
  • 403 Status Code (count/s): Number of HTTP 403 Forbidden responses.
  • 404 Status Code (count/s): Number of HTTP 404 Not Found responses.
  • 405 Status Code (count/s): Number of HTTP 405 Method Not Allowed responses.
  • 409 Status Code (count/s): Number of HTTP 409 Conflict responses.
  • 412 Status Code (count/s): Number of HTTP 412 Precondition Failed responses.
  • 500 Status Code (count/s): Number of HTTP 500 Internal Server Error responses.

Send feedback about...

Stackdriver Monitoring