CouchDB Design Document Cache Test

CouchDB supports special documents within databases known as “design documents”. These documents are mostly driven by JavaScript, used to build indexes, validate document updates, format query results and filter replications.

This test reveals whether/not the cache for the Design Document has been effectively utilized and helps assess the impact of this cache usage on the target server. From the metrics reported by this test, administrators can also figure out if the document cache needs any further fine-tuning.

Target of the test : Apache CouchDB Server

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for 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

Cache hit rate

Indicates the rate of document cache hits during last measurement period.


A high value is desired for this measure.

Cache miss rate

Indicates the rate of document cache misses during last measurement period.


A high value for this measure indicates that the cache needs to be allocated with additional resources.

Cache recoveries

Indicates the number of document cache recoveries during last measurement period.