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, Cloud Monitoring discovers CouchDB services running in your Google Cloud 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, Monitoring populates the CouchDB Services page with inventory and metrics.
Configuring 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
Monitoring supports monitoring CouchDB version 1.x. CouchDB version 2.x is not currently supported.
On your VM instance, download couchdb.conf
from the GitHub configuration repository
and place it in the directory /etc/stackdriver/collectd.d/:
(cd /etc/stackdriver/collectd.d/ && sudo 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
For more information on the collectd curl_json plugin used to monitor
CouchDB, see Plugin:cURL-JSON.
What is monitored
The full list of metrics the CouchDB plugin monitors is at Agent metrics: couchdb.