Monitoring Consul

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

Installing the consul plugin package

Install the consul plugin on Debian/Ubuntu:

sudo apt-get install sd-agent-consul

Install the consul plugin on RHEL/CentOS:

sudo yum install sd-agent-consul

Read more about agent plugins.

Configuring the agent to monitor Consul

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

init_config:

instances:
# Where your Consul HTTP Server Lives
- url: http://localhost:8500

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:

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

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

Screen_Shot_2018-01-18_at_11.46.12.png

Monitored metrics

MetricValues
consul.catalog.nodes_critical

# of Nodes with service status `critical` from those registered
node / None
Type: float
consul.catalog.nodes_passing

# of Nodes with service status `passing` from those registered
node / None
Type: float
consul.catalog.nodes_up

# of Nodes
node / None
Type: float
consul.catalog.nodes_warning

# of Nodes with service status `warning` from those registered
node / None
Type: float
consul.catalog.services_critical

Total critical services on nodes
service / None
Type: float
consul.catalog.services_passing

Total passing services on nodes
service / None
Type: float
consul.catalog.services_up

Total services registered on nodes
service / None
Type: float
consul.catalog.services_warning

Total warning services on nodes
service / None
Type: float
consul.peers

/
Type: float

Metrics Conversion

Please refer to the metrics conversion document to map old metrics names to the new metric names.

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Monday  —  Friday.

10am  —  6pm UK.

Dedicated Support.