consul

README

Consul monitoring with Netdata

Consul is a service networking solution to connect and secure services across any runtime platform and public or private cloud.

This module monitors Consul health checks.

Metrics

All metrics have "consul." prefix.

Metric	Scope	Dimensions	Units
service_health_check_status	check	passing, maintenance, warning, critical	status
unbound_health_check_status	check	passing, maintenance, warning, critical	status

Configuration

Edit the go.d/consul.conf configuration file using edit-config from the Netdata config directory, which is typically at /etc/netdata.

cd /etc/netdata # Replace this path with your Netdata config directory
sudo ./edit-config go.d/consul.conf

Here is an example for 2 servers:

jobs:
  - name: local
    url: http://127.0.0.1:8500

  - name: remote
    url: http://203.0.113.10:8500

For all available options please see module configuration file.

Troubleshooting

To troubleshoot issues with the consul collector, run the go.d.plugin with the debug option enabled. The output should give you clues as to why the collector isn't working.

• Navigate to the plugins.d directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the plugins setting under [directories].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m consul
  

Documentation

Index

• type Config
• type Consul
  • func New() *Consul
  • func (c *Consul) Charts() *module.Charts
  • func (c *Consul) Check() bool
  • func (c *Consul) Cleanup()
  • func (c *Consul) Collect() map[string]int64
  • func (c *Consul) Init() bool

Types

type Config

type Config struct {
	web.HTTP `yaml:",inline"`

	ACLToken       string `yaml:"acl_token"`
	ChecksSelector string `yaml:"checks_selector"`
}

type Consul

type Consul struct {
	module.Base

	Config `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *Consul

func (*Consul) Charts

func (c *Consul) Charts() *module.Charts

func (*Consul) Check

func (c *Consul) Check() bool

func (*Consul) Cleanup

func (c *Consul) Cleanup()

func (*Consul) Collect

func (c *Consul) Collect() map[string]int64

func (*Consul) Init

func (c *Consul) Init() bool