You are here
Apache CouchDB Monitoring
[BETA] CouchDB Opspack
Please note that this Opspack has been made available as early release beta software and is not officially supported for production use. Beta releases are provided on an “as is” and “as available” basis. Opsview does not give any warranties, whether express or implied, as to the suitability or usability of these releases.
Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang. It uses JSON to store data, JavaScript as its query language using MapReduce, and HTTP for its API.
What You Can Monitor
This Opspack allows you to monitor response times for some basic top level CouchDB API endpoints, including checking authentication and database existence.
Service Checks
| Service Check | Description |
|---|---|
| Database - CouchDB - Server | The size and time taken to query the CouchDB HTTP API's root endpoint |
| Database - CouchDB - Auth | The size and time taken to authenticate against CouchDB and list its databases |
| Database - CouchDB - Database | The size and time taken to check a given database exists in CouchDB's list |
Prerequisites
- CouchDB 3.2, other versions may be compatible but are not officially supported.
Setup and Configuration
To configure and utilize this Opspack, you simply need to add the 'Database - CouchDB' Opspack to your Opsview Monitor system.
Step 1: Add the host template
Add the Database - CouchDB Host Template to your Opsview Monitor host.
For more information, refer to Opsview Knowledge Center - Adding Host Templates to Hosts.
Step 2: Add and configure variables required for this host
| Variable | Description |
|---|---|
| COUCHDB_CREDENTIALS | The authentication details for your CouchDB database. The Value is not used and therefore can be set to anything. Ensure you override the User, Password, Client Certificate Path, and Client Private Key Path with your configuration details. |
| COUCHDB_DATABASE | The Value is the name of the CouchDB database you want to monitor. You can add multiple variables to check the status of each database individually. |
| COUCHDB_SETTINGS | Any additional options to pass to the plugin. The Value is not used and therefore can be set to anything. The SSL Flag can be set to --ssl=1.2+ to require TLS 1.2 or higher and Port can be used to override the default CouchDB host port. |
For more information, refer to Opsview Knowledge Center - Adding Variables to Hosts.
Step 3: Apply changes and the system will now be monitored
