This article will help you get the Couchbase plugin for sd-agent configured and returning metrics
Installing the couchbase plugin package
Install the couchbase plugin on Debian/Ubuntu:
sudo apt-get install sd-agent-couchbase
Install the couchbase plugin on RHEL/CentOS:
sudo yum install sd-agent-couchbase
Read more about agent plugins.
Configuring the agent to monitor Couchbase
1. Configure /etc/sd-agent/conf.d/couchbase.yaml
init_config:
instances:
- server: http://localhost:8091
user: Administrator
password: password
- If your DB requires additional authentication, you wish to specify a timeout or fine tune other details, amend the config file as necessary.
2. Restart the agent
sudo /etc/init.d/sd-agent restart
or
sudo systemctl restart sd-agent
Verifying the configuration
Execute info to verify the configuration with the following:
sudo /etc/init.d/sd-agent info
or
/usr/share/python/sd-agent/agent.py info
If the agent has been configured correctly you'll see an output such as:
couchbase ----- - instance #0 [OK] - Collected * metrics
You can also view the metrics returned with the following command:
sudo -u sd-agent /usr/share/python/sd-agent/agent.py check couchbase
Configuring graphs
Click the name of your server from the Devices list in your Server Density account then go to the Metrics tab. Click the + Graph button on the right then choose the couchbase metrics to display the graphs. The metrics will also be available to select when building dashboard graphs.
Monitored metrics
| Metric | Values |
|---|---|
| couchbase.by_bucket.avg_bg_wait_time |
second / Type: float |
| couchbase.by_bucket.avg_disk_commit_time |
second / Type: float |
| couchbase.by_bucket.avg_disk_update_time Average disk update time |
microsecond / None Type: float |
| couchbase.by_bucket.bg_wait_total Bytes read |
byte / None Type: float |
| couchbase.by_bucket.bytes_read |
byte / Type: float |
| couchbase.by_bucket.bytes_written |
byte / Type: float |
| couchbase.by_bucket.cas_badval Compare and Swap bad values |
badval / None Type: float |
| couchbase.by_bucket.cas_hits |
/ Type: float |
| couchbase.by_bucket.cas_misses |
/ Type: float |
| couchbase.by_bucket.cmd_get |
/ Type: float |
| couchbase.by_bucket.cmd_set |
/ Type: float |
| couchbase.by_bucket.couch_docs_actual_disk_size |
byte / Type: float |
| couchbase.by_bucket.couch_docs_data_size |
byte / Type: float |
| couchbase.by_bucket.couch_docs_disk_size |
byte / Type: float |
| couchbase.by_bucket.couch_docs_fragmentation |
/ Type: float |
| couchbase.by_bucket.couch_spatial_data_size Size of object data for spatial views |
byte / None Type: float |
| couchbase.by_bucket.couch_spatial_disk_size Amount of disk space occupied by spatial views |
byte / None Type: float |
| couchbase.by_bucket.couch_spatial_ops Spatial operations |
operation / None Type: float |
| couchbase.by_bucket.couch_total_disk_size |
byte / Type: float |
| couchbase.by_bucket.couch_views_data_size Size of object data for views |
byte / None Type: float |
| couchbase.by_bucket.couch_views_disk_size Amount of disk space occupied by views |
byte / None Type: float |
| couchbase.by_bucket.couch_views_fragmentation |
/ Type: float |
| couchbase.by_bucket.couch_views_ops |
/ Type: float |
| couchbase.by_bucket.cpu_idle_ms |
millisecond / Type: float |
| couchbase.by_bucket.cpu_utilization_rate |
/ Type: float |
| couchbase.by_bucket.curr_connections |
/ Type: float |
| couchbase.by_bucket.curr_items |
/ Type: float |
| couchbase.by_bucket.curr_items_tot |
/ Type: float |
| couchbase.by_bucket.decr_hits |
/ Type: float |
| couchbase.by_bucket.decr_misses |
/ Type: float |
| couchbase.by_bucket.delete_hits |
/ Type: float |
| couchbase.by_bucket.delete_misses |
/ Type: float |
| couchbase.by_bucket.disk_commit_count |
/ Type: float |
| couchbase.by_bucket.disk_update_count |
/ Type: float |
| couchbase.by_bucket.disk_write_queue |
/ Type: float |
| couchbase.by_bucket.ep_bg_fetched |
second / Type: float |
| couchbase.by_bucket.ep_cache_miss_rate |
/ Type: float |
| couchbase.by_bucket.ep_cache_miss_ratio Cache miss ratio |
percent / None Type: float |
| couchbase.by_bucket.ep_dcp_2i_backoff Number of backoffs for indexes DCP connections |
backoff / None Type: float |
| couchbase.by_bucket.ep_dcp_2i_count Number of indexes DCP connections |
connection / None Type: float |
| couchbase.by_bucket.ep_dcp_2i_items_remaining Number of indexes items remaining to be sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_2i_items_sent Number of indexes items sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_2i_producer_count Number of indexes producers |
producer / None Type: float |
| couchbase.by_bucket.ep_dcp_2i_total_bytes Number bytes per second being sent for indexes DCP connections |
byte / second Type: float |
| couchbase.by_bucket.ep_dcp_fts_backoff Number of backoffs for fts DCP connections |
backoff / None Type: float |
| couchbase.by_bucket.ep_dcp_fts_count Number of fts DCP connections |
connection / None Type: float |
| couchbase.by_bucket.ep_dcp_fts_items_remaining Number of fts items remaining to be sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_fts_items_sent Number of fts items sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_fts_producer_count Number of fts producers |
producer / None Type: float |
| couchbase.by_bucket.ep_dcp_fts_total_bytes Number bytes per second being sent for fts DCP connections |
byte / second Type: float |
| couchbase.by_bucket.ep_dcp_other_backoff Number of backoffs for other DCP connections |
backoff / None Type: float |
| couchbase.by_bucket.ep_dcp_other_count Number of other DCP connections |
connection / None Type: float |
| couchbase.by_bucket.ep_dcp_other_items_remaining Number of other items remaining to be sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_other_items_sent Number of other items sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_other_producer_count Number of other producers |
producer / None Type: float |
| couchbase.by_bucket.ep_dcp_other_total_bytes Number bytes per second being sent for other DCP connections |
byte / second Type: float |
| couchbase.by_bucket.ep_dcp_replica_backoff Number of backoffs for replica DCP connections |
backoff / None Type: float |
| couchbase.by_bucket.ep_dcp_replica_count Number of replica DCP connections |
connection / None Type: float |
| couchbase.by_bucket.ep_dcp_replica_items_remaining Number of replica items remaining to be sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_replica_items_sent Number of replica items sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_replica_producer_count Number of replica producers |
producer / None Type: float |
| couchbase.by_bucket.ep_dcp_replica_total_bytes Number bytes per second being sent for replica DCP connections |
byte / second Type: float |
| couchbase.by_bucket.ep_dcp_views_backoff Number of backoffs for views DCP connections |
backoff / None Type: float |
| couchbase.by_bucket.ep_dcp_views_count Number of views DCP connections |
connection / None Type: float |
| couchbase.by_bucket.ep_dcp_views_items_remaining Number of views items remaining to be sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_views_items_sent Number of views items sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_views_producer_count Number of views producers |
producer / None Type: float |
| couchbase.by_bucket.ep_dcp_views_total_bytes Number bytes per second being sent for views DCP connections |
byte / second Type: float |
| couchbase.by_bucket.ep_dcp_xdcr_backoff Number of backoffs for xdcr DCP connections |
backoff / None Type: float |
| couchbase.by_bucket.ep_dcp_xdcr_count Number of xdcr DCP connections |
connection / None Type: float |
| couchbase.by_bucket.ep_dcp_xdcr_items_remaining Number of xdcr items remaining to be sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_xdcr_items_sent Number of xdcr items sent |
item / None Type: float |
| couchbase.by_bucket.ep_dcp_xdcr_producer_count Number of xdcr producers |
producer / None Type: float |
| couchbase.by_bucket.ep_dcp_xdcr_total_bytes Number bytes per second being sent for xdcr DCP connections |
byte / second Type: float |
| couchbase.by_bucket.ep_diskqueue_drain |
/ Type: float |
| couchbase.by_bucket.ep_diskqueue_fill |
/ Type: float |
| couchbase.by_bucket.ep_diskqueue_items Total number of items waiting to be written to disk |
item / None Type: float |
| couchbase.by_bucket.ep_flusher_todo |
/ Type: float |
| couchbase.by_bucket.ep_item_commit_failed |
/ Type: float |
| couchbase.by_bucket.ep_kv_size Total amount of user data cached in RAM in this bucket |
byte / None Type: float |
| couchbase.by_bucket.ep_max_size |
byte / Type: float |
| couchbase.by_bucket.ep_mem_high_wat |
byte / Type: float |
| couchbase.by_bucket.ep_mem_low_wat |
byte / Type: float |
| couchbase.by_bucket.ep_meta_data_memory Total amount of item metadata consuming RAM in this bucket |
byte / None Type: float |
| couchbase.by_bucket.ep_num_non_resident |
/ Type: float |
| couchbase.by_bucket.ep_num_ops_del_meta Number of delete operations per second for this bucket as the target for XDCR |
operation / second Type: float |
| couchbase.by_bucket.ep_num_ops_del_ret_meta Number of delRetMeta operations per second for this bucket as the target for XDCR |
operation / second Type: float |
| couchbase.by_bucket.ep_num_ops_get_meta Number of read operations per second for this bucket as the target for XDCR |
operation / second Type: float |
| couchbase.by_bucket.ep_num_ops_set_meta Number of set operations per second for this bucket as the target for XDCR |
operation / second Type: float |
| couchbase.by_bucket.ep_num_ops_set_ret_meta Number of setRetMeta operations per second for this bucket as the target for XDCR |
operation / second Type: float |
| couchbase.by_bucket.ep_num_value_ejects |
/ Type: float |
| couchbase.by_bucket.ep_oom_errors |
/ Type: float |
| couchbase.by_bucket.ep_ops_create |
/ Type: float |
| couchbase.by_bucket.ep_ops_update |
/ Type: float |
| couchbase.by_bucket.ep_overhead |
byte / Type: float |
| couchbase.by_bucket.ep_queue_size |
/ Type: float |
| couchbase.by_bucket.ep_resident_items_rate |
/ Type: float |
| couchbase.by_bucket.ep_tap_replica_queue_drain |
/ Type: float |
| couchbase.by_bucket.ep_tap_total_queue_drain |
/ Type: float |
| couchbase.by_bucket.ep_tap_total_queue_fill |
/ Type: float |
| couchbase.by_bucket.ep_tap_total_total_backlog_size |
/ Type: float |
| couchbase.by_bucket.ep_tmp_oom_errors |
/ Type: float |
| couchbase.by_bucket.ep_vb_total Total number of vBuckets for this bucket |
item / None Type: float |
| couchbase.by_bucket.evictions |
/ Type: float |
| couchbase.by_bucket.get_hits |
/ Type: float |
| couchbase.by_bucket.get_misses |
/ Type: float |
| couchbase.by_bucket.hibernated_requests Number of streaming requests now idle |
request / None Type: float |
| couchbase.by_bucket.hibernated_waked Rate of streaming request wakeups |
request / None Type: float |
| couchbase.by_bucket.hit_ratio |
/ Type: float |
| couchbase.by_bucket.incr_hits |
/ Type: float |
| couchbase.by_bucket.incr_misses |
/ Type: float |
| couchbase.by_bucket.mem_actual_free Free memory |
byte / None Type: float |
| couchbase.by_bucket.mem_actual_used Used memory |
byte / None Type: float |
| couchbase.by_bucket.mem_free |
byte / Type: float |
| couchbase.by_bucket.mem_total |
byte / Type: float |
| couchbase.by_bucket.mem_used |
/ Type: float |
| couchbase.by_bucket.mem_used_sys System memory usage |
byte / None Type: float |
| couchbase.by_bucket.misses |
/ Type: float |
| couchbase.by_bucket.ops |
/ Type: float |
| couchbase.by_bucket.page_faults |
/ Type: float |
| couchbase.by_bucket.quota_total_per_node |
/ Type: float |
| couchbase.by_bucket.quota_used |
/ Type: float |
| couchbase.by_bucket.quota_used_per_node |
/ Type: float |
| couchbase.by_bucket.replication_docs_rep_queue |
/ Type: float |
| couchbase.by_bucket.replication_meta_latency_aggr |
second / Type: float |
| couchbase.by_bucket.rest_requests Number of HTTP requests |
request / second Type: float |
| couchbase.by_bucket.swap_total Total amount of swap available |
byte / None Type: float |
| couchbase.by_bucket.swap_used Amount of swap used |
byte / None Type: float |
| couchbase.by_bucket.total |
/ Type: int |
| couchbase.by_bucket.vb_active_eject Number of items per second being ejected to disk from active vBuckets |
item / second Type: float |
| couchbase.by_bucket.vb_active_itm_memory Amount of active user data cached in RAM in this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_active_meta_data_memory Amount of active item metadata consuming RAM in this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_active_num |
/ Type: float |
| couchbase.by_bucket.vb_active_num_non_resident Number of non resident vBuckets in the active state for this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_active_ops_create New items per second being inserted into active vBuckets in this bucket |
item / second Type: float |
| couchbase.by_bucket.vb_active_ops_update Number of items updated on active vBucket per second for this bucket |
item / second Type: float |
| couchbase.by_bucket.vb_active_queue_age Sum of disk queue item age in milliseconds |
millisecond / None Type: float |
| couchbase.by_bucket.vb_active_queue_drain |
/ Type: float |
| couchbase.by_bucket.vb_active_queue_fill Number of active items per second being put on the active item disk queue |
item / second Type: float |
| couchbase.by_bucket.vb_active_queue_size |
/ Type: float |
| couchbase.by_bucket.vb_active_resident_items_ratio |
/ Type: float |
| couchbase.by_bucket.vb_avg_active_queue_age Average age in seconds of active items in the active item queue |
second / None Type: float |
| couchbase.by_bucket.vb_avg_pending_queue_age Average age in seconds of pending items in the pending item queue |
second / None Type: float |
| couchbase.by_bucket.vb_avg_replica_queue_age Average age in seconds of replica items in the replica item queue |
second / None Type: float |
| couchbase.by_bucket.vb_avg_total_queue_age |
second / Type: float |
| couchbase.by_bucket.vb_pending_curr_items Number of items in pending vBuckets |
item / None Type: float |
| couchbase.by_bucket.vb_pending_eject Number of items per second being ejected to disk from pending vBuckets |
item / second Type: float |
| couchbase.by_bucket.vb_pending_itm_memory Amount of pending user data cached in RAM in this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_pending_meta_data_memory Amount of pending item metadata consuming RAM in this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_pending_num Number of pending items |
item / None Type: float |
| couchbase.by_bucket.vb_pending_num_non_resident Number of non resident vBuckets in the pending state for this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_pending_ops_create |
/ Type: float |
| couchbase.by_bucket.vb_pending_ops_update Number of items updated on pending vBucket per second for this bucket |
item / second Type: float |
| couchbase.by_bucket.vb_pending_queue_age Sum of disk pending queue item age in milliseconds |
millisecond / None Type: float |
| couchbase.by_bucket.vb_pending_queue_drain Total drained pending items in the queue |
item / None Type: float |
| couchbase.by_bucket.vb_pending_queue_fill |
/ Type: float |
| couchbase.by_bucket.vb_pending_queue_size Number of pending items in the queue |
item / None Type: float |
| couchbase.by_bucket.vb_pending_resident_items_ratio Number of resident pending items |
item / None Type: float |
| couchbase.by_bucket.vb_replica_curr_items |
/ Type: float |
| couchbase.by_bucket.vb_replica_eject Number of items per second being ejected to disk from replica vBuckets |
item / second Type: float |
| couchbase.by_bucket.vb_replica_itm_memory Amount of replica user data cached in RAM in this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_replica_meta_data_memory |
byte / Type: float |
| couchbase.by_bucket.vb_replica_num |
/ Type: float |
| couchbase.by_bucket.vb_replica_num_non_resident Number of non resident vBuckets in the replica state for this bucket |
item / None Type: float |
| couchbase.by_bucket.vb_replica_ops_create Number of replica create operations |
operation / None Type: float |
| couchbase.by_bucket.vb_replica_ops_update Number of items updated on replica vBucket per second for this bucket |
item / second Type: float |
| couchbase.by_bucket.vb_replica_queue_age Sum of disk replica queue item age in milliseconds |
millisecond / None Type: float |
| couchbase.by_bucket.vb_replica_queue_drain Total drained replica items in the queue |
item / None Type: float |
| couchbase.by_bucket.vb_replica_queue_fill Total enqueued replica items on disk queue |
item / None Type: float |
| couchbase.by_bucket.vb_replica_queue_size |
/ Type: float |
| couchbase.by_bucket.vb_replica_resident_items_ratio Number of resident replica items |
item / None Type: float |
| couchbase.by_bucket.vb_total_queue_age Sum of disk queue item age in milliseconds |
second / None Type: float |
| couchbase.by_bucket.xdc_ops |
/ Type: float |
| couchbase.by_node.couch_docs_actual_disk_size Couch docs total size on disk in bytes |
byte / None Type: float |
| couchbase.by_node.couch_docs_data_size |
byte / Type: float |
| couchbase.by_node.couch_spatial_disk_size |
byte / Type: float |
| couchbase.by_node.couch_views_actual_disk_size |
/ Type: float |
| couchbase.by_node.couch_views_data_size |
/ Type: float |
| couchbase.by_node.curr_items |
/ Type: float |
| couchbase.by_node.curr_items_tot |
/ Type: float |
| couchbase.by_node.mem_used |
/ Type: float |
| couchbase.by_node.vb_replica_curr_items |
/ Type: float |
| couchbase.hdd.free |
byte / Type: float |
| couchbase.hdd.quota_total |
byte / Type: float |
| couchbase.hdd.total |
byte / Type: float |
| couchbase.hdd.used |
byte / Type: float |
| couchbase.hdd.used_by_data |
byte / Type: float |
| couchbase.query.cores |
core / None Type: float |
| couchbase.query.cpu_sys_percent |
percent / None Type: float |
| couchbase.query.cpu_user_percent |
percent / None Type: float |
| couchbase.query.gc_num |
None / None Type: float |
| couchbase.query.gc_pause_percent |
percent / None Type: float |
| couchbase.query.gc_pause_time |
second / None Type: float |
| couchbase.query.memory_system |
byte / None Type: float |
| couchbase.query.memory_total |
byte / None Type: float |
| couchbase.query.memory_usage |
byte / None Type: float |
| couchbase.query.request_active_count |
request / None Type: float |
| couchbase.query.request_completed_count |
request / None Type: float |
| couchbase.query.request_per_sec_15min |
request / None Type: float |
| couchbase.query.request_per_sec_1min |
request / None Type: float |
| couchbase.query.request_per_sec_5min |
request / None Type: float |
| couchbase.query.request_prepared_percent |
request / None Type: float |
| couchbase.query.request_time_80percentile |
second / None Type: float |
| couchbase.query.request_time_95percentile |
second / None Type: float |
| couchbase.query.request_time_99percentile |
second / None Type: float |
| couchbase.query.request_time_mean |
second / None Type: float |
| couchbase.query.request_time_median |
second / None Type: float |
| couchbase.query.total_threads |
thread / None Type: float |
| couchbase.ram.quota_total |
byte / Type: float |
| couchbase.ram.quota_total_per_node |
byte / Type: float |
| couchbase.ram.quota_used |
byte / Type: float |
| couchbase.ram.quota_used_per_node |
byte / Type: float |
| couchbase.ram.total |
byte / Type: float |
| couchbase.ram.used |
byte / Type: float |
| couchbase.ram.used_by_data |
byte / Type: float |
Metrics Conversion
Please refer to the metrics conversion document to map old metrics names to the new metric names.
Comments