CouchDB monitoring

Deprecation notice

This extension documentation is now deprecated and will no longer be updated. We recommend using the new CouchDB extension for improved functionality and support.

CouchDB server monitoring in Dynatrace provides a cluster overview and all relevant nodes metrics.

If your CouchDB installation is underperforming or a problem occurs, Dynatrace lets you know immediately and shows you which nodes are affected. You can then drill down into the metrics of individual nodes to find the root causes of problems and potential bottlenecks.

Prerequisites

  • CouchDB user with access to /_stats resource
  • Linux or Windows OS
  • CouchDB 1.5.0+

Also, we recommend that you install OneAgent on all CouchDB nodes.

Enabling CouchDB monitoring globally

With CouchDB monitoring enabled globally, Dynatrace automatically collects CouchDB metrics whenever a new host running CouchDB is detected in your environment.

  1. Go to Settings.
  2. Select Monitoring > Monitored technologies.
  3. On the Supported technologies tab, find the CouchDB entry and select in the Edit column to expand the row.
  4. Set the User and Password. This user must have access to /_stats.
  5. Set the Port. The default port is 5984.
  6. Select Save.
  7. Turn on the Global monitoring switch for CouchDB.
    CouchDB monitoring is enabled globally.

Enabling CouchDB monitoring for individual hosts

Dynatrace provides the option of enabling CouchDB monitoring for specific hosts rather than globally.

  1. If CouchDB monitoring is currently switched on, switch it off: go to Settings > Monitoring > Monitored technologies and set the CouchDB switch to the Off position.
  2. Go to Hosts or Hosts Classic (latest Dynatrace).
  3. Find the host you want to configure. Use the filter at the top of the list to help you locate the host.
  4. Click the host to open the host page.
  5. Select More (…) > Settings to open the Host settings page.
  6. In the Monitored technologies list, find the CouchDB row and turn on the Monitoring switch. CouchDB monitoring is enabled for the selected host.

To view CouchDB monitoring insights

  1. Go to Technologies & Processes or Technologies & Processes Classic (latest Dynatrace).
  2. Select the Apache CouchDB tile.
  3. To view cluster metrics, locate the CouchDB process group in the Process group table at the bottom and select in the Details column to expand that row.
  4. Select Process group details in the expanded row to see details.
  5. On the Process group details page, select the Technology-specific metrics tab to view relevant cluster charts and metrics. Each metric is plotted against the number of process group instances.
  6. Select the Log files tab to list links to relevant log files in the Log viewer.

CouchDB node metrics

To display CouchDB node metrics:

  1. Select a node from the Process list on the Process group details page.
  2. Select the CouchDB metrics tab to see metric charts.
    • Requests let's you know how the node is performing.
      • An above-average Maximum request time may indicate that you have some slow requests.
      • An increased Average response time while the number of requests remains stable indicates a performance problem.
    • HTTP status codes charts aggregated HTTP status codes over time.
  3. Select the Further details tab to check HTTP status codes and metrics.
    • The CouchDB tab charts:
      • Database I/O
      • Open databases/files
    • The Httpd tabcharts:
      • Request methods
      • Requests by type
  4. To return to the cluster level, expand the Properties section of the CouchDB Process page and select the cluster.
  5. To see more CouchDB monitoring metrics, select the Further details tab on individual Process pages.

Metrics

Cluster metrics

On the Process group details page, select the Technology-specific metrics tab to view charts for these metrics. Each metric is plotted against the number of process group instances.

Metric
Description

Authentication cache hits

Number of authentication cache hits.

Authentication cache misses

Number of authentication cache misses.

Bulk requests

Number of bulk requests.

Database reads

Number of times a document was read from a database.

Database writes

Number of times a database was changed.

Open OS files

Number of file descriptors CouchDB has open.

Open databases

Number of open databases.

Request time

Requests

Overall number of HTTP requests.

Temporary view reads

Number of requests to the temporary view indexes.

View reads

Number of requests to the view indexes.

http 2xx

Aggregated number of HTTP 2xx responses.

http 3xx

Aggregated number of HTTP 3xx responses.

http 4xx

Aggregated number of HTTP 4xx responses.

http 5xx

Aggregated number of HTTP 5xx responses.

CouchDB metrics tab

On the Process group details page, click the CouchDB metrics tab to display charts of these key metrics.

Requests chart

Metric
Description

Average request time

Average request time.

Maximum request time

Maximum request time

Requests

Requests.

HTTP status codes chart

Metric
Description

2xx

Aggregated number of HTTP 2xx responses.

3xx

Aggregated number of HTTP 3xx responses.

4xx

Aggregated number of HTTP 4xx responses.

5xx

Aggregated number of HTTP 5xx responses.

Further details tab

Select the Further details tab to check HTTP status codes and metrics.

Database I/O chart

Metric
Description

Reads

Number of times a document was read from a database.

Writes

Number of times a database was changed.

Open databases/files chart

Metric
Description

Open databases

Number of open databases.

Open OS files

Number of file descriptors CouchDB has open.

Request methods chart

Metric
Description

Requests

Overall number of HTTP requests.

COPY

Number of HTTP COPY requests.

DELETE

Number of HTTP DELETE requests.

GET

Number of HTTP GET requests.

HEAD

Number of HTTP HEAD requests.

POST

Number of HTTP POST requests.

PUT

Number of HTTP PUT requests.

Requests by type chart

Metric
Description

Requests

Overall number of HTTP requests.

Related topics