Monitoring Couchbase

The Couchbase sensor is automatically deployed and installed after you install the Instana agent.

Support information

To make sure that the Couchbase sensor is compatible with your current setup, check the following support information sections:

Supported versions and support policy

The sensor supports Couchbase Server Community Edition and Enterprise Edition 4.0.

The following table shows the latest supported version and support policy:

Table 1. Latest supported version and support policy
Technology Support policy Latest version Latest supported version
Couchbase On demand 7.6 4.0

For more information about the support policy, see Support strategy for sensors.

Supported client-side tracing

For this technology, Instana supports client-side tracing for the following languages and runtimes:

Sensor (Data Collection)

Node-Level

Tracked Configuration

  • Hostname
  • Version
  • Status
  • Buckets

Metrics

  • Used resources
    • Used memory
    • Used disk
  • Disk drain
    • Items in disk write queue
    • Items put to disk queue per sec
    • Items written to disk per sec
  • Statistics per bucket
    • Items
    • Throughput
    • Operations per sec
    • Gets per sec
    • Sets per sec
    • Used resources
    • Used memory
    • Used disk
    • Cache
    • Active items resident in cache
    • Cach miss
    • Disk reads per sec
    • Active items ejected per sec
    • Fragmentation
    • Docs fragmentation

Cluster-level

Tracked Configuration

  • Name
  • Nodes
  • Buckets

Metrics

  • Used resources
    • Used memory
    • Used disk
  • Items
  • Throughput
    • Operations per sec
    • Gets per sec
    • Sets per sec
  • Statistics per bucket
    • Items
    • Throughput
    • Operations per sec
    • Gets per sec
    • Sets per sec
    • Used resources
    • Used memory
    • Used disk
    • Cache
    • Active items resident in cache
    • Cache miss
    • Disk reads per sec
    • Active items ejected per sec
    • Fragmentation
    • Docs fragmentation

Configuration

In order to enable in depth metric monitoring, you need to inform the Agent about the credentials to access monitoring information. You can configure it in the agent <agent_install_dir>/etc/instana/configuration.yaml:

com.instana.plugin.couchbase:
  user: ''
  password: ''

Required DB Permissions

For the sensor to be able to collect performance information about the DBMS, the user configured should have at least one of the following roles: Full Administrator, Read-only Administrator, Cluster Administrator. You can find more information on the roles and access control here.