Supported Versions
Enterprise version 4.5.0 or higher

Couchbase Server is an open-source, distributed multi-model NoSQL document-oriented database software package optimized for interactive applications.


  • Install gateway version 5.0.0 or later.
  • Database and port(8091) are reachable from the gateway.
  • Map a suitable gateway management profile to a resource.
  • Create credentials with type Database before assigning a template to a resource. The Port, Connection Time-out, and Is Secure values are not used to create credentials.

Discovery using the gateway

The administrator can deploy a gateway to support Couchbase agentless monitoring. The gateway establishes a connection to the database using the management profile, collects metrics from the templates, and starts monitoring.

To monitor Couchbase:

  • Associate appropriate database credentials to the discovered database.
  • Assign one or more database-specific global templates on the device.

Choose one of the following management mechanisms to discover Couchbase servers and add them to your inventory:

  • WMI

  • SSH

  • SNMP

  • (Optional) Manually add a database server to the infrastructure inventory:

    1. Select Infrastructure.
    2. Click the Settings icon.
    3. Select Resource > Add.
    4. In the Add Device window, enter the required Device Type and specify additional fields you want to include.
    5. Click Save.

View resource metrics

The gateway monitors the application using the assigned templates and displays the results in a graphical format. To view resource metrics, click the desired Database Resource Name > Resource Details > Metrics.


If the graphs are plotted incorrectly, verify that the resource is accessible and telnet connectivity:

ping <IPAddress>
telnet <IPAddress:Port>

Also, verify that you are using valid credentials for the resource.

Supported templates

  • Couchbase - Bucket
  • Couchbase - Cluster
  • Couchbase - Node
  • Couchbase - Query

After selecting the templates, you can:

  • Assign Couchbase templates from Setup or at the device level.
  • Customize default configuration parameter values while assigning the template.

Resource template configuration parameters

Configuration ParameterDescription
Connection Time-outMaximum database connect time. The driver waits for the specified time before timing out due to connection failure. The default time is 15000 milliseconds(ms).
Service Transport TypeThe secure database end-point. The default type is In-secure. The connection is Secure when the data sent between the client and server is encrypted.
Service PortThe port number where the database is running. The connection is made to the specified port if you specify the port and the database name. The default ports are8091 and 8093.
Application TypeThe application type value to identify the adapter. For example, COUCHBASE.

Do not change the default application type value.

Supported metrics

MetricMetric Display NameUnitDescription
couchbase.hdd.freeCouchbase Hdd FreebyteFree hard disk space
couchbase.hdd.usedCouchbase Hdd UsedbyteUsed hard disk space
couchbase.hdd.totalCouchbase Hdd TotalbyteTotal hard disk space
couchbase.hdd.quota_totalCouchbase Hdd Quota TotalbyteHard disk quota
couchbase.hdd.used_by_dataCouchbase Hdd Used By DatabyteHard disk used for data
couchbase.ram.usedCouchbase Ram UsedbyteRAM in use
couchbase.hdd.freeCouchbase Hdd FreebyteFree hard disk space
couchbase.ram.totalCouchbase Ram TotalbyteTotal RAM
couchbase.ram.quota_totalCouchbase Ram Quota TotalbyteRAM quota
couchbase.ram.used_by_dataCouchbase Ram Used By DatabyteRAM used for data
couchbase.by_bucket.avg_bg_wait_timeCouchbase By Bucket Avg Bg Wait TimesecondsAverage background wait time
couchbase.by_bucket.avg_disk_commit_timeCouchbase By Bucket Avg Disk Commit TimesecondsAverage disk commit time
couchbase.by_bucket.avg_disk_update_timeCouchbase By Bucket Avg Disk Update TimemicrosecondAverage disk update time
couchbase.by_bucket.bg_wait_totalCouchbase By Bucket Bg Wait TotalbyteBackground wait total
couchbase.by_bucket.bytes_readCouchbase By Bucket .bytes_readbyteBytes read
couchbase.by_bucket.bytes_writtenCouchbase By Bucket .bytes_writtenbyteBytes written
couchbase.by_bucket.cas_badvalCouchbase By Bucket Cas BadvalcountCompare and Swap bad values
couchbase.by_bucket.cas_hitsCouchbase By Bucket Cas HitshitCompare and Swap hits
couchbase.by_bucket.cas_missesCouchbase By Bucket Cas MissesmissCompare and Swap misses
couchbase.by_bucket.cmd_getCouchbase By Bucket Cmd GetgetCompare and Swap gets
couchbase.by_bucket.cmd_setCouchbase By Bucket Cmd SetsetCompare and swap sets
couchbase.by_bucket.couch_docs_actual_disk_sizeCouchbase By Bucket Couch Docs Actual Disk SizebyteCouch docs total size on disk in bytes