Stackstate-Couchbase Integration

Overview

Identify busy buckets, track cache miss ratios, and more. This Agent check collects metrics like:

  • Hard disk and memory used by data
  • Current connections
  • Total objects
  • Operations per second
  • Disk write queue size

And many more.

Setup

Installation

The Couchbase check is packaged with the Agent, so simply install the Agent.

Configuration

To capture Couchbase metrics you need to install the StackState Agent.

  1. Configure the Agent to connect to Couchbase, edit conf.d/couchbase.yaml

    init_config:
    
    instances:
        -   server: http://localhost:8091
            tags:
                -   foo
    

  2. Restart the Agent

Validation

Execute the info command and verify that the integration check has passed. The output of the command should contain a section similar to the following:

Checks
======

  [...]

  couchbase
  ---------
      - instance #0 [OK]
      - Collected 8 metrics & 0 events

Data Collected

Metrics

couchbase.hdd.free
(gauge)
Free hard disk space
shown as byte
couchbase.hdd.used
(gauge)
Used hard disk space
shown as byte
couchbase.hdd.total
(gauge)
Total hard disk space
shown as byte
couchbase.hdd.quota_total
(gauge)
Hard disk quota
shown as byte
couchbase.hdd.used_by_data
(gauge)
Hard disk used for data
shown as byte
couchbase.ram.used
(gauge)
RAM in use
shown as byte
couchbase.ram.total
(gauge)
Total RAM
shown as byte
couchbase.ram.quota_total
(gauge)
RAM quota
shown as byte
couchbase.ram.used_by_data
(gauge)
RAM used for data
shown as byte
couchbase.by_bucket.avg_bg_wait_time
(gauge)
Average background wait time
shown as second
couchbase.by_bucket.avg_disk_commit_time
(gauge)
Average disk commit time
shown as second
couchbase.by_bucket.avg_disk_update_time
(gauge)
Average disk update time
shown as microseconds
couchbase.by_bucket.bg_wait_total
(gauge)
Bytes read
shown as byte
couchbase.by_bucket.bytes_read
(gauge)
Bytes read
shown as byte
couchbase.by_bucket.bytes_written
(gauge)
Bytes written
shown as byte
couchbase.by_bucket.cas_badval
(gauge)
Compare and Swap bad values
shown as badval
couchbase.by_bucket.cas_hits
(gauge)
Compare and Swap hits
shown as hit
couchbase.by_bucket.cas_misses
(gauge)
Compare and Swap misses
shown as miss
couchbase.by_bucket.cmd_get
(gauge)
Compare and Swap gets
shown as get
couchbase.by_bucket.cmd_set
(gauge)
Compare and swap sets
shown as set
couchbase.by_bucket.couch_docs_actual_disk_size
(gauge)
Couch docs total size on disk in bytes
shown as byte
couchbase.by_bucket.couch_docs_data_size
(gauge)
Couch docs data size in bytes
shown as byte
couchbase.by_bucket.couch_docs_disk_size
(gauge)
Couch docs total size in bytes
shown as byte
couchbase.by_bucket.couch_docs_fragmentation
(gauge)
Couch docs fragmentation
shown as percent
couchbase.by_bucket.couch_spatial_data_size
(gauge)
Size of object data for spatial views
shown as byte
couchbase.by_bucket.couch_spatial_disk_size
(gauge)
Amount of disk space occupied by spatial views
shown as byte
couchbase.by_bucket.couch_spatial_ops
(gauge)
Spatial operations
shown as operation
couchbase.by_bucket.couch_total_disk_size
(gauge)
Couch total disk size
shown as byte
couchbase.by_bucket.couch_views_data_size
(gauge)
Size of object data for views
shown as byte
couchbase.by_bucket.couch_views_disk_size
(gauge)
Amount of disk space occupied by views
shown as byte
couchbase.by_bucket.couch_views_fragmentation
(gauge)
View fragmentation
shown as percent
couchbase.by_bucket.couch_views_ops
(gauge)
View operations
shown as operation
couchbase.by_bucket.cpu_idle_ms
(gauge)
CPU idle milliseconds
shown as millisecond
couchbase.by_bucket.cpu_utilization_rate
(gauge)
CPU utilization percentage
shown as percent
couchbase.by_bucket.curr_connections
(gauge)
Current bucket connections
shown as connection
couchbase.by_bucket.curr_items_tot
(gauge)
Total number of items
shown as item
couchbase.by_bucket.curr_items
(gauge)
Number of active items in memory
shown as item
couchbase.by_bucket.decr_hits
(gauge)
Decrement hits
shown as hit
couchbase.by_bucket.decr_misses
(gauge)
Decrement misses
shown as miss
couchbase.by_bucket.delete_hits
(gauge)
Delete hits
shown as hit
couchbase.by_bucket.delete_misses
(gauge)
Delete misses
shown as miss
couchbase.by_bucket.disk_commit_count
(gauge)
Disk commits
shown as operation
couchbase.by_bucket.disk_update_count
(gauge)
Disk updates
shown as operation
couchbase.by_bucket.disk_write_queue
(gauge)
Disk write queue depth
shown as operation
couchbase.by_bucket.ep_bg_fetched
(gauge)
Disk reads per second
shown as fetch
couchbase.by_bucket.ep_cache_miss_rate
(gauge)
Cache miss rate
shown as miss
couchbase.by_bucket.ep_cache_miss_ratio
(gauge)
Cache miss ratio
shown as percent
couchbase.by_bucket.ep_dcp_fts_backoff
(gauge)
Number of backoffs for fts DCP connections
shown as backoff
couchbase.by_bucket.ep_dcp_fts_count
(gauge)
Number of fts DCP connections
shown as connection
couchbase.by_bucket.ep_dcp_fts_items_remaining
(gauge)
Number of fts items remaining to be sent
shown as item
couchbase.by_bucket.ep_dcp_fts_items_sent
(gauge)
Number of fts items sent
shown as item
couchbase.by_bucket.ep_dcp_fts_producer_count
(gauge)
Number of fts producers
shown as producer
couchbase.by_bucket.ep_dcp_fts_total_bytes
(gauge)
Number bytes per second being sent for fts DCP connections
shown as byte
couchbase.by_bucket.ep_dcp_2i_backoff
(gauge)
Number of backoffs for indexes DCP connections
shown as backoff
couchbase.by_bucket.ep_dcp_2i_count
(gauge)
Number of indexes DCP connections
shown as connection
couchbase.by_bucket.ep_dcp_2i_items_remaining
(gauge)
Number of indexes items remaining to be sent
shown as item
couchbase.by_bucket.ep_dcp_2i_items_sent
(gauge)
Number of indexes items sent
shown as item
couchbase.by_bucket.ep_dcp_2i_producer_count
(gauge)
Number of indexes producers
shown as producer
couchbase.by_bucket.ep_dcp_2i_total_bytes
(gauge)
Number bytes per second being sent for indexes DCP connections
shown as byte
couchbase.by_bucket.ep_dcp_other_backoff
(gauge)
Number of backoffs for other DCP connections
shown as backoff
couchbase.by_bucket.ep_dcp_other_count
(gauge)
Number of other DCP connections
shown as connection
couchbase.by_bucket.ep_dcp_other_items_remaining
(gauge)
Number of other items remaining to be sent
shown as item
couchbase.by_bucket.ep_dcp_other_items_sent
(gauge)
Number of other items sent
shown as item
couchbase.by_bucket.ep_dcp_other_producer_count
(gauge)
Number of other producers
shown as producer
couchbase.by_bucket.ep_dcp_other_total_bytes
(gauge)
Number bytes per second being sent for other DCP connections
shown as byte
couchbase.by_bucket.ep_dcp_replica_backoff
(gauge)
Number of backoffs for replica DCP connections
shown as backoff
couchbase.by_bucket.ep_dcp_replica_count
(gauge)
Number of replica DCP connections
shown as connection
couchbase.by_bucket.ep_dcp_replica_items_remaining
(gauge)
Number of replica items remaining to be sent
shown as item
couchbase.by_bucket.ep_dcp_replica_items_sent
(gauge)
Number of replica items sent
shown as item
couchbase.by_bucket.ep_dcp_replica_producer_count
(gauge)
Number of replica producers
shown as producer
couchbase.by_bucket.ep_dcp_replica_total_bytes
(gauge)
Number bytes per second being sent for replica DCP connections
shown as byte
couchbase.by_bucket.ep_dcp_views_backoff
(gauge)
Number of backoffs for views DCP connections
shown as backoff
couchbase.by_bucket.ep_dcp_views_count
(gauge)
Number of views DCP connections
shown as connection
couchbase.by_bucket.ep_dcp_views_items_remaining
(gauge)
Number of views items remaining to be sent
shown as item
couchbase.by_bucket.ep_dcp_views_items_sent
(gauge)
Number of views items sent
shown as item
couchbase.by_bucket.ep_dcp_views_producer_count
(gauge)
Number of views producers
shown as producer
couchbase.by_bucket.ep_dcp_views_total_bytes
(gauge)
Number bytes per second being sent for views DCP connections
shown as byte
couchbase.by_bucket.ep_dcp_xdcr_backoff
(gauge)
Number of backoffs for xdcr DCP connections
shown as backoff
couchbase.by_bucket.ep_dcp_xdcr_count
(gauge)
Number of xdcr DCP connections
shown as connection
couchbase.by_bucket.ep_dcp_xdcr_items_remaining
(gauge)
Number of xdcr items remaining to be sent
shown as item
couchbase.by_bucket.ep_dcp_xdcr_items_sent
(gauge)
Number of xdcr items sent
shown as item
couchbase.by_bucket.ep_dcp_xdcr_producer_count
(gauge)
Number of xdcr producers
shown as producer
couchbase.by_bucket.ep_dcp_xdcr_total_bytes
(gauge)
Number bytes per second being sent for xdcr DCP connections
shown as byte
couchbase.by_bucket.ep_diskqueue_drain
(gauge)
Total Drained items on disk queue
shown as item
couchbase.by_bucket.ep_diskqueue_fill
(gauge)
Total enqueued items on disk queue
shown as item
couchbase.by_bucket.ep_diskqueue_items
(gauge)
Total number of items waiting to be written to disk
shown as item
couchbase.by_bucket.ep_flusher_todo
(gauge)
Number of items currently being written
shown as item
couchbase.by_bucket.ep_item_commit_failed
(gauge)
Number of times a transaction failed to commit due to storage errors
shown as error
couchbase.by_bucket.ep_kv_size
(gauge)
Total amount of user data cached in RAM in this bucket
shown as byte
couchbase.by_bucket.ep_max_size
(gauge)
The maximum amount of memory this bucket can use
shown as byte
couchbase.by_bucket.ep_mem_high_wat
(gauge)
Mem usage high water mark for auto-evictions
shown as byte
couchbase.by_bucket.ep_mem_low_wat
(gauge)
Mem usage low water mark for auto-evictions
shown as byte
couchbase.by_bucket.ep_meta_data_memory
(gauge)
Total amount of item metadata consuming RAM in this bucket
shown as byte
couchbase.by_bucket.ep_num_non_resident
(gauge)
Number of non-resident items
shown as item
couchbase.by_bucket.ep_num_ops_del_meta
(gauge)
Number of delete operations per second for this bucket as the target for XDCR
shown as operation
couchbase.by_bucket.ep_num_ops_del_ret_meta
(gauge)
Number of delRetMeta operations per second for this bucket as the target for XDCR
shown as operation
couchbase.by_bucket.ep_num_ops_get_meta
(gauge)
Number of read operations per second for this bucket as the target for XDCR
shown as operation
couchbase.by_bucket.ep_num_ops_set_meta
(gauge)
Number of set operations per second for this bucket as the target for XDCR
shown as operation
couchbase.by_bucket.ep_num_ops_set_ret_meta
(gauge)
Number of setRetMeta operations per second for this bucket as the target for XDCR
shown as operation
couchbase.by_bucket.ep_num_value_ejects
(gauge)
Number of times item values got ejected from memory to disk
shown as item
couchbase.by_bucket.ep_oom_errors
(gauge)
Number of times unrecoverable OOMs happened while processing operations
shown as error
couchbase.by_bucket.ep_ops_create
(gauge)
Create operations
shown as operation
couchbase.by_bucket.ep_ops_update
(gauge)
Update operations
shown as operation
couchbase.by_bucket.ep_overhead
(gauge)
Extra memory used by transient data like persistence queues or checkpoints
shown as byte
couchbase.by_bucket.ep_queue_size
(gauge)
Number of items queued for storage
shown as item
couchbase.by_bucket.ep_resident_items_rate
(gauge)
Number of resident items
shown as item
couchbase.by_bucket.ep_tap_replica_queue_drain
(gauge)
Total drained items in the replica queue
shown as item
couchbase.by_bucket.ep_tap_total_queue_drain
(gauge)
Total drained items in the queue
shown as item
couchbase.by_bucket.ep_tap_total_queue_fill
(gauge)
Total enqueued items in the queue
shown as item
couchbase.by_bucket.ep_tap_total_total_backlog_size
(gauge)
Number of remaining items for replication
shown as item
couchbase.by_bucket.ep_tmp_oom_errors
(gauge)
Number of times recoverable OOMs happened while processing operations
shown as error
couchbase.by_bucket.ep_vb_total
(gauge)
Total number of vBuckets for this bucket
shown as item
couchbase.by_bucket.evictions
(gauge)
Number of evictions
shown as eviction
couchbase.by_bucket.get_hits
(gauge)
Number of get hits
shown as hit
couchbase.by_bucket.get_misses
(gauge)
Number of get misses
shown as miss
couchbase.by_bucket.hibernated_requests
(gauge)
Number of streaming requests now idle
shown as request
couchbase.by_bucket.hibernated_waked
(gauge)
Rate of streaming request wakeups
shown as request
couchbase.by_bucket.hit_ratio
(gauge)
Hit ratio
shown as percent
couchbase.by_bucket.incr_hits
(gauge)
Number of increment hits
shown as hit
couchbase.by_bucket.incr_misses
(gauge)
Number of increment misses
shown as miss
couchbase.by_bucket.mem_actual_free
(gauge)
Free memory
shown as byte
couchbase.by_bucket.mem_actual_used
(gauge)
Used memory
shown as byte
couchbase.by_bucket.mem_free
(gauge)
Free memory
shown as byte
couchbase.by_bucket.mem_total
(gauge)
Total available memory
shown as byte
couchbase.by_bucket.mem_used
(gauge)
Engine's total memory usage (deprecated)
shown as byte
couchbase.by_bucket.mem_used_sys
(gauge)
System memory usage
shown as byte
couchbase.by_bucket.misses
(gauge)
Total number of misses
shown as miss
couchbase.by_bucket.ops
(gauge)
Total number of operations
shown as operation
couchbase.by_bucket.page_faults
(gauge)
Number of page faults
shown as page
couchbase.by_bucket.replication_docs_rep_queue
(gauge)

shown as item
couchbase.by_bucket.replication_meta_latency_aggr
(gauge)

shown as second
couchbase.by_bucket.rest_requests
(gauge)
Number of HTTP requests
shown as request
couchbase.by_bucket.swap_total
(gauge)
Total amount of swap available
shown as byte
couchbase.by_bucket.swap_used
(gauge)
Amount of swap used
shown as byte
couchbase.by_bucket.vb_active_eject
(gauge)
Number of items per second being ejected to disk from active vBuckets
shown as item
couchbase.by_bucket.vb_active_itm_memory
(gauge)
Amount of active user data cached in RAM in this bucket
shown as item
couchbase.by_bucket.vb_active_meta_data_memory
(gauge)
Amount of active item metadata consuming RAM in this bucket
shown as item
couchbase.by_bucket.vb_active_num_non_resident
(gauge)
Number of non resident vBuckets in the active state for this bucket
shown as item
couchbase.by_bucket.vb_active_num
(gauge)
Number of active items
shown as item
couchbase.by_bucket.vb_active_ops_create
(gauge)
New items per second being inserted into active vBuckets in this bucket
shown as item
couchbase.by_bucket.vb_active_ops_update
(gauge)
Number of items updated on active vBucket per second for this bucket
shown as item
couchbase.by_bucket.vb_active_queue_age
(gauge)
Sum of disk queue item age in milliseconds
shown as millisecond
couchbase.by_bucket.vb_active_queue_drain
(gauge)
Total drained items in the queue
shown as item
couchbase.by_bucket.vb_active_queue_fill
(gauge)
Number of active items per second being put on the active item disk queue
shown as item
couchbase.by_bucket.vb_active_queue_size
(gauge)
Number of active items in the queue
shown as item
couchbase.by_bucket.vb_active_resident_items_ratio
(gauge)
Number of resident items
shown as item
couchbase.by_bucket.vb_avg_active_queue_age
(gauge)
Average age in seconds of active items in the active item queue
shown as second
couchbase.by_bucket.vb_avg_pending_queue_age
(gauge)
Average age in seconds of pending items in the pending item queue
shown as second
couchbase.by_bucket.vb_avg_replica_queue_age
(gauge)
Average age in seconds of replica items in the replica item queue
shown as second
couchbase.by_bucket.vb_avg_total_queue_age
(gauge)
Average age of items in the queue
shown as second
couchbase.by_bucket.vb_pending_curr_items
(gauge)
Number of items in pending vBuckets
shown as item
couchbase.by_bucket.vb_pending_eject
(gauge)
Number of items per second being ejected to disk from pending vBuckets
shown as item
couchbase.by_bucket.vb_pending_itm_memory
(gauge)
Amount of pending user data cached in RAM in this bucket
shown as item
couchbase.by_bucket.vb_pending_meta_data_memory
(gauge)
Amount of pending item metadata consuming RAM in this bucket
shown as item
couchbase.by_bucket.vb_pending_num_non_resident
(gauge)
Number of non resident vBuckets in the pending state for this bucket
shown as item
couchbase.by_bucket.vb_pending_num
(gauge)
Number of pending items
shown as item
couchbase.by_bucket.vb_pending_ops_create
(gauge)
Number of pending create operations
shown as operation
couchbase.by_bucket.vb_pending_ops_update
(gauge)
Number of items updated on pending vBucket per second for this bucket
shown as item
couchbase.by_bucket.vb_pending_queue_age
(gauge)
Sum of disk pending queue item age in milliseconds
shown as millisecond
couchbase.by_bucket.vb_pending_queue_drain
(gauge)
Total drained pending items in the queue
shown as item
couchbase.by_bucket.vb_pending_queue_fill
(gauge)
Total enqueued pending items on disk queue
shown as item
couchbase.by_bucket.vb_pending_queue_size
(gauge)
Number of pending items in the queue
shown as item
couchbase.by_bucket.vb_pending_resident_items_ratio
(gauge)
Number of resident pending items
shown as item
couchbase.by_bucket.vb_replica_curr_items
(gauge)
Number of in memory items
shown as item
couchbase.by_bucket.vb_replica_eject
(gauge)
Number of items per second being ejected to disk from replica vBuckets
shown as item
couchbase.by_bucket.vb_replica_itm_memory
(gauge)
Amount of replica user data cached in RAM in this bucket
shown as item
couchbase.by_bucket.vb_replica_meta_data_memory
(gauge)
Total metadata memory
shown as byte
couchbase.by_bucket.vb_replica_num_non_resident
(gauge)
Number of non resident vBuckets in the replica state for this bucket
shown as item
couchbase.by_bucket.vb_replica_num
(gauge)
Number of replica vBuckets
shown as item
couchbase.by_bucket.vb_replica_ops_create
(gauge)
Number of replica create operations
shown as operation
couchbase.by_bucket.vb_replica_ops_update
(gauge)
Number of items updated on replica vBucket per second for this bucket
shown as item
couchbase.by_bucket.vb_replica_queue_age
(gauge)
Sum of disk replica queue item age in milliseconds
shown as millisecond
couchbase.by_bucket.vb_replica_queue_drain
(gauge)
Total drained replica items in the queue
shown as item
couchbase.by_bucket.vb_replica_queue_fill
(gauge)
Total enqueued replica items on disk queue
shown as item
couchbase.by_bucket.vb_replica_queue_size
(gauge)
Replica items in disk queue
shown as item
couchbase.by_bucket.vb_replica_resident_items_ratio
(gauge)
Number of resident replica items
shown as item
couchbase.by_bucket.vb_total_queue_age
(gauge)
Sum of disk queue item age in milliseconds
shown as second
couchbase.by_bucket.xdc_ops
(gauge)
Number of cross-datacenter replication operations
shown as operation
couchbase.by_node.curr_items
(gauge)
Number of active items in memory
shown as item
couchbase.by_node.curr_items_tot
(gauge)
Total number of items
shown as item
couchbase.by_node.couch_docs_data_size
(gauge)
Couch docs data size in bytes
shown as byte
couchbase.by_node.couch_docs_actual_disk_size
(gauge)
Couch docs total size on disk in bytes
shown as byte
couchbase.by_node.couch_views_data_size
(gauge)
Couch views data size on disk in bytes
shown as byte
couchbase.by_node.couch_views_actual_disk_size
(gauge)
Couch views total size on disk in bytes
shown as byte
couchbase.by_node.vb_replica_curr_items
(gauge)
Number of in memory items
shown as item
couchbase.query.cores
(gauge)

shown as core
couchbase.query.cpu_sys_percent
(gauge)

shown as percent
couchbase.query.cpu_user_percent
(gauge)

shown as percent
couchbase.query.gc_num
(gauge)

shown as
couchbase.query.gc_pause_percent
(gauge)

shown as percent
couchbase.query.gc_pause_time
(gauge)

shown as second
couchbase.query.memory_system
(gauge)

shown as byte
couchbase.query.memory_total
(gauge)

shown as byte
couchbase.query.memory_usage
(gauge)

shown as byte
couchbase.query.request_active_count
(gauge)

shown as request
couchbase.query.request_completed_count
(gauge)

shown as request
couchbase.query.request_per_sec_15min
(gauge)

shown as request
couchbase.query.request_per_sec_1min
(gauge)

shown as request
couchbase.query.request_per_sec_5min
(gauge)

shown as request
couchbase.query.request_prepared_percent
(gauge)

shown as request
couchbase.query.request_time_80percentile
(gauge)

shown as second
couchbase.query.request_time_95percentile
(gauge)

shown as second
couchbase.query.request_time_99percentile
(gauge)

shown as second
couchbase.query.request_time_mean
(gauge)

shown as second
couchbase.query.request_time_median
(gauge)

shown as second
couchbase.query.total_threads
(gauge)

shown as thread

Service Checks

couchbase.can_connect:

Returns Critical if the Agent cannot connect to Couchbase to collect metrics.