CouchDB Databases Test

Apache CouchDB is an open-source document-oriented NoSQL database. Unlike a relational database, a CouchDB database does not store data and relationships in tables. Instead, each database is a collection of independent documents.

Storage space contentions on a database can result in the loss of critical data. To avoid this, administrators should keep a close watch on the space usage of the database, proactively detect a space crunch, and promptly resolve it. This is where the CouchDB Databases test helps. This test monitors the space usage of the database and alerts are promptly sent out if the database is running out of space.

Target of the test : Apache CouchDB Server

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for each database in the target Apache CouchDB Server.

Configurable parameters for the test
Parameter Description

Test period

How often should the test be executed.


The IP address of the target server that is being monitored.


The port number through which the Couchdb server communicates. The default port is 5984.


In order to monitor an Apache CouchDB server, a special database user account with Admin privilege has to be created in every Apache CouchDB server instance that requires monitoring. In the Username text box, specify the Username for monitoring the target Apache CouchDB server instance.To create a new user, refer Pre-requisites for Monitoring Apache CouchDB topic.


Specify the password of the specified Username.

Confirm Password

Confirm the password by retyping it here.

Measurements made by the test
Measurement Description Measurement Unit Interpretation

Database usage percentage

Indicates the percentage of this database used on the disk.


High percentage indicates that the database installed on disk has reached its maximum usage, so we have to increase the size of the disk.

Disk used

Indicates the space used by this database on disk.


A very low value is required for this measure.

Disk free

Indicates the space unused by this database on disk.


A very high value is required for this measure.

Free space percentage

Indicates the percentage of space on disk that is unused by this database.


A value close to 100% indicates that the database is about to run out of free space on disk. Without enough space, the database will not be able to hold new records. To avoid this, its best that you remove stale data from the database, thus making room for new data.

Database size

Indicates the size of this database on disk.



Growth rate

Indicates the rate at which the size of this database is growing during last measurement period.



Is compact running?

Indicates the compaction status during last measurement period.


The values reported by this measure and its numeric equivalents are mentioned in the table below:

Measure Value

Numeric Value
Normal 1
Low load 2
Near overload 3
Overload 4


By default, this measure reports the Measure Values listed in the table above to indicate the compaction status during last measure period.

The compaction operation is a way to reduce disk space usage by removing unused and old data from database or view index files similar to SQLite Vacuum. It can be triggered manually or automatically.