CouchBase

Supported OS Linux Windows Mac OS

Integration version3.2.1

Couchbase Bytes Read

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 included in the Datadog Agent package, so you don’t need to install anything else on your Couchbase nodes.

Configuration

Host

To configure this check for an Agent running on a host:

Metric collection
  1. Edit the couchbase.d/conf.yaml file in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your Couchbase data. See the sample couchbase.d/conf.yaml for all available configuration options.

    init_config:
    
    instances:
      ## @param server - string - required
      ## The server's url.
      #
      - server: http://localhost:8091
    
  2. Restart the Agent.

Log collection

Available for Agent versions >6.0

  1. Collecting logs is disabled by default in the Datadog Agent, you need to enable it in datadog.yaml:

    logs_enabled: true
    
  2. Add this configuration block to your couchbase.d/conf.yaml file to start collecting your Couchbase Logs:

    logs:
      - type: file
        path: /opt/couchbase/var/lib/couchbase/logs/couchdb.log
        source: couchdb
    

    Change the path and service parameter values and configure them for your environment. See the sample couchbase.d/conf.yaml for all available configuration options.

  3. Restart the Agent.

Containerized

For containerized environments, see the Autodiscovery Integration Templates for guidance on applying the parameters below.

Metric collection
ParameterValue
<INTEGRATION_NAME>couchbase
<INIT_CONFIG>blank or {}
<INSTANCE_CONFIG>{"server": "http://%%host%%:8091"}

Validation

Run the Agent’s status subcommand and look for couchbase under the Checks section.

Data Collected

Metrics

couchbase.by_bucket.avg_bg_wait_time
(gauge)
Average background wait time
Shown as microsecond
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 microsecond
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
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)
Get operations performed on the bucket
Shown as get
couchbase.by_bucket.cmd_lookup
(gauge)
Lookup operations performed on the bucket
Shown as get
couchbase.by_bucket.cmd_set
(gauge)
Set operations performed on the bucket
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)
The current number of bucket connections
Shown as connection
couchbase.by_bucket.curr_items
(gauge)
Number of active items in memory
Shown as item
couchbase.by_bucket.curr_items_tot
(gauge)
Total number of items
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_2i_backoff
(gauge)
Number of backoffs for indexes DCP connections
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
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_fts_backoff
(gauge)
Number of backoffs for fts DCP connections
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
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_other_backoff
(gauge)
Number of backoffs for other DCP connections
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
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
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
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
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
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
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
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
(gauge)
Number of active items
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_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
(gauge)
Number of pending items
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_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
(gauge)
Number of replica vBuckets
Shown as item
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_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.cmd_get
(gauge)
Get operations performed on the node
Shown as get
couchbase.by_node.couch_docs_actual_disk_size
(gauge)
Couch docs total size on disk in bytes
Shown as byte
couchbase.by_node.couch_docs_data_size
(gauge)
Couch docs data size in bytes
Shown as byte
couchbase.by_node.couch_spatial_data_size
(gauge)
Size of object data for spatial views
Shown as byte
couchbase.by_node.couch_spatial_disk_size
(gauge)
Amount of disk space occupied by spatial views
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.couch_views_data_size
(gauge)
Couch views data size on disk in bytes
Shown as byte
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.ep_bg_fetched
(gauge)
Disk reads per second
Shown as fetch
couchbase.by_node.get_hits
(gauge)
Number of get hits
Shown as hit
couchbase.by_node.index_data_size
(gauge)
Index data size
Shown as byte
couchbase.by_node.index_disk_size
(gauge)
Index disk size
Shown as byte
couchbase.by_node.mem_used
(gauge)
Engine's total memory usage (deprecated)
Shown as byte
couchbase.by_node.ops
(gauge)
Total number of operations
Shown as operation
couchbase.by_node.vb_active_num_non_resident
(gauge)
Number of non resident vBuckets in the active state for this bucket
Shown as item
couchbase.by_node.vb_replica_curr_items
(gauge)
Number of in memory items
Shown as item
couchbase.hdd.free
(gauge)
Free hard disk space
Shown as byte
couchbase.hdd.quota_total
(gauge)
Hard disk quota
Shown as byte
couchbase.hdd.total
(gauge)
Total hard disk space
Shown as byte
couchbase.hdd.used
(gauge)
Used hard disk space
Shown as byte
couchbase.hdd.used_by_data
(gauge)
Hard disk used for data
Shown as byte
couchbase.index.avg_drain_rate
(gauge)
[Couchbase >= 7] The average number of items flushed from memory to disk storage per second
Shown as item
couchbase.index.avg_item_size
(gauge)
[Couchbase >= 7] The average size of the keys
Shown as byte
couchbase.index.avg_scan_latency
(gauge)
[Couchbase >= 7] The average time to serve a scan request
Shown as nanosecond
couchbase.index.cache_hit_percent
(gauge)
[Couchbase >= 7] The percentage of memory accesses that were served from the managed cache
Shown as percent
couchbase.index.cache_hits
(count)
[Couchbase >= 7] The number of accesses to this index data from RAM
couchbase.index.cache_misses
(count)
[Couchbase >= 7] The number of accesses to this index data from disk
couchbase.index.data_size
(gauge)
[Couchbase >= 7] The size of indexable data that is maintained for the index or partition
Shown as byte
couchbase.index.disk_size
(gauge)
[Couchbase >= 7] The total disk file size consumed by the index or partition
Shown as byte
couchbase.index.frag_percent
(gauge)
[Couchbase >= 7] The percentage fragmentation of the index
Shown as percent
couchbase.index.initial_build_progress
(gauge)
[Couchbase >= 7] The percentage of the initial build progress for the index. When the initial build is completed, the value is 100. For an index partition, the value is listed as 0
Shown as percent
couchbase.index.items_count
(count)
[Couchbase >= 7] The number of items currently indexed
Shown as item
couchbase.index.last_known_scan_time
(gauge)
[Couchbase >= 7] Timestamp of the last scan request received for this index (Unix timestamp in nanoseconds). This may be useful for determining whether this index is currently unused. Note: This statistic is persisted to disk every 15 minutes, so it is preserved when the indexer restarts
Shown as nanosecond
couchbase.index.memory_used
(gauge)
[Couchbase >= 7] The amount of memory used by the Index
Shown as byte
couchbase.index.num_docs_indexed
(count)
[Couchbase >= 7] The number of documents indexed by the indexer since last startup
Shown as document
couchbase.index.num_docs_pending
(gauge)
[Couchbase >= 7] The number of documents pending to be indexed
Shown as document
couchbase.index.num_docs_queued
(gauge)
[Couchbase >= 7] The number of documents queued to be indexed
Shown as document
couchbase.index.num_items_flushed
(count)
[Couchbase >= 7] The number of items flushed from memory to disk storage
Shown as item
couchbase.index.num_pending_requests
(gauge)
[Couchbase >= 7] The number of requests received but not yet served by the indexer
Shown as request
couchbase.index.num_requests
(count)
[Couchbase >= 7] The number of requests served by the indexer since last startup
Shown as request
couchbase.index.num_rows_returned
(count)
[Couchbase >= 7] The total number of rows returned so far by the indexer
Shown as row
couchbase.index.num_scan_errors
(count)
[Couchbase >= 7] The number of requests that failed due to errors other than timeout
Shown as request
couchbase.index.num_scan_timeouts
(count)
[Couchbase >= 7] The number of requests that timed out, either waiting for snapshots or during scan in progress
Shown as request
couchbase.index.recs_in_mem
(gauge)
[Couchbase >= 7] For standard index storage, this is the number of records in this index that are stored in memory. For memory-optimized index storage, this is the same as items_count
Shown as record
couchbase.index.recs_on_disk
(gauge)
[Couchbase >= 7] For standard index storage, this is the number of records in this index that are stored on disk. For memory-optimized index storage, this is 0
Shown as record
couchbase.index.resident_percent
(gauge)
[Couchbase >= 7] The percentage of data held in memory
Shown as percent
couchbase.index.scan_bytes_read
(count)
[Couchbase >= 7] The number of bytes read by a scan since last startup
Shown as byte
couchbase.index.total_scan_duration
(gauge)
[Couchbase >= 7] The total time spent by the indexer in scanning rows since last startup
Shown as nanosecond
couchbase.indexer.indexer_state
(gauge)
[Couchbase >= 7] The current state of the Index service on this node (0 = Active, 1 = Pause, 2 = Warmup)
couchbase.indexer.memory_quota
(gauge)
[Couchbase >= 7] The memory quota assigned to the Index service on this node by user configuration
Shown as byte
couchbase.indexer.memory_total_storage
(gauge)
[Couchbase >= 7] The total size allocated in the indexer across all indexes. This also accounts for memory fragmentation
Shown as byte
couchbase.indexer.memory_used
(gauge)
[Couchbase >= 7] The amount of memory used by the Index service on this node
Shown as byte
couchbase.indexer.total_indexer_gc_pause_ns
(gauge)
[Couchbase >= 7] The total time the indexer has spent in GC pause since the last startup
Shown as nanosecond
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)
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
couchbase.ram.quota_total
(gauge)
RAM quota
Shown as byte
couchbase.ram.quota_total_per_node
(gauge)
RAM quota
Shown as byte
couchbase.ram.quota_used
(gauge)
Used RAM quota
Shown as byte
couchbase.ram.quota_used_per_node
(gauge)
Used RAM quota
Shown as byte
couchbase.ram.total
(gauge)
Total RAM
Shown as byte
couchbase.ram.used
(gauge)
RAM in use
Shown as byte
couchbase.ram.used_by_data
(gauge)
RAM used for data
Shown as byte
couchbase.sync_gateway.admin_net_bytes_recv
(count)
The total number of bytes received (since node start-up) on the network interface to which the Sync Gateway admin interface is bound.
Shown as byte
couchbase.sync_gateway.admin_net_bytes_sent
(count)
The total number of bytes sent (since node start-up) on the network interface to which the Sync Gateway admin interface is bound.
Shown as byte
couchbase.sync_gateway.cache.abandoned_seqs
(count)
The total number of skipped sequences that were not found after 60 minutes and were abandoned.
couchbase.sync_gateway.cache.chan_cache_active_revs
(count)
The total number of active revisions in the channel cache.
couchbase.sync_gateway.cache.chan_cache_bypass_count
(count)
The total number of transient bypass channel caches created to serve requests when the channel cache was at capacity.
couchbase.sync_gateway.cache.chan_cache_channels_added
(count)
The total number of channel caches added.
couchbase.sync_gateway.cache.chan_cache_channels_evicted_inactive
(count)
The total number of channel cache channels evicted due to inactivity.
couchbase.sync_gateway.cache.chan_cache_channels_evicted_nru
(count)
The total number of active channel cache channels evicted, based on 'not recently used' criteria.
couchbase.sync_gateway.cache.chan_cache_compact_count
(count)
The total number of channel cache compaction runs.
couchbase.sync_gateway.cache.chan_cache_compact_time
(count)
The total amount of time taken by channel cache compaction across all compaction runs.
couchbase.sync_gateway.cache.chan_cache_hits
(count)
The total number of channel cache requests fully served by the cache.
Shown as hit
couchbase.sync_gateway.cache.chan_cache_max_entries
(count)
The total size of the largest channel cache.
Shown as entry
couchbase.sync_gateway.cache.chan_cache_misses
(count)
The total number of channel cache requests not fully served by the cache.
Shown as miss
couchbase.sync_gateway.cache.chan_cache_num_channels
(count)
The total number of channels being cached.
couchbase.sync_gateway.cache.chan_cache_pending_queries
(count)
The total number of channel cache pending queries.
couchbase.sync_gateway.cache.chan_cache_removal_revs
(count)
The total number of removal revisions in the channel cache.
couchbase.sync_gateway.cache.chan_cache_tombstone_revs
(count)
The total number of tombstone revisions in the channel cache.
couchbase.sync_gateway.cache.high_seq_cached
(gauge)
The highest sequence number cached.
couchbase.sync_gateway.cache.high_seq_stable
(gauge)
The highest contiguous sequence number that has been cached.
couchbase.sync_gateway.cache.num_active_channels
(count)
The total number of active channels.
couchbase.sync_gateway.cache.num_skipped_seqs
(count)
The total number of skipped sequences.
couchbase.sync_gateway.cache.pending_seq_len
(count)
The total number of pending sequences. These are out-of-sequence entries waiting to be cached.
couchbase.sync_gateway.cache.rev_cache_bypass
(count)
The total number of revision cache bypass operations performed.
couchbase.sync_gateway.cache.rev_cache_hits
(count)
The total number of revision cache hits.
Shown as hit
couchbase.sync_gateway.cache.rev_cache_misses
(count)
The total number of revision cache misses.
Shown as miss
couchbase.sync_gateway.cache.skipped_seq_len
(gauge)
The current length of the pending skipped sequence queue.
couchbase.sync_gateway.cbl_replication_pull.attachment_pull_bytes
(count)
The total size of attachments pulled. This is the pre-compressed size.
couchbase.sync_gateway.cbl_replication_pull.attachment_pull_count
(count)
The total number of attachments pulled.
couchbase.sync_gateway.cbl_replication_pull.max_pending
(gauge)
The high watermark for the number of documents buffered during feed processing, waiting on a missing earlier sequence.
Shown as document
couchbase.sync_gateway.cbl_replication_pull.num_pull_repl_active_continuous
(count)
The total number of continuous pull replications in the active state.
couchbase.sync_gateway.cbl_replication_pull.num_pull_repl_active_one_shot
(count)
The total number of one-shot pull replications in the active state.
couchbase.sync_gateway.cbl_replication_pull.num_pull_repl_caught_up
(count)
The number of replications which have caught up to the latest changes.
couchbase.sync_gateway.cbl_replication_pull.num_pull_repl_since_zero
(count)
The total number of new replications started (/_changes?since=0).
couchbase.sync_gateway.cbl_replication_pull.num_pull_repl_total_caught_up
(gauge)
The total number of replications which have caught up to the latest changes.
couchbase.sync_gateway.cbl_replication_pull.num_pull_repl_total_continuous
(count)
The total number of continuous pull replications.
couchbase.sync_gateway.cbl_replication_pull.num_pull_repl_total_one_shot
(count)
The total number of one-shot pull replications.
couchbase.sync_gateway.cbl_replication_pull.num_replications_active
(count)
The total number of active replications.
couchbase.sync_gateway.cbl_replication_pull.request_changes_count
(count)
The total number of changes requested.
couchbase.sync_gateway.cbl_replication_pull.request_changes_time
(count)
This metric can be used to calculate the latency of requested changes:
couchbase.sync_gateway.cbl_replication_pull.rev_processing_time
(count)
The total amount of time processing rev messages (revisions) during pull revision.
couchbase.sync_gateway.cbl_replication_pull.rev_send_count
(count)
The total number of rev messages processed during replication.
couchbase.sync_gateway.cbl_replication_pull.rev_send_latency
(count)
The total amount of time between Sync Gateway receiving a request for a revision and that revision being sent.
couchbase.sync_gateway.cbl_replication_push.attachment_push_bytes
(count)
The total number of attachment bytes pushed.
Shown as byte
couchbase.sync_gateway.cbl_replication_push.attachment_push_count
(count)
The total number of attachments pushed.
couchbase.sync_gateway.cbl_replication_push.doc_push_count
(count)
The total number of documents pushed.
Shown as document
couchbase.sync_gateway.cbl_replication_push.propose_change_count
(count)
The total number of changes and-or proposeChanges messages processed since node start-up.
Shown as message
couchbase.sync_gateway.cbl_replication_push.propose_change_time
(count)
The total time spent processing changes and/or proposeChanges messages.
couchbase.sync_gateway.cbl_replication_push.sync_function_count
(count)
The total number of times that the sync_function is evaluated.
couchbase.sync_gateway.cbl_replication_push.sync_function_time
(count)
The total time spent evaluating the sync_function.
couchbase.sync_gateway.cbl_replication_push.write_processing_time
(count)
Total time spent processing writes.
couchbase.sync_gateway.database.abandoned_seqs
(count)
The total number of skipped sequences abandoned.
couchbase.sync_gateway.database.cache_feed.dcp_backfill_completed
(count)
The total number of backfill items processed.
couchbase.sync_gateway.database.cache_feed.dcp_backfill_expected
(count)
The total expected number of sequences in backfill.
couchbase.sync_gateway.database.cache_feed.dcp_rollback_count
(count)
The total number of rollbacks that occur.
couchbase.sync_gateway.database.conflict_write_count
(count)
The total number of writes that left the document in a conflicted state. Includes new conflicts, and mutations that don't resolve existing conflicts.
couchbase.sync_gateway.database.crc32c_match_count
(count)
The total number of instances during import when the document cas had changed, but the document was not imported because the document body had not changed.
couchbase.sync_gateway.database.dcp_caching_count
(count)
The total number of DCP mutations added to Sync Gateway's channel cache.
couchbase.sync_gateway.database.dcp_caching_time
(count)
The total time between a DCP mutation arriving at Sync Gateway and being added to channel cache.
couchbase.sync_gateway.database.dcp_received_count
(count)
The total number of document mutations received by Sync Gateway over DCP.
couchbase.sync_gateway.database.dcp_received_time
(gauge)
The time between a document write and that document being received by Sync Gateway over DCP.
couchbase.sync_gateway.database.doc_reads_bytes_blip
(count)
The total number of bytes read via Couchbase Lite 2.x replication since Sync Gateway node startup.
couchbase.sync_gateway.database.doc_writes_bytes
(count)
The total number of bytes written as part of document writes since Sync Gateway node startup.
couchbase.sync_gateway.database.doc_writes_bytes_blip
(count)
The total number of bytes written as part ofCouchbase Lite 2.x document writes since Sync Gateway node startup.
couchbase.sync_gateway.database.doc_writes_xattr_bytes
(count)
The total size of xattrs written (in bytes).
Shown as byte
couchbase.sync_gateway.database.high_seq_feed
(gauge)
Highest sequence number seen on the caching DCP feed.
couchbase.sync_gateway.database.import_feed.dcp_backfill_completed
(count)
The total number of backfill items processed.
couchbase.sync_gateway.database.import_feed.dcp_backfill_expected
(count)
The total expected number of sequences in backfill.
couchbase.sync_gateway.database.import_feed.dcp_rollback_count
(count)
The total number of rollbacks that occur.
couchbase.sync_gateway.database.num_doc_reads_blip
(count)
The total number of documents read via Couchbase Lite 2.x replication since Sync Gateway node startup.
Shown as document
couchbase.sync_gateway.database.num_doc_reads_rest
(count)
The total number of documents read via the REST API since Sync Gateway node startup. Includes Couchbase Lite 1.x replication.
Shown as document
couchbase.sync_gateway.database.num_doc_writes
(count)
The total number of documents written by any means (replication, rest API interaction or imports) since Sync Gateway node startup.
Shown as document
couchbase.sync_gateway.database.num_replications_active
(count)
The total number of active replications.
couchbase.sync_gateway.database.num_replications_total
(count)
The total number of replications created since Sync Gateway node startup.
couchbase.sync_gateway.database.num_tombstones_compacted
(gauge)
The number of tombstones compacted.
couchbase.sync_gateway.database.sequence_assigned_count
(gauge)
The total number of sequence numbers assigned.
couchbase.sync_gateway.database.sequence_get_count
(gauge)
The total number of high sequence lookups.
couchbase.sync_gateway.database.sequence_incr_count
(count)
The total number of times the sequence counter document has been incremented.
couchbase.sync_gateway.database.sequence_released_count
(count)
The total number of unused, reserved sequences released by Sync Gateway.
couchbase.sync_gateway.database.sequence_reserved_count
(count)
The total number of sequences reserved by Sync Gateway.
couchbase.sync_gateway.database.warn_channels_per_doc_count
(count)
The total number of warnings relating to the channel count exceeding the channel count threshold.
couchbase.sync_gateway.database.warn_grants_per_doc_count
(count)
The total number of warnings relating to the grant count exceeding the grant count threshold.
couchbase.sync_gateway.database.warn_xattr_size_count
(count)
The total number of warnings relating to the xattr sync data being larger than a configured threshold.
couchbase.sync_gateway.error_count
(count)
The total number of errors logged.
Shown as error
couchbase.sync_gateway.go_memstats_heapalloc
(gauge)
The bytes of allocated heap objects.
Shown as byte
couchbase.sync_gateway.go_memstats_heapidle
(gauge)
The bytes in idle (unused) spans.
Shown as byte
couchbase.sync_gateway.go_memstats_heapinuse
(gauge)
The bytes in in-use spans.
Shown as byte
couchbase.sync_gateway.go_memstats_heapreleased
(gauge)
The bytes of physical memory returned to the OS.
Shown as byte
couchbase.sync_gateway.go_memstats_pausetotalns
(gauge)
The circular buffer of recent GC stop-the-world pause times.
Shown as nanosecond
couchbase.sync_gateway.go_memstats_stackinuse
(gauge)
The bytes in stack spans.
Shown as byte
couchbase.sync_gateway.go_memstats_stacksys
(gauge)
The bytes of stack memory obtained from the OS.
Shown as byte
couchbase.sync_gateway.go_memstats_sys
(gauge)
The bytes of memory obtained from the OS for mspan structures.
Shown as byte
couchbase.sync_gateway.goroutines_high_watermark
(gauge)
Peak number of go routines since process start.
couchbase.sync_gateway.num_goroutines
(count)
The total number of goroutines.
couchbase.sync_gateway.process_cpu_percent_utilization
(gauge)
The CPU's utilization as percentage value.
Shown as percent
couchbase.sync_gateway.process_memory_resident
(gauge)
The memory utilization (Resident Set Size) for the process.
Shown as byte
couchbase.sync_gateway.pub_net_bytes_recv
(count)
The memory utilization (Resident Set Size) for the process.
Shown as byte
couchbase.sync_gateway.pub_net_bytes_sent
(count)
The total number of bytes sent (since node start-up) on the network interface to which Sync Gateway public interface is bound.
Shown as byte
couchbase.sync_gateway.security.auth_failed_count
(count)
The total number of unsuccessful authentications.
couchbase.sync_gateway.security.auth_success_count
(count)
The total number of successful authentications.
Shown as success
couchbase.sync_gateway.security.num_access_errors
(count)
The total number of documents rejected by write access functions (requireAccess, requireRole, requireUser).
Shown as document
couchbase.sync_gateway.security.num_docs_rejected
(count)
The total number of documents rejected by the sync_function.
Shown as document
couchbase.sync_gateway.security.total_auth_time
(count)
The total time spent in authenticating all requests.
couchbase.sync_gateway.shared_bucket_import.import_cancel_cas
(count)
The total number of imports cancelled due to cas failure.
couchbase.sync_gateway.shared_bucket_import.import_count
(count)
The total number of docs imported.
Shown as document
couchbase.sync_gateway.shared_bucket_import.import_error_count
(count)
The total number of errors arising as a result of a document import.
Shown as error
couchbase.sync_gateway.shared_bucket_import.import_high_seq
(gauge)
The highest sequence number value imported.
couchbase.sync_gateway.shared_bucket_import.import_partitions
(count)
The total number of import partitions.
couchbase.sync_gateway.shared_bucket_import.import_processing_time
(count)
The total time taken to process a document import.
couchbase.sync_gateway.system_memory_total
(count)
The total memory available on the system in bytes.
Shown as byte
couchbase.sync_gateway.warn_count
(count)
The total number of warnings logged.
Shown as byte

Events

The Couchbase check emits an event to Datadog each time the cluster is rebalanced.

Service Checks

couchbase.can_connect
Returns status after pinging your Couchbase instance. Additional information about response status at the time of collection is included in the check message.
Statuses: ok, critical

couchbase.by_node.cluster_membership
Returns CRITICAL if the node is failed over. Returns WARNING if the node is added to the cluster but is waiting for a rebalance to activate. Returns OK otherwise.
Statuses: ok, warning, critical

couchbase.by_node.health
Returns CRITICAL if the node is unhealthy. Returns OK otherwise.
Statuses: ok, critical

couchbase.index_stats.can_connect
Returns OK if Index Statistics endpoint can be reached. Returns CRITICAL otherwise.
Statuses: ok, critical

Troubleshooting

Need help? Contact Datadog support.

Further Reading