Docs » Integrations Guide » Use the Smart Agent » Monitors » collectd/couchbase

collectd/couchbase 🔗

Monitor Type: collectd/couchbase (Source)

Accepts Endpoints: Yes

Multiple Instances Allowed: Yes

Overview 🔗

This is a Smart Agent monitor for Couchbase that uses the couchbase collectd Python plugin to collect metrics from Couchbase server instances.

For general reference on how to monitor Couchbase, see Couchbase Monitoring and Monitor using the REST API.

Note on bucket metrics 🔗

This plugin emits some metrics about the bucket’s performance across the cluster, and some metrics about the bucket’s performance per node.

Metrics beginning with gauge.bucket.basic.* and gauge.bucket.quota.* are reported once per cluster. All other bucket metrics (gauge.bucket.*) are reported by every node that hosts that bucket. In order to analyze bucket performance for the entire bucket, apply functions like Sum or Mean to group node-level metrics together by bucket.

Example Config 🔗

Sample YAML configuration with custom query:

monitors:
- type: collectd/couchbase
  host: 127.0.0.1
  port: 8091
  collectTarget: "NODE"
  clusterName: "my-cluster"
  username: "user"
  password: "password"

Configuration 🔗

To activate this monitor in the Smart Agent, add the following to your agent config:

monitors:  # All monitor config goes under this key
 - type: collectd/couchbase
   ...  # Additional config

For a list of monitor options that are common to all monitors, see Common Configuration.

Config option Required Type Description
pythonBinary no string Path to a python binary that should be used to execute the Python code. If not set, a built-in runtime will be used. Can include arguments to the binary as well.
host yes string
port yes integer
collectTarget yes string Define what this Module block will monitor: "NODE", for a Couchbase node, or "BUCKET" for a Couchbase bucket.
collectBucket no string If CollectTarget is "BUCKET", CollectBucket specifies the name of the bucket that this will monitor.
clusterName no string Name of this Couchbase cluster. (default:"default")
collectMode no string Change to "detailed" to collect all available metrics from Couchbase stats API. Defaults to "default", collecting a curated set that works well with SignalFx.
username no string Username to authenticate with
password no string Password to authenticate with

Metrics 🔗

These are the metrics available for this monitor. Metrics that are categorized as container/host (default) are in bold and italics in the list below.

Group bucket 🔗

All of the following metrics are part of the bucket metric group. All of the non-default metrics below can be turned on by adding bucket to the monitor config option extraGroups:

  • gauge.bucket.basic.dataUsed (gauge)
    Size of user data within buckets of the specified state that are resident in RAM (%)
  • gauge.bucket.basic.diskFetches (gauge)
    Number of disk fetches
  • gauge.bucket.basic.diskUsed (gauge)
    Amount of disk used (bytes)
  • gauge.bucket.basic.itemCount (gauge)
    Number of items associated with the bucket
  • gauge.bucket.basic.memUsed (gauge)
    Amount of memory used by the bucket (bytes)
  • gauge.bucket.basic.opsPerSec (gauge)
    Number of operations per second
  • gauge.bucket.basic.quotaPercentUsed (gauge)
    Percentage of RAM used (for active objects) against the configure bucket size (%)
  • gauge.bucket.hot_keys.0 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.1 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.10 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.2 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.3 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.4 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.5 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.6 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.7 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.8 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.hot_keys.9 (gauge)
    One of the most used keys in this bucket
  • gauge.bucket.op.avg_bg_wait_time (gauge)
    Average background wait time
  • gauge.bucket.op.avg_disk_commit_time (gauge)
    Average disk commit time
  • gauge.bucket.op.avg_disk_update_time (gauge)
    Average disk update time
  • gauge.bucket.op.bg_wait_count (gauge)
  • gauge.bucket.op.bg_wait_total (gauge)
    The total background wait time
  • gauge.bucket.op.bytes_read (gauge)
    Number of bytes read
  • gauge.bucket.op.bytes_written (gauge)
    Number of bytes written
  • gauge.bucket.op.cas_badval (gauge)
    Number of CAS operations per second using an incorrect CAS ID for data that this bucket contains
  • gauge.bucket.op.cas_hits (gauge)
    Number of CAS operations per second for data that this bucket contains
  • gauge.bucket.op.cas_misses (gauge)
    Number of CAS operations per second for data that this bucket does not contain
  • gauge.bucket.op.cmd_get (gauge)
    requested objects
  • gauge.bucket.op.cmd_set (gauge)
    Number of writes (set operations) per second to this bucket
  • gauge.bucket.op.couch_docs_actual_disk_size (gauge)
    The size of the couchbase docs on disk
  • gauge.bucket.op.couch_docs_data_size (gauge)
    The size of active data in this bucket
  • gauge.bucket.op.couch_docs_disk_size (gauge)
    Couch docs total size in bytes
  • gauge.bucket.op.couch_docs_fragmentation (gauge)
    Percent fragmentation of documents in this bucket
  • gauge.bucket.op.couch_spatial_data_size (gauge)
    The size of object data for spatial views
  • gauge.bucket.op.couch_spatial_disk_size (gauge)
    The amount of disk space occupied by spatial views
  • gauge.bucket.op.couch_spatial_ops (gauge)
    Number of spatial operations
  • gauge.bucket.op.couch_total_disk_size (gauge)
    The total size on disk of all data and view files for this bucket
  • gauge.bucket.op.couch_views_actual_disk_size (gauge)
    The size of all active items in all the indexes for this bucket on disk
  • gauge.bucket.op.couch_views_data_size (gauge)
    The size of object data for views
  • gauge.bucket.op.couch_views_disk_size (gauge)
    The amount of disk space occupied by views
  • gauge.bucket.op.couch_views_fragmentation (gauge)
    How much fragmented data there is to be compacted compared to real data for the view index files in this bucket
  • gauge.bucket.op.couch_views_ops (gauge)
    view operations per second
  • gauge.bucket.op.cpu_idle_ms (gauge)
    CPU Idle milliseconds
  • gauge.bucket.op.cpu_utilization_rate (gauge)
    Percentage of CPU in use across all available cores on this server
  • gauge.bucket.op.curr_connections (gauge)
    open connection per bucket
  • gauge.bucket.op.curr_items (gauge)
    total number of stored items per bucket
  • gauge.bucket.op.curr_items_tot (gauge)
    Total number of items
  • gauge.bucket.op.decr_hits (gauge)
    Number of decrement hits
  • gauge.bucket.op.decr_misses (gauge)
    Number of decrement misses
  • gauge.bucket.op.delete_hits (gauge)
    Number of delete hits
  • gauge.bucket.op.delete_misses (gauge)
    Number of delete misses
  • gauge.bucket.op.disk_commit_count (gauge)
    Number of disk commits
  • gauge.bucket.op.disk_commit_total (gauge)
    Total number of disk commits
  • gauge.bucket.op.disk_update_count (gauge)
    Number of disk updates
  • gauge.bucket.op.disk_update_total (gauge)
    Total number of disk updates
  • gauge.bucket.op.disk_write_queue (gauge)
    number of items waiting to be written to disk
  • gauge.bucket.op.ep_bg_fetched (gauge)
    number of items fetched from disk
  • gauge.bucket.op.ep_cache_miss_rate (gauge)
    ratio of requested objects found in cache vs retrieved from disk
  • gauge.bucket.op.ep_dcp_2i_backoff (gauge)
    Number of backoffs for indexes DCP connections
  • gauge.bucket.op.ep_dcp_2i_count (gauge)
    Number of indexes DCP connections
  • gauge.bucket.op.ep_dcp_2i_items_remaining (gauge)
    Number of indexes items remaining to be sent
  • gauge.bucket.op.ep_dcp_2i_items_sent (gauge)
    Number of indexes items sent
  • gauge.bucket.op.ep_dcp_2i_producer_count (gauge)
    Number of indexes producers
  • gauge.bucket.op.ep_dcp_2i_total_backlog_size (gauge)
    Number of items in dcp backlog
  • gauge.bucket.op.ep_dcp_2i_total_bytes (gauge)
    Number bytes per second being sent for indexes DCP connections
  • gauge.bucket.op.ep_dcp_other_backoff (gauge)
    Number of backoffs for other DCP connections
  • gauge.bucket.op.ep_dcp_other_count (gauge)
    Number of other DCP connections
  • gauge.bucket.op.ep_dcp_other_items_remaining (gauge)
    Number of other items remaining to be sent
  • gauge.bucket.op.ep_dcp_other_items_sent (gauge)
    Number of other items sent
  • gauge.bucket.op.ep_dcp_other_producer_count (gauge)
    Number of other producers
  • gauge.bucket.op.ep_dcp_other_total_backlog_size (gauge)
    Number of remaining items for replication
  • gauge.bucket.op.ep_dcp_other_total_bytes (gauge)
    Number bytes per second being sent for other DCP connections
  • gauge.bucket.op.ep_dcp_replica_backoff (gauge)
    Number of backoffs for replica DCP connections
  • gauge.bucket.op.ep_dcp_replica_count (gauge)
    Number of replica DCP connections
  • gauge.bucket.op.ep_dcp_replica_items_remaining (gauge)
    Number of replica items remaining to be sent
  • gauge.bucket.op.ep_dcp_replica_items_sent (gauge)
    Number of replica items sent
  • gauge.bucket.op.ep_dcp_replica_producer_count (gauge)
    Number of replica producers
  • gauge.bucket.op.ep_dcp_replica_total_backlog_size (gauge)
    Number of remaining items for replication
  • gauge.bucket.op.ep_dcp_replica_total_bytes (gauge)
    Number bytes per second being sent for replica DCP connections
  • gauge.bucket.op.ep_dcp_views_backoff (gauge)
    Number of backoffs for views DCP connections
  • gauge.bucket.op.ep_dcp_views_count (gauge)
    Number of views DCP connections
  • gauge.bucket.op.ep_dcp_views_items_remaining (gauge)
    Number of views items remaining to be sent
  • gauge.bucket.op.ep_dcp_views_items_sent (gauge)
    Number of view items sent
  • gauge.bucket.op.ep_dcp_views_producer_count (gauge)
    Number of views producers
  • gauge.bucket.op.ep_dcp_views_total_bytes (gauge)
    Number bytes per second being sent for views DCP connections
  • gauge.bucket.op.ep_dcp_xdcr_backoff (gauge)
    Number of backoffs for xdcr DCP connections
  • gauge.bucket.op.ep_dcp_xdcr_count (gauge)
    Number of xdcr DCP connections
  • gauge.bucket.op.ep_dcp_xdcr_items_remaining (gauge)
    Number of xdcr items remaining to be sent
  • gauge.bucket.op.ep_dcp_xdcr_items_sent (gauge)
    Number of xdcr items sent
  • gauge.bucket.op.ep_dcp_xdcr_producer_count (gauge)
    Number of xdcr producers
  • gauge.bucket.op.ep_dcp_xdcr_total_backlog_size (gauge)
    Number of items waiting replication
  • gauge.bucket.op.ep_dcp_xdcr_total_bytes (gauge)
    Number bytes per second being sent for xdcr DCP connections
  • gauge.bucket.op.ep_diskqueue_drain (gauge)
    items removed from disk queue
  • gauge.bucket.op.ep_diskqueue_fill (gauge)
    enqueued items on disk queue
  • gauge.bucket.op.ep_diskqueue_items (gauge)
    The number of items waiting to be written to disk for this bucket for this state
  • gauge.bucket.op.ep_flusher_todo (gauge)
    Number of items currently being written
  • gauge.bucket.op.ep_item_commit_failed (gauge)
    Number of times a transaction failed to commit due to storage errors
  • gauge.bucket.op.ep_kv_size (gauge)
    Total amount of user data cached in RAM in this bucket
  • gauge.bucket.op.ep_max_size (gauge)
    The maximum amount of memory this bucket can use
  • gauge.bucket.op.ep_mem_high_wat (gauge)
    memory high water mark - point at which active objects begin to be ejected from bucket
  • gauge.bucket.op.ep_mem_low_wat (gauge)
    memory low water mark
  • gauge.bucket.op.ep_meta_data_memory (gauge)
    Total amount of item metadata consuming RAM in this bucket
  • gauge.bucket.op.ep_num_non_resident (gauge)
    Number of non-resident items
  • gauge.bucket.op.ep_num_ops_del_meta (gauge)
    Number of delete operations per second for this bucket as the target for XDCR
  • gauge.bucket.op.ep_num_ops_del_ret_meta (gauge)
    Number of delRetMeta operations per second for this bucket as the target for XDCR
  • gauge.bucket.op.ep_num_ops_get_meta (gauge)
    Number of read operations per second for this bucket as the target for XDCR
  • gauge.bucket.op.ep_num_ops_set_meta (gauge)
    Number of set operations per second for this bucket as the target for XDCR
  • gauge.bucket.op.ep_num_ops_set_ret_meta (gauge)
    Number of setRetMeta operations per second for this bucket as the target for XDCR
  • gauge.bucket.op.ep_num_value_ejects (gauge)
    number of objects ejected out of the bucket
  • gauge.bucket.op.ep_oom_errors (gauge)
    request rejected - bucket is at quota, panic
  • gauge.bucket.op.ep_ops_create (gauge)
    Total number of new items being inserted into this bucket
  • gauge.bucket.op.ep_ops_update (gauge)
    Number of update operations
  • gauge.bucket.op.ep_overhead (gauge)
    Extra memory used by transient data like persistence queues or checkpoints
  • gauge.bucket.op.ep_queue_size (gauge)
    number of items queued for storage
  • gauge.bucket.op.ep_resident_items_rate (gauge)
    Number of resident items
  • gauge.bucket.op.ep_tap_rebalance_count (gauge)
    Number of internal rebalancing TAP queues in this bucket
  • gauge.bucket.op.ep_tap_rebalance_qlen (gauge)
    Number of items in the rebalance TAP queues in this bucket
  • gauge.bucket.op.ep_tap_rebalance_queue_backfillremaining (gauge)
    Number of items in the backfill queues of rebalancing TAP connections to this bucket
  • gauge.bucket.op.ep_tap_rebalance_queue_backoff (gauge)
    Number of back-offs received per second while sending data over rebalancing TAP connections to this bucket
  • gauge.bucket.op.ep_tap_rebalance_queue_drain (gauge)
    Number of items per second being sent over rebalancing TAP connections to this bucket, i.e. removed from queue.
  • gauge.bucket.op.ep_tap_rebalance_queue_itemondisk (gauge)
    Number of items still on disk to be loaded for rebalancing TAP connections to this bucket
  • gauge.bucket.op.ep_tap_rebalance_total_backlog_size (gauge)
    Number of items remaining for replication
  • gauge.bucket.op.ep_tap_replica_count (gauge)
    Number of internal replication TAP queues in this bucket
  • gauge.bucket.op.ep_tap_replica_qlen (gauge)
    Number of items in the replication TAP queues in this bucket
  • gauge.bucket.op.ep_tap_replica_queue_backoff (gauge)
    Number of back-offs received per second while sending data over replication TAP connections to this bucket
  • gauge.bucket.op.ep_tap_replica_queue_drain (gauge)
    Number of items per second being sent over replication TAP connections to this bucket, i.e. removed from queue
  • gauge.bucket.op.ep_tap_replica_queue_itemondisk (gauge)
    Number of items still on disk to be loaded for replication TAP connections to this bucket
  • gauge.bucket.op.ep_tap_replica_total_backlog_size (gauge)
    Number of remaining items for replication
  • gauge.bucket.op.ep_tap_total_count (gauge)
    Total number of internal TAP queues in this bucket
  • gauge.bucket.op.ep_tap_total_qlen (gauge)
    Total number of items in TAP queues in this bucket
  • gauge.bucket.op.ep_tap_total_queue_backfillremaining (gauge)
    Total number of items in the backfill queues of TAP connections to this bucket
  • gauge.bucket.op.ep_tap_total_queue_backoff (gauge)
    Total number of back-offs received per second while sending data over TAP connections to this bucket
  • gauge.bucket.op.ep_tap_total_queue_drain (gauge)
    Total number of items per second being sent over TAP connections to this bucket
  • gauge.bucket.op.ep_tap_total_queue_fill (gauge)
    Total enqueued items in the queue.
  • gauge.bucket.op.ep_tap_total_queue_itemondisk (gauge)
    The number of items waiting to be written to disk for this bucket for this state.
  • gauge.bucket.op.ep_tap_total_total_backlog_size (gauge)
    Number of remaining items for replication
  • gauge.bucket.op.ep_tap_user_count (gauge)
    Number of internal user TAP queues in this bucket
  • gauge.bucket.op.ep_tap_user_qlen (gauge)
    Number of items in user TAP queues in this bucket
  • gauge.bucket.op.ep_tap_user_queue_backfillremaining (gauge)
    Number of items in the backfill queues of user TAP connections to this bucket.
  • gauge.bucket.op.ep_tap_user_queue_backoff (gauge)
    Number of back-offs received per second while sending data over user TAP connections to this bucket
  • gauge.bucket.op.ep_tap_user_queue_drain (gauge)
    Number of items per second being sent over user TAP connections to this bucket, i.e. removed from queue
  • gauge.bucket.op.ep_tap_user_queue_fill (gauge)
    Number of items per second being put on the user TAP queues
  • gauge.bucket.op.ep_tap_user_queue_itemondisk (gauge)
    Number of items still on disk to be loaded for client TAP connections to this bucket
  • gauge.bucket.op.ep_tap_user_total_backlog_size (gauge)
    Number of remaining items for replication
  • gauge.bucket.op.ep_tmp_oom_errors (gauge)
    request rejected - couchbase is making room by ejecting objects, try again later
  • gauge.bucket.op.ep_vb_total (gauge)
    Total number of vBuckets for this bucket
  • gauge.bucket.op.evictions (gauge)
    Number of evictions
  • gauge.bucket.op.get_hits (gauge)
    Number of get hits
  • gauge.bucket.op.get_misses (gauge)
    Number of get misses
  • gauge.bucket.op.hibernated_requests (gauge)
    Number of streaming requests now idle
  • gauge.bucket.op.hibernated_waked (gauge)
    Rate of streaming request wakeups
  • gauge.bucket.op.hit_ratio (gauge)
    Hit ratio.
  • gauge.bucket.op.incr_hits (gauge)
    Number of increment hits
  • gauge.bucket.op.incr_misses (gauge)
    Number of increment misses
  • gauge.bucket.op.mem_actual_free (gauge)
    Amount of RAM available
  • gauge.bucket.op.mem_actual_used (gauge)
    Used memory
  • gauge.bucket.op.mem_free (gauge)
    Free memory
  • gauge.bucket.op.mem_total (gauge)
    Total available memory
  • gauge.bucket.op.mem_used (gauge)
    memory used
  • gauge.bucket.op.mem_used_sys (gauge)
    System memory usage
  • gauge.bucket.op.misses (gauge)
    Total number of misses
  • gauge.bucket.op.ops (gauge)
    total of gets, sets, increment and decrement
  • gauge.bucket.op.rest_requests (gauge)
    Number of HTTP requests
  • gauge.bucket.op.swap_total (gauge)
    Total amount of swap available
  • gauge.bucket.op.swap_used (gauge)
    Amount of swap used
  • gauge.bucket.op.vb_active_eject (gauge)
    Number of items per second being ejected to disk from active vBuckets
  • gauge.bucket.op.vb_active_itm_memory (gauge)
    Amount of active user data cached in RAM in this bucket
  • gauge.bucket.op.vb_active_meta_data_memory (gauge)
    Amount of active item metadata consuming RAM in this bucket
  • gauge.bucket.op.vb_active_num (gauge)
    Number of vBuckets in the active state for this bucket
  • gauge.bucket.op.vb_active_num_non_resident (gauge)
    Number of non resident vBuckets in the active state for this bucket
  • gauge.bucket.op.vb_active_ops_create (gauge)
    New items per second being inserted into active vBuckets in this bucket
  • gauge.bucket.op.vb_active_ops_update (gauge)
    Number of items updated on active vBucket per second for this bucket
  • gauge.bucket.op.vb_active_queue_age (gauge)
    Sum of disk queue item age in milliseconds
  • gauge.bucket.op.vb_active_queue_drain (gauge)
    Number of active items per second being written to disk in this bucket
  • gauge.bucket.op.vb_active_queue_fill (gauge)
    Number of active items per second being put on the active item disk queue in this bucket
  • gauge.bucket.op.vb_active_queue_size (gauge)
    Number of active items waiting to be written to disk in this bucket
  • gauge.bucket.op.vb_active_resident_items_ratio (gauge)
    ratio of items kept in memory vs stored on disk
  • gauge.bucket.op.vb_avg_active_queue_age (gauge)
    Average age in seconds of active items in the active item queue for this bucket
  • gauge.bucket.op.vb_avg_pending_queue_age (gauge)
    Average age in seconds of pending items in the pending item queue for this bucket and should be transient during rebalancing
  • gauge.bucket.op.vb_avg_replica_queue_age (gauge)
    Average age in seconds of replica items in the replica item queue for this bucket
  • gauge.bucket.op.vb_avg_total_queue_age (gauge)
    Average age of items in the queue
  • gauge.bucket.op.vb_pending_curr_items (gauge)
    Number of items in pending vBuckets in this bucket and should be transient during rebalancing
  • gauge.bucket.op.vb_pending_eject (gauge)
    Number of items per second being ejected to disk from pending vBuckets
  • gauge.bucket.op.vb_pending_itm_memory (gauge)
    Amount of pending user data cached in RAM in this bucket and should be transient during rebalancing
  • gauge.bucket.op.vb_pending_meta_data_memory (gauge)
    Amount of pending item metadata consuming RAM in this bucket and should be transient during rebalancing
  • gauge.bucket.op.vb_pending_num (gauge)
    Number of pending items
  • gauge.bucket.op.vb_pending_num_non_resident (gauge)
    Number of non resident vBuckets in the pending state for this bucket
  • gauge.bucket.op.vb_pending_ops_create (gauge)
    New items per second being instead into pending vBuckets in this bucket and should be transient during rebalancing
  • gauge.bucket.op.vb_pending_ops_update (gauge)
    Number of items updated on pending vBucket per second for this bucket
  • gauge.bucket.op.vb_pending_queue_age (gauge)
    Sum of disk pending queue item age in milliseconds
  • gauge.bucket.op.vb_pending_queue_drain (gauge)
    Number of pending items per second being written to disk in this bucket and should be transient during rebalancing
  • gauge.bucket.op.vb_pending_queue_fill (gauge)
    Total enqueued pending items on disk queue
  • gauge.bucket.op.vb_pending_queue_size (gauge)
    Number of pending items waiting to be written to disk in this bucket and should be transient during rebalancing
  • gauge.bucket.op.vb_pending_resident_items_ratio (gauge)
    Number of resident pending items
  • gauge.bucket.op.vb_replica_curr_items (gauge)
    Number of in memory items
  • gauge.bucket.op.vb_replica_eject (gauge)
    Number of items per second being ejected to disk from replica vBuckets
  • gauge.bucket.op.vb_replica_itm_memory (gauge)
    Amount of replica user data cached in RAM in this bucket
  • gauge.bucket.op.vb_replica_meta_data_memory (gauge)
    Amount of replica item metadata consuming in RAM in this bucket
  • gauge.bucket.op.vb_replica_num (gauge)
    Number of replica vBuckets
  • gauge.bucket.op.vb_replica_num_non_resident (gauge)
    Number of non resident vBuckets in the replica state for this bucket
  • gauge.bucket.op.vb_replica_ops_create (gauge)
    Number of replica create operations
  • gauge.bucket.op.vb_replica_ops_update (gauge)
    Number of items updated on replica vBucket per second for this bucket
  • gauge.bucket.op.vb_replica_queue_age (gauge)
    Sum of disk replica queue item age in milliseconds
  • gauge.bucket.op.vb_replica_queue_drain (gauge)
    Total drained replica items in the queue
  • gauge.bucket.op.vb_replica_queue_fill (gauge)
    Number of replica items per second being put on the replica item disk queue in this bucket
  • gauge.bucket.op.vb_replica_queue_size (gauge)
    Number of replica items in disk queue
  • gauge.bucket.op.vb_replica_resident_items_ratio (gauge)
    Percentage of replica items cached in RAM in this bucket.
  • gauge.bucket.op.vb_total_queue_age (gauge)
    Sum of disk queue item age in milliseconds
  • gauge.bucket.op.xdc_ops (gauge)
    Cross datacenter replication operations per second for this bucket
  • gauge.bucket.quota.ram (gauge)
    Amount of RAM used by the bucket (bytes)
  • gauge.bucket.quota.rawRAM (gauge)
    Amount of raw RAM used by the bucket (bytes)

Group nodes 🔗

All of the following metrics are part of the nodes metric group. All of the non-default metrics below can be turned on by adding nodes to the monitor config option extraGroups:

  • gauge.nodes.cmd_get (gauge)
    Number of get commands
  • gauge.nodes.couch_docs_actual_disk_size (gauge)
    Amount of disk space used by Couch docs (bytes)
  • gauge.nodes.couch_docs_data_size (gauge)
    Data size of couch documents associated with a node (bytes)
  • gauge.nodes.couch_spatial_data_size (gauge)
    Size of object data for spatial views (bytes)
  • gauge.nodes.couch_spatial_disk_size (gauge)
    Amount of disk space occupied by spatial views, in bytes
  • gauge.nodes.couch_views_actual_disk_size (gauge)
    Amount of disk space occupied by Couch views (bytes)
  • gauge.nodes.couch_views_data_size (gauge)
    Size of object data for Couch views (bytes)
  • gauge.nodes.curr_items (gauge)
    Number of current items
  • gauge.nodes.curr_items_tot (gauge)
    Total number of items associated with node
  • gauge.nodes.ep_bg_fetched (gauge)
    Number of disk fetches performed since server was started
  • gauge.nodes.get_hits (gauge)
    Number of get hits
  • gauge.nodes.mcdMemoryAllocated (gauge)
    Amount of memcached memory allocated (bytes)
  • gauge.nodes.mcdMemoryReserved (gauge)
    Amount of memcached memory reserved (bytes)
  • gauge.nodes.mem_used (gauge)
    Memory used by the node (bytes)
  • gauge.nodes.memoryFree (gauge)
    Amount of memory free for the node (bytes)
  • gauge.nodes.memoryTotal (gauge)
    Total memory available to the node (bytes)
  • gauge.nodes.ops (gauge)
    Number of operations performed on Couchbase
  • gauge.nodes.system.cpu_utilization_rate (gauge)
    The CPU utilization rate (%)
  • gauge.nodes.system.mem_free (gauge)
    Free memory available to the node (bytes)
  • gauge.nodes.system.mem_total (gauge)
    Total memory available to the node (bytes)
  • gauge.nodes.system.swap_total (gauge)
    Total swap size allocated (bytes)
  • gauge.nodes.system.swap_used (gauge)
    Amount of swap space used (bytes)
  • gauge.nodes.vb_replica_curr_items (gauge)
    Number of items/documents that are replicas

Group storage 🔗

All of the following metrics are part of the storage metric group. All of the non-default metrics below can be turned on by adding storage to the monitor config option extraGroups:

  • gauge.storage.hdd.free (gauge)
    Free harddrive space in the cluster (bytes)
  • gauge.storage.hdd.quotaTotal (gauge)
    Harddrive quota total for the cluster (bytes)
  • gauge.storage.hdd.total (gauge)
    Total harddrive space available to cluster (bytes)
  • gauge.storage.hdd.used (gauge)
    Harddrive space used by the cluster (bytes)
  • gauge.storage.hdd.usedByData (gauge)
    Harddrive use by the data in the cluster(bytes)
  • gauge.storage.ram.quotaTotal (gauge)
    Ram quota total for the cluster (bytes)
  • gauge.storage.ram.quotaTotalPerNode (gauge)
    Ram quota total per node (bytes)
  • gauge.storage.ram.quotaUsed (gauge)
    Ram quota used by the cluster (bytes)
  • gauge.storage.ram.quotaUsedPerNode (gauge)
    Ram quota used per node (bytes)
  • gauge.storage.ram.total (gauge)
    Total ram available to cluster (bytes)
  • gauge.storage.ram.used (gauge)
    RAM used by the cluster (bytes)
  • gauge.storage.ram.usedByData (gauge)
    Ram used by the data in the cluster (bytes)

Non-default metrics (version 4.7.0+) 🔗

To emit metrics that are not default, you can add those metrics in the generic monitor-level extraMetrics config option. Metrics that are derived from specific configuration options that do not appear in the above list of metrics do not need to be added to extraMetrics.

To see a list of metrics that will be emitted you can run agent-status monitors after configuring this monitor in a running agent instance.