Boundary CouchDB Plugin

The Boundary Riak plugin collects information on CouchDB.

The plugin requires the CouchDB stats API to be accessible from the machine running the relay.

The plugin requires Python 2.6 or later.

Metrics

The information collected is what is returned by the stats API.

Adding the CouchDB Plugin to Premium Boundary

1. Login into Boundary Premium
2. Display the settings dialog by clicking on the settings icon:
3. Click on the Plugins in the settings dialog.
4. Locate the couchdb plugin item and click on the Install button.
5. A confirmation dialog is displayed indicating the plugin was installed successfully, along with the metrics and the dashboards.
6. Click on the OK button to dismiss the dialog.

Removing the CouchDB Plugin from Premium Boundary

1. Login into Boundary Premium
2. Display the settings dialog by clicking on the settings icon:
3. Click on the Plugins in the settings dialog which lists the installed plugins.
4. Locate the couchdb plugin and click on the item, which then displays the uninstall dialog.
5. Click on the Uninstall button which displays a confirmation dialog along with the details on what metrics and dashboards will be removed.
6. Click on the Uninstall button to perfom the actual uninstall and then click on the Close button to dismiss the dialog.

Configuration

Once the CouchDB plugin is installed, metric collection requires that a relay is installed on the target system. Instructions on how to install a relay for Linux/Unix can found here, and for Windows here.

Before the plugin will collect metrics, you must provide it with the URL used to access the CouchDB stats endpoint. By default, this is "http://127.0.0.1:5984/_stats", but it could be different if you have configured a different port.

General operations for plugins are described in this article.