Monitoring EtcD

This article will help you get the Etcd plugin for sd-agent configured and returning metrics

Installing the etcd plugin package

Install the etcd plugin on Debian/Ubuntu:

sudo apt-get install sd-agent-etcd

Install the etcd plugin on RHEL/CentOS:

sudo yum install sd-agent-etcd

Read more about agent plugins.

Configuring the agent to monitor etcd

1. Configure /etc/sd-agent/conf.d/etcd.yaml

init_config:

instances:
 # API endpoint of your etcd instance
 - url: "https://server:port"

• To use key authentication or configure the etcd timeout, amend the rest of 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:

etcd
-----
  - 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 etcd

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 etcd metrics to display the graphs. The metrics will also be available to select when building dashboard graphs.

Monitored metrics

Metric	Values
etcd.leader.counts.fail Rate of failed Raft RPC requests	request / second Type: float
etcd.leader.counts.success Rate of successful Raft RPC requests	request / second Type: float
etcd.leader.latency.avg Average latency to each peer in the cluster	millisecond / None Type: float
etcd.leader.latency.current Current latency to each peer in the cluster	millisecond / None Type: float
etcd.leader.latency.max Maximum latency to each peer in the cluster	millisecond / None Type: float
etcd.leader.latency.min Minimum latency to each peer in the cluster	millisecond / None Type: float
etcd.leader.latency.stddev Standard deviation latency to each peer in the cluster	millisecond / None Type: float
etcd.self.recv.appendrequest.count Rate of append requests this node has processed	request / second Type: float
etcd.self.recv.bandwidthrate Rate of bytes sent	byte / second Type: float
etcd.self.recv.pkgrate Rate of packets sent	packet / second Type: float
etcd.self.send.appendrequest.count Rate of append requests this node has sent	request / second Type: float
etcd.self.send.bandwidthrate Rate of bytes received	byte / second Type: float
etcd.self.send.pkgrate Rate of packets received	packet / second Type: float
etcd.store.compareanddelete.fail Rate of compare and delete requests failure	request / second Type: float
etcd.store.compareanddelete.success Rate of compare and delete requests success	request / second Type: float
etcd.store.compareandswap.fail Rate of compare and swap requests failure	request / second Type: float
etcd.store.compareandswap.success Rate of compare and swap requests success	request / second Type: float
etcd.store.create.fail Rate of failed create requests	request / second Type: float
etcd.store.create.success Rate of successful create requests	request / second Type: float
etcd.store.delete.fail Rate of failed delete requests	request / second Type: float
etcd.store.delete.success Rate of successful delete requests	request / second Type: float
etcd.store.expire.count Rate of expired keys	eviction / second Type: float
etcd.store.gets.fail Rate of failed get requests	request / second Type: float
etcd.store.gets.success Rate of successful get requests	request / second Type: float
etcd.store.sets.fail Rate of failed set requests	request / second Type: float
etcd.store.sets.success Rate of successful set requests	request / second Type: float
etcd.store.update.fail Rate of failed update requests	request / second Type: float
etcd.store.update.success Rate of successful update requests	request / second Type: float
etcd.store.watchers Rate of watchers	None / None Type: float