Skip to content

Infrastructure Integration

Configuration

  1. Configure the agent by editing /etc/nutanix/epoch-dd-agent/conf.d/couchbase.yamlin the collectors.

Example: 

    init_config:
    instances:
      - server: http://localhost:8091
        user: Administrator
        password: password
        # query_monitoring_url: http://localhost:8093 # Url to get query monitoring stats, available since couchbase 4.5. See https://developer.couchbase.com/documentation/server/4.5/tools/query-monitoring.html
        # timeout: 10 # Optional timeout to http connections to the API
        # tags:
        #   - optional_tag1
        #   - optional_tag2

  1. Check and make sure that all yaml files are valid with following command: 

    /etc/init.d/epoch-collectors configcheck

  2. Restart the Agent using the following command: 

    /etc/init.d/epoch-collectors restart

  3. Execute the info command to verify that the integration check has passed: 

    /etc/init.d/epoch-collectors info

The output of the info command should contain a section similar to the following:

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

Infrastructure Datasources

Datasource Available Aggregations Unit Description
couchbase.hdd.free avg max min sum byte Free hard disk space
couchbase.hdd.used avg max min sum byte Used hard disk space
couchbase.hdd.total avg max min sum byte Total hard disk space
couchbase.hdd.quota_total avg max min sum byte Hard disk quota
couchbase.hdd.used_by_data avg max min sum byte Hard disk used for data
couchbase.ram.used avg max min sum byte RAM in use
couchbase.ram.total avg max min sum byte Total RAM
couchbase.ram.quota_total avg max min sum byte RAM quota
couchbase.ram.used_by_data avg max min sum byte RAM used for data
couchbase.by_bucket.avg_bg_wait_time avg max min sum second Average background wait time
couchbase.by_bucket.avg_disk_commit_time avg max min sum second Average disk commit time
couchbase.by_bucket.avg_disk_update_time avg max min sum microseconds Average disk update time
couchbase.by_bucket.bg_wait_total avg max min sum byte Bytes read
couchbase.by_bucket.bytes_read avg max min sum byte Bytes read
couchbase.by_bucket.bytes_written avg max min sum byte Bytes written
couchbase.by_bucket.cas_badval avg max min sum badval Compare and Swap bad values
couchbase.by_bucket.cas_hits avg max min sum hit Compare and Swap hits
couchbase.by_bucket.cas_misses avg max min sum miss Compare and Swap misses
couchbase.by_bucket.cmd_get avg max min sum get Compare and Swap gets
couchbase.by_bucket.cmd_set avg max min sum set Compare and swap sets
couchbase.by_bucket.couch_docs_actual_disk_size avg max min sum byte Couch docs total size on disk in bytes
couchbase.by_bucket.couch_docs_data_size avg max min sum byte Couch docs data size in bytes
couchbase.by_bucket.couch_docs_disk_size avg max min sum byte Couch docs total size in bytes
couchbase.by_bucket.couch_docs_fragmentation avg max min sum percent Couch docs fragmentation
couchbase.by_bucket.couch_spatial_data_size avg max min sum byte Size of object data for spatial views
couchbase.by_bucket.couch_spatial_disk_size avg max min sum byte Amount of disk space occupied by spatial views
couchbase.by_bucket.couch_spatial_ops avg max min sum operation Spatial operations
couchbase.by_bucket.couch_total_disk_size avg max min sum byte Couch total disk size
couchbase.by_bucket.couch_views_data_size avg max min sum byte Size of object data for views
couchbase.by_bucket.couch_views_disk_size avg max min sum byte Amount of disk space occupied by views
couchbase.by_bucket.couch_views_fragmentation avg max min sum percent View fragmentation
couchbase.by_bucket.couch_views_ops avg max min sum operation View operations
couchbase.by_bucket.cpu_idle_ms avg max min sum millisecond CPU idle milliseconds
couchbase.by_bucket.cpu_utilization_rate avg max min sum percent CPU utilization percentage
couchbase.by_bucket.curr_connections avg max min sum connection Current bucket connections
couchbase.by_bucket.curr_items_tot avg max min sum item Total number of items
couchbase.by_bucket.curr_items avg max min sum item Number of active items in memory
couchbase.by_bucket.decr_hits avg max min sum hit Decrement hits
couchbase.by_bucket.decr_misses avg max min sum miss Decrement misses
couchbase.by_bucket.delete_hits avg max min sum hit Delete hits
couchbase.by_bucket.delete_misses avg max min sum miss Delete misses
couchbase.by_bucket.disk_commit_count avg max min sum operation Disk commits
couchbase.by_bucket.disk_update_count avg max min sum operation Disk updates
couchbase.by_bucket.disk_write_queue avg max min sum operation Disk write queue depth
couchbase.by_bucket.ep_bg_fetched avg max min sum fetch/second Disk reads per second
couchbase.by_bucket.ep_cache_miss_rate avg max min sum miss Cache miss rate
couchbase.by_bucket.ep_cache_miss_ratio avg max min sum percent Cache miss ratio
couchbase.by_bucket.ep_dcp_fts_backoff avg max min sum backoff Number of backoffs for fts DCP connections
couchbase.by_bucket.ep_dcp_fts_count avg max min sum connection Number of fts DCP connections
couchbase.by_bucket.ep_dcp_fts_items_remaining avg max min sum item Number of fts items remaining to be sent
couchbase.by_bucket.ep_dcp_fts_items_sent avg max min sum item Number of fts items sent
couchbase.by_bucket.ep_dcp_fts_producer_count avg max min sum producer Number of fts producers
couchbase.by_bucket.ep_dcp_fts_total_bytes avg max min sum byte/second Number bytes per second being sent for fts DCP connections
couchbase.by_bucket.ep_dcp_2i_backoff avg max min sum backoff Number of backoffs for indexes DCP connections
couchbase.by_bucket.ep_dcp_2i_count avg max min sum connection Number of indexes DCP connections
couchbase.by_bucket.ep_dcp_2i_items_remaining avg max min sum item Number of indexes items remaining to be sent
couchbase.by_bucket.ep_dcp_2i_items_sent avg max min sum item Number of indexes items sent
couchbase.by_bucket.ep_dcp_2i_producer_count avg max min sum producer Number of indexes producers
couchbase.by_bucket.ep_dcp_2i_total_bytes avg max min sum byte/second Number bytes per second being sent for indexes DCP connections
couchbase.by_bucket.ep_dcp_other_backoff avg max min sum backoff Number of backoffs for other DCP connections
couchbase.by_bucket.ep_dcp_other_count avg max min sum connection Number of other DCP connections
couchbase.by_bucket.ep_dcp_other_items_remaining avg max min sum item Number of other items remaining to be sent
couchbase.by_bucket.ep_dcp_other_items_sent avg max min sum item Number of other items sent
couchbase.by_bucket.ep_dcp_other_producer_count avg max min sum producer Number of other producers
couchbase.by_bucket.ep_dcp_other_total_bytes avg max min sum byte/second Number bytes per second being sent for other DCP connections
couchbase.by_bucket.ep_dcp_replica_backoff avg max min sum backoff Number of backoffs for replica DCP connections
couchbase.by_bucket.ep_dcp_replica_count avg max min sum connection Number of replica DCP connections
couchbase.by_bucket.ep_dcp_replica_items_remaining avg max min sum item Number of replica items remaining to be sent
couchbase.by_bucket.ep_dcp_replica_items_sent avg max min sum item Number of replica items sent
couchbase.by_bucket.ep_dcp_replica_producer_count avg max min sum producer Number of replica producers
couchbase.by_bucket.ep_dcp_replica_total_bytes avg max min sum byte/second Number bytes per second being sent for replica DCP connections
couchbase.by_bucket.ep_dcp_views_backoff avg max min sum backoff Number of backoffs for views DCP connections
couchbase.by_bucket.ep_dcp_views_count avg max min sum connection Number of views DCP connections
couchbase.by_bucket.ep_dcp_views_items_remaining avg max min sum item Number of views items remaining to be sent
couchbase.by_bucket.ep_dcp_views_items_sent avg max min sum item Number of views items sent
couchbase.by_bucket.ep_dcp_views_producer_count avg max min sum producer Number of views producers
couchbase.by_bucket.ep_dcp_views_total_bytes avg max min sum byte/second Number bytes per second being sent for views DCP connections
couchbase.by_bucket.ep_dcp_xdcr_backoff avg max min sum backoff Number of backoffs for xdcr DCP connections
couchbase.by_bucket.ep_dcp_xdcr_count avg max min sum connection Number of xdcr DCP connections
couchbase.by_bucket.ep_dcp_xdcr_items_remaining avg max min sum item Number of xdcr items remaining to be sent
couchbase.by_bucket.ep_dcp_xdcr_items_sent avg max min sum item Number of xdcr items sent
couchbase.by_bucket.ep_dcp_xdcr_producer_count avg max min sum producer Number of xdcr producers
couchbase.by_bucket.ep_dcp_xdcr_total_bytes avg max min sum byte/second Number bytes per second being sent for xdcr DCP connections
couchbase.by_bucket.ep_diskqueue_drain avg max min sum item Total Drained items on disk queue
couchbase.by_bucket.ep_diskqueue_fill avg max min sum item Total enqueued items on disk queue
couchbase.by_bucket.ep_diskqueue_items avg max min sum item Total number of items waiting to be written to disk
couchbase.by_bucket.ep_flusher_todo avg max min sum item Number of items currently being written
couchbase.by_bucket.ep_item_commit_failed avg max min sum error Number of times a transaction failed to commit due to storage errors
couchbase.by_bucket.ep_kv_size avg max min sum byte Total amount of user data cached in RAM in this bucket
couchbase.by_bucket.ep_max_size avg max min sum byte The maximum amount of memory this bucket can use
couchbase.by_bucket.ep_mem_high_wat avg max min sum byte Mem usage high water mark for auto-evictions
couchbase.by_bucket.ep_mem_low_wat avg max min sum byte Mem usage low water mark for auto-evictions
couchbase.by_bucket.ep_meta_data_memory avg max min sum byte Total amount of item metadata consuming RAM in this bucket
couchbase.by_bucket.ep_num_non_resident avg max min sum item Number of non-resident items
couchbase.by_bucket.ep_num_ops_del_meta avg max min sum operation/second Number of delete operations per second for this bucket as the target for XDCR
couchbase.by_bucket.ep_num_ops_del_ret_meta avg max min sum operation/second Number of delRetMeta operations per second for this bucket as the target for XDCR
couchbase.by_bucket.ep_num_ops_get_meta avg max min sum operation/second Number of read operations per second for this bucket as the target for XDCR
couchbase.by_bucket.ep_num_ops_set_meta avg max min sum operation/second Number of set operations per second for this bucket as the target for XDCR
couchbase.by_bucket.ep_num_ops_set_ret_meta avg max min sum operation/second Number of setRetMeta operations per second for this bucket as the target for XDCR
couchbase.by_bucket.ep_num_value_ejects avg max min sum item Number of times item values got ejected from memory to disk
couchbase.by_bucket.ep_oom_errors avg max min sum error Number of times unrecoverable OOMs happened while processing operations
couchbase.by_bucket.ep_ops_create avg max min sum operation Create operations
couchbase.by_bucket.ep_ops_update avg max min sum operation Update operations
couchbase.by_bucket.ep_overhead avg max min sum byte Extra memory used by transient data like persistence queues or checkpoints
couchbase.by_bucket.ep_queue_size avg max min sum item Number of items queued for storage
couchbase.by_bucket.ep_resident_items_rate avg max min sum item Number of resident items
couchbase.by_bucket.ep_tap_replica_queue_drain avg max min sum item Total drained items in the replica queue
couchbase.by_bucket.ep_tap_total_queue_drain avg max min sum item Total drained items in the queue
couchbase.by_bucket.ep_tap_total_queue_fill avg max min sum item Total enqueued items in the queue
couchbase.by_bucket.ep_tap_total_total_backlog_size avg max min sum item Number of remaining items for replication
couchbase.by_bucket.ep_tmp_oom_errors avg max min sum error Number of times recoverable OOMs happened while processing operations
couchbase.by_bucket.ep_vb_total avg max min sum item Total number of vBuckets for this bucket
couchbase.by_bucket.evictions avg max min sum eviction Number of evictions
couchbase.by_bucket.get_hits avg max min sum hit Number of get hits
couchbase.by_bucket.get_misses avg max min sum miss Number of get misses
couchbase.by_bucket.hibernated_requests avg max min sum request Number of streaming requests now idle
couchbase.by_bucket.hibernated_waked avg max min sum request Rate of streaming request wakeups
couchbase.by_bucket.hit_ratio avg max min sum percent Hit ratio
couchbase.by_bucket.incr_hits avg max min sum hit Number of increment hits
couchbase.by_bucket.incr_misses avg max min sum miss Number of increment misses
couchbase.by_bucket.mem_actual_free avg max min sum byte Free memory
couchbase.by_bucket.mem_actual_used avg max min sum byte Used memory
couchbase.by_bucket.mem_free avg max min sum byte Free memory
couchbase.by_bucket.mem_total avg max min sum byte Total available memory
couchbase.by_bucket.mem_used avg max min sum byte Engine's total memory usage (deprecated)
couchbase.by_bucket.mem_used_sys avg max min sum byte System memory usage
couchbase.by_bucket.misses avg max min sum miss Total number of misses
couchbase.by_bucket.ops avg max min sum operation Total number of operations
couchbase.by_bucket.page_faults avg max min sum page Number of page faults
couchbase.by_bucket.replication_docs_rep_queue avg max min sum item
couchbase.by_bucket.replication_meta_latency_aggr avg max min sum second
couchbase.by_bucket.rest_requests avg max min sum request/second Number of HTTP requests
couchbase.by_bucket.swap_total avg max min sum byte Total amount of swap available
couchbase.by_bucket.swap_used avg max min sum byte Amount of swap used
couchbase.by_bucket.vb_active_eject avg max min sum item/second Number of items per second being ejected to disk from active vBuckets
couchbase.by_bucket.vb_active_itm_memory avg max min sum item Amount of active user data cached in RAM in this bucket
couchbase.by_bucket.vb_active_meta_data_memory avg max min sum item Amount of active item metadata consuming RAM in this bucket
couchbase.by_bucket.vb_active_num_non_resident avg max min sum item Number of non resident vBuckets in the active state for this bucket
couchbase.by_bucket.vb_active_num avg max min sum item Number of active items
couchbase.by_bucket.vb_active_ops_create avg max min sum item/second New items per second being inserted into active vBuckets in this bucket
couchbase.by_bucket.vb_active_ops_update avg max min sum item/second Number of items updated on active vBucket per second for this bucket
couchbase.by_bucket.vb_active_queue_age avg max min sum millisecond Sum of disk queue item age in milliseconds
couchbase.by_bucket.vb_active_queue_drain avg max min sum item Total drained items in the queue
couchbase.by_bucket.vb_active_queue_fill avg max min sum item/second Number of active items per second being put on the active item disk queue
couchbase.by_bucket.vb_active_queue_size avg max min sum item Number of active items in the queue
couchbase.by_bucket.vb_active_resident_items_ratio avg max min sum item Number of resident items
couchbase.by_bucket.vb_avg_active_queue_age avg max min sum second Average age in seconds of active items in the active item queue
couchbase.by_bucket.vb_avg_pending_queue_age avg max min sum second Average age in seconds of pending items in the pending item queue
couchbase.by_bucket.vb_avg_replica_queue_age avg max min sum second Average age in seconds of replica items in the replica item queue
couchbase.by_bucket.vb_avg_total_queue_age avg max min sum second Average age of items in the queue
couchbase.by_bucket.vb_pending_curr_items avg max min sum item Number of items in pending vBuckets
couchbase.by_bucket.vb_pending_eject avg max min sum item/second Number of items per second being ejected to disk from pending vBuckets
couchbase.by_bucket.vb_pending_itm_memory avg max min sum item Amount of pending user data cached in RAM in this bucket
couchbase.by_bucket.vb_pending_meta_data_memory avg max min sum item Amount of pending item metadata consuming RAM in this bucket
couchbase.by_bucket.vb_pending_num_non_resident avg max min sum item Number of non resident vBuckets in the pending state for this bucket
couchbase.by_bucket.vb_pending_num avg max min sum item Number of pending items
couchbase.by_bucket.vb_pending_ops_create avg max min sum operation Number of pending create operations
couchbase.by_bucket.vb_pending_ops_update avg max min sum item/second Number of items updated on pending vBucket per second for this bucket
couchbase.by_bucket.vb_pending_queue_age avg max min sum millisecond Sum of disk pending queue item age in milliseconds
couchbase.by_bucket.vb_pending_queue_drain avg max min sum item Total drained pending items in the queue
couchbase.by_bucket.vb_pending_queue_fill avg max min sum item Total enqueued pending items on disk queue
couchbase.by_bucket.vb_pending_queue_size avg max min sum item Number of pending items in the queue
couchbase.by_bucket.vb_pending_resident_items_ratio avg max min sum item Number of resident pending items
couchbase.by_bucket.vb_replica_curr_items avg max min sum item Number of in memory items
couchbase.by_bucket.vb_replica_eject avg max min sum item/second Number of items per second being ejected to disk from replica vBuckets
couchbase.by_bucket.vb_replica_itm_memory avg max min sum item Amount of replica user data cached in RAM in this bucket
couchbase.by_bucket.vb_replica_meta_data_memory avg max min sum byte Total metadata memory
couchbase.by_bucket.vb_replica_num_non_resident avg max min sum item Number of non resident vBuckets in the replica state for this bucket
couchbase.by_bucket.vb_replica_num avg max min sum item Number of replica vBuckets
couchbase.by_bucket.vb_replica_ops_create avg max min sum operation Number of replica create operations
couchbase.by_bucket.vb_replica_ops_update avg max min sum item/second Number of items updated on replica vBucket per second for this bucket
couchbase.by_bucket.vb_replica_queue_age avg max min sum millisecond Sum of disk replica queue item age in milliseconds
couchbase.by_bucket.vb_replica_queue_drain avg max min sum item Total drained replica items in the queue
couchbase.by_bucket.vb_replica_queue_fill avg max min sum item Total enqueued replica items on disk queue
couchbase.by_bucket.vb_replica_queue_size avg max min sum item Replica items in disk queue
couchbase.by_bucket.vb_replica_resident_items_ratio avg max min sum item Number of resident replica items
couchbase.by_bucket.vb_total_queue_age avg max min sum second Sum of disk queue item age in milliseconds
couchbase.by_bucket.xdc_ops avg max min sum operation Number of cross-datacenter replication operations
couchbase.by_node.curr_items avg max min sum item Number of active items in memory
couchbase.by_node.curr_items_tot avg max min sum item Total number of items
couchbase.by_node.couch_docs_data_size avg max min sum byte Couch docs data size in bytes
couchbase.by_node.couch_docs_actual_disk_size avg max min sum byte Couch docs total size on disk in bytes
couchbase.by_node.couch_views_data_size avg max min sum byte Couch views data size on disk in bytes
couchbase.by_node.couch_views_actual_disk_size avg max min sum byte Couch views total size on disk in bytes
couchbase.by_node.vb_replica_curr_items avg max min sum item Number of in memory items
couchbase.query.cores avg max min sum core
couchbase.query.cpu_sys_percent avg max min sum percent
couchbase.query.cpu_user_percent avg max min sum percent
couchbase.query.gc_num avg max min sum
couchbase.query.gc_pause_percent avg max min sum percent
couchbase.query.gc_pause_time avg max min sum second
couchbase.query.memory_system avg max min sum byte
couchbase.query.memory_total avg max min sum byte
couchbase.query.memory_usage avg max min sum byte
couchbase.query.request_active_count avg max min sum request
couchbase.query.request_completed_count avg max min sum request
couchbase.query.request_per_sec_15min avg max min sum request
couchbase.query.request_per_sec_1min avg max min sum request
couchbase.query.request_per_sec_5min avg max min sum request
couchbase.query.request_prepared_percent avg max min sum request
couchbase.query.request_time_80percentile avg max min sum second
couchbase.query.request_time_95percentile avg max min sum second
couchbase.query.request_time_99percentile avg max min sum second
couchbase.query.request_time_mean avg max min sum second
couchbase.query.request_time_median avg max min sum second
couchbase.query.total_threads avg max min sum thread