Etcd is a distributed key-value store that provides a reliable way to store data that needs to be accessed by a distributed system or cluster of machines. It handles leader elections during network partitions and can tolerate machine failure, even in the leader node.
Prerequisite
For Virtual machines, install the Linux agent.
Configuring the application
Virtual machine
Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-detection.yaml
- name: etcd
instance-checks:
service-check:
- etcd
process-check:
- etcd
port-check:
- 2379
Docker environment
Configure the application in the directory /opt/opsramp/agent/conf/app/discovery/auto-container-detection.yaml
- name: etcd
container-checks:
image-check:
- etcd
port-check:
- 2379
Kubernetes environment
Configure the application in config.yaml
- name: etcd
container-checks:
image-check:
- etcd
port-check:
- 2379
Validate
Go to Resources under the Infrastructure tab to check if your resources are onboarded and the metrics are collected.
Supported metrics
| OpsRamp Metric | Metric Display Name | Unit |
|---|---|---|
| etcd_debugging_mvcc_db_compaction_keys_total Total number of db keys compacted | Mvcc Db Compaction Keys | millisecond |
| etcd_debugging_mvcc_db_compaction_pause_duration_milliseconds_bucket Bucketed histogram of db compaction pause duration | Mvcc Db Compaction Pause Duration | millisecond |
| etcd_debugging_mvcc_db_compaction_total_duration_milliseconds_bucket Bucketed histogram of db compaction total duration | Mvcc Db Compaction Duration | byte |
| etcd_debugging_mvcc_db_total_size_in_bytes Total size of the underlying database | Mvcc Db Size In Bytes | bytes |
| etcd_debugging_mvcc_delete_total Total number of deletes seen by this member | Mvcc Delete | |
| etcd_debugging_mvcc_events_total Total number of events sent by this member | Mvcc Events | |
| etcd_debugging_mvcc_index_compaction_pause_duration_milliseconds_bucket Bucketed histogram of index compaction pause duration | Mvcc Index Compaction Pause Duration | millisecond |
| etcd_debugging_mvcc_keys_total Total number of keys | Mvcc Keys | |
| etcd_debugging_mvcc_pending_events_total Total number of pending events to be sent | Mvcc Pending Events | |
| etcd_debugging_mvcc_put_total Total number of puts seen by this member | Mvcc Put | |
| etcd_debugging_mvcc_range_total Total number of ranges seen by this member | Mvcc Range | |
| etcd_debugging_mvcc_slow_watcher_total Total number of unsynced slow watchers | Mvcc Slow Watcher | |
| etcd_debugging_mvcc_txn_total Total number of txns seen by this member | Mvcc Txn | |
| etcd_debugging_mvcc_watch_stream_total Total number of watch streams | Mvcc Watch Stream | |
| etcd_debugging_mvcc_watcher_total Total number of watchers | Mvcc Watcher | |
| etcd_debugging_server_lease_expired_total Total number of expired leases | Server Lease Expired | |
| etcd_debugging_snap_save_marshalling_duration_seconds_bucket The marshalling cost distributions of save called by snapshot | Snap Save Marshalling Duration | second |
| etcd_debugging_snap_save_total_duration_seconds_bucket Total latency distributions of save called by snapshot | Snap Save Duration | second |
| etcd_debugging_store_expires_total Total number of expired keys | Store Expires | |
| etcd_debugging_store_reads_total Total number of reads action by (get/getRecursive), local to this member | Store Reads | |
| etcd_debugging_store_watch_requests_total Total number of incoming watch requests (new or reestablished) | Store Watch Requests | |
| etcd_debugging_store_watchers Count of currently active watchers | Store Watchers | |
| etcd_debugging_store_writes_total Total number of writes, such as set/compareAndDelete, seen by this member | Store Writes | |
| etcd_disk_backend_commit_duration_seconds_bucket Latency distributions of commit called by backend | Disk Backend Commit Duration | second |
| etcd_disk_backend_snapshot_duration_seconds_bucket Latency distribution of backend snapshots | Disk Backend Snapshot Duration | second |
| etcd_disk_wal_fsync_duration_seconds_bucket Latency distributions of fsync called by wal | Disk Wal Fsync Duration | second |
| etcd_grpc_proxy_cache_hits_total Total number of cache hits | Grpc Proxy Cache Hits | |
| etcd_grpc_proxy_cache_keys_total Total number of keys/ranges cached | Grpc Proxy Cache Keys | |
| etcd_grpc_proxy_cache_misses_total Total number of cache misses | Grpc Proxy Cache Misses | |
| etcd_grpc_proxy_events_coalescing_total Total number of events coalescing | Grpc Proxy Events Coalescing | |
| etcd_grpc_proxy_watchers_coalescing_total Total number of current watchers coalescing | Grpc Proxy Watchers Coalescing | |
| etcd_network_client_grpc_received_bytes_total Total number of bytes received from grpc clients | Network Client Grpc Received Bytes | bytes |
| etcd_network_client_grpc_sent_bytes_total Total number of bytes sent to grpc clients | Network Client Grpc Sent Bytes | bytes |
| etcd_server_has_leader Whether or not a leader exists. 1 is existence, 0 is not | Server Has Leader | |
| etcd_server_is_leader Whether or not this member is a leader. 1 if is, 0 otherwise | Server Is Leader | |
| etcd_server_leader_changes_seen_total Number of leader changes seen | Server Leader Changes Seen | |
| etcd_server_proposals_applied_total Total number of consensus proposals applied | Server Proposals Applied | |
| etcd_server_proposals_committed_total Total number of consensus proposals committed | Server Proposals Committed | |
| etcd_server_proposals_failed_total Total number of failed proposals seen | Server Proposals Failed | |
| etcd_server_proposals_pending Current number of pending proposals to commit | Server Proposals Pending |