CouchDB plugin


This plugin

 collects information that is returned by the stats API.

Prerequisites

Meter 4.2 or later must be installed.

The Couch DB plugin supports the following Operating Systems.

Linux

✅️

Windows

✅️

Smart OS

✅️

OS X

✅️

To install the plugin

  1. From the top right of the screen, perform one of the following actions:
    • Click Settings > Data Collection, select the TrueSight meter, and select the Sources tab.
    • Click Settings > Configure Sources.
  2. Use the search box or scroll through the page to find the source system which has the TrueSight meter on which you want to install the plugin.
  3. Click the name of the source to view source details.
  4. Select the Plugins tab.
  5. Use the search box or scroll through the page to find the plugin you want to install.
  6. Click + Install to start the installation.

    Refer to the following sections for the configuration details required to collect data and view the list of plugin metrics.

Configuration details

Field Name

Description

CouchDB Stats URL

The URL to CouchDB's stats API endpoint

User

Password for the stats API endpoint.

Password

Password for the stats API endpoint.

PollInterval

Interval to query couchdb

Source

The source to display in the legend for the instance.

Advanced configuration

To customize this plugin, see Couch DB plugin on GitHub.

Metric details

Metric Name

Description

CouchDB - HTTPD 201

Number of HTTP 201 Created responses

CouchDB - HTTPD 200

Number of HTTP 200 OK responses

CouchDB - HTTPD 202

Number of HTTP 202 Accepted responses

CouchDB - HTTPD 401

Number of HTTP 401 Unauthorized responses

CouchDB - HTTPD 301

Number of HTTP 301 Moved Permanently responses

CouchDB - HTTPD 304

Number of HTTP 304 Not Modified responses

CouchDB - HTTPD 405

Number of HTTP 405 Method Not Allowed responses

CouchDB - HTTPD 404

Number of HTTP 404 Not Found responses

CouchDB - HTTPD 403

Number of HTTP 403 Forbidden responses

CouchDB - HTTPD 500

Number of HTTP 500 Internal Server Error responses

CouchDB - HTTPD 412

Number of HTTP 412 Precondition Failed responses

CouchDB - HTTPD 400

Number of HTTP 400 Bad Request responses

CouchDB - HTTPD 409

Number of HTTP 409 Conflict responses

CouchDB - Bulk Requests

Number of bulk requests

CouchDB - Clients Requesting Changes

Number of clients for continuous changes

CouchDB - View Reads

Number of view reads

CouchDB - Requests

Number of HTTP requests

CouchDB - Temporary View Reads

Number of temporary view reads

CouchDB - Open OS Files

Number of file descriptors CouchDB has open

CouchDB - Auth Cache Hits

Number of authentication cache hits

CouchDB - Database Reads

Number of times a document was read from a database

CouchDB - Open Databases

Number of open databases

CouchDB - Auth Cache Misses

Number of authentication cache misses

CouchDB - Database Writes

Number of times a database was changed

CouchDB - Request Time

Length of a request inside CouchDB without MochiWeb

CouchDB - HEAD Requests

Number of HTTP HEAD requests

CouchDB - GET Requests

Number of HTTP GET requests

CouchDB - PUT Requests

Number of HTTP PUT requests

CouchDB - POST Requests

Number of HTTP POST requests

CouchDB - COPY Requests

Number of HTTP COPY requests

CouchDB - DELETE Requests

Number of HTTP DELETE requests

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*