Couchbase

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
    • Cach 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 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: https://developer.couchbase.com/documentation/server/5.1/security/security-authorization.html

Supported Versions

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