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.
Metrics
| OpsRamp Metric | Metric Display Name | Unit | Description |
|---|---|---|---|
| etcd_debugging_mvcc_db_compaction_keys_total | Mvcc Db Compaction Keys | millisecond | Total number of db keys compacted |
| etcd_debugging_mvcc_db_compaction_pause_duration_milliseconds_bucket | Mvcc Db Compaction Pause Duration | millisecond | Bucketed histogram of db compaction pause duration |
| etcd_debugging_mvcc_db_compaction_total_duration_milliseconds_bucket | Mvcc Db Compaction Duration | byte | Bucketed histogram of db compaction total duration |
| etcd_debugging_mvcc_db_total_size_in_bytes | Mvcc Db Size In Bytes | bytes | Total size of the underlying database |
| etcd_debugging_mvcc_delete_total | Mvcc Delete | Total number of deletes seen by this member | |
| etcd_debugging_mvcc_events_total | Mvcc Events | Total number of events sent by this member | |
| etcd_debugging_mvcc_index_compaction_pause_duration_milliseconds_bucket | Mvcc Index Compaction Pause Duration | millisecond | Bucketed histogram of index compaction pause duration |
| etcd_debugging_mvcc_keys_total | Mvcc Keys | Total number of keys | |
| etcd_debugging_mvcc_pending_events_total | Mvcc Pending Events | Total number of pending events to be sent | |
| etcd_debugging_mvcc_put_total | Mvcc Put | Total number of puts seen by this member | |
| etcd_debugging_mvcc_range_total | Mvcc Range | Total number of ranges seen by this member | |
| etcd_debugging_mvcc_slow_watcher_total | Mvcc Slow Watcher | Total number of unsynced slow watchers | |
| etcd_debugging_mvcc_txn_total | Mvcc Txn | Total number of txns seen by this member | |
| etcd_debugging_mvcc_watch_stream_total | Mvcc Watch Stream | Total number of watch streams | |
| etcd_debugging_mvcc_watcher_total | Mvcc Watcher | Total number of watchers | |
| etcd_debugging_server_lease_expired_total | Server Lease Expired | Total number of expired leases | |
| etcd_debugging_snap_save_marshalling_duration_seconds_bucket | Snap Save Marshalling Duration | second | The marshalling cost distributions of save called by snapshot |
| etcd_debugging_snap_save_total_duration_seconds_bucket | Snap Save Duration | second | Total latency distributions of save called by snapshot |
| etcd_debugging_store_expires_total | Store Expires | Total number of expired keys | |
| etcd_debugging_store_reads_total | Store Reads | Total number of reads action by (get/getRecursive), local to this member | |
| etcd_debugging_store_watch_requests_total | Store Watch Requests | Total number of incoming watch requests (new or reestablished) | |
| etcd_debugging_store_watchers | Store Watchers | Count of currently active watchers | |
| etcd_debugging_store_writes_total | Store Writes | Total number of writes (e.g. set/compareAndDelete) seen by this member | |
| etcd_disk_backend_commit_duration_seconds_bucket | Disk Backend Commit Duration | second | Latency distributions of commit called by backend |
| etcd_disk_backend_snapshot_duration_seconds_bucket | Disk Backend Snapshot Duration | second | Latency distribution of backend snapshots |
| etcd_disk_wal_fsync_duration_seconds_bucket | Disk Wal Fsync Duration | second | Latency distributions of fsync called by wal |
| etcd_grpc_proxy_cache_hits_total | Grpc Proxy Cache Hits | Total number of cache hits | |
| etcd_grpc_proxy_cache_keys_total | Grpc Proxy Cache Keys | Total number of keys/ranges cached | |
| etcd_grpc_proxy_cache_misses_total | Grpc Proxy Cache Misses | Total number of cache misses | |
| etcd_grpc_proxy_events_coalescing_total | Grpc Proxy Events Coalescing | Total number of events coalescing | |
| etcd_grpc_proxy_watchers_coalescing_total | Grpc Proxy Watchers Coalescing | Total number of current watchers coalescing | |
| etcd_network_client_grpc_received_bytes_total | Network Client Grpc Received Bytes | bytes | Total number of bytes received from grpc clients |
| etcd_network_client_grpc_sent_bytes_total | Network Client Grpc Sent Bytes | bytes | Total number of bytes sent to grpc clients |
| etcd_server_has_leader | Server Has Leader | Whether or not a leader exists. 1 is existence, 0 is not | |
| etcd_server_is_leader | Server Is Leader | Whether or not this member is a leader. 1 if is, 0 otherwise | |
| etcd_server_leader_changes_seen_total | Server Leader Changes Seen | Number of leader changes seen | |
| etcd_server_proposals_applied_total | Server Proposals Applied | Total number of consensus proposals applied | |
| etcd_server_proposals_committed_total | Server Proposals Committed | Total number of consensus proposals committed | |
| etcd_server_proposals_failed_total | Server Proposals Failed | Total number of failed proposals seen | |
| etcd_server_proposals_pending | Server Proposals Pending | Current number of pending proposals to commit |