Couchbase monitoring

Deprecation notice

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

Couchbase server monitoring in Dynatrace provides a high-level overview of all Couchbase components in your cluster.

Prerequisites

  • Linux OS or Windows

  • Couchbase version 4.3+

    For Couchbase version 7.0+, ensure access to the metrics endpoint at https://db..:18091/metrics for enhanced metrics collection.

Enabling Couchbase monitoring globally

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

  1. Go to Settings.
  2. Select Monitoring > Monitored technologies.
  3. On the Supported technologies tab, find the Couchbase entry and select in the Edit column to expand the row.
  4. Set the User and Password.
    The credentials have to work for all Couchbase hosts that you want to monitor. The provided user should have a minimum role of Read-Only Admin.
  5. Set the Port.
    The default port is 8091. For Couchbase version 7.0+, also configure access to the metrics endpoint on port 18091 for HTTPS if using TLS.
  6. Select Save.
  7. Turn on the Global monitoring switch for Couchbase.
    Couchbase monitoring is enabled globally.

Enabling Couchbase monitoring for individual hosts

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

  1. If global Couchbase monitoring is currently switched on, switch it off: go to Settings > Monitoring > Monitored technologies and set the Couchbase 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. Select 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 Couchbase row and turn on the Monitoring switch.
    Couchbase monitoring is enabled for the selected host.

Monitoring Couchbase clusters

  1. Go to Technologies & Processes or Technologies & Processes Classic (latest Dynatrace).
  2. Select the Couchbase tile.
  3. To view cluster metrics, expand the Details section of the Couchbase process group.
  4. Select Process group details.
  5. On the Process group details page, select the Technology-specific metrics tab to view relevant cluster charts and metrics.
    • Couchbase cluster (process group) overview pages provide an overview of Couchbase cluster health and performance.
    • This page is also helpful for identifying problematic nodes. Just select a relevant time interval for the timeline, select a node metric from the metric drop list, and compare the values of all nodes in the sortable table.
  6. Further down the page, you’ll find a number of other cluster-specific charts.

Couchbase cluster charts

Chart

Contents

Status

Number of nodes per status (healthy, unhealthy, warmup)

Out of memory

Number of OOM and temporary OOM per sec

Operations

Number of operations

Disk fetches

Disk fetches for memcached buckets

RAM overview

Overview of cluster memory

Disk overview

Overview of cluster disk usage

Swap usage

Cluster swap usage

Cache miss rate

Percent of requests not found in the cache

Number of ejected items

Number of times that item values were ejected from memory to disk

Current items

Number of documents stored on the cluster

Buckets

Numbers of buckets per type

Couchbase node monitoring

To access valuable Couchbase node metrics:

  1. On your Couchbase Process group details page, select a node from the Process list at the bottom of the page.
  2. Select the Couchbase metrics tab.
    Charts available on the node level include Node status, Operations, Disk fetches, RAM usage, Swap usage, and Current items.