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.

Charts

It produces the following charts:

• Service Checks in status
• Unbound Checks in 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.

First, navigate to your plugins directory, usually at /usr/libexec/netdata/plugins.d/. If that's not the case on your system, open netdata.conf and look for the setting plugins directory. Once you're in the plugin's directory, switch to the netdata user.

cd /usr/libexec/netdata/plugins.d/
sudo -u netdata -s

You can now run the go.d.plugin to debug the collector:

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

Documentation

Index

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

Types

type Chart

type Chart = module.Chart

Chart is an alias for module.Chart

type Charts

type Charts = module.Charts

Charts is an alias for module.Charts

type Consul

type Consul struct {
	module.Base

	web.HTTP `yaml:",inline"`

	ACLToken     string `yaml:"acl_token"`
	MaxChecks    int    `yaml:"max_checks"`
	ChecksFilter string `yaml:"checks_filter"`
	// contains filtered or unexported fields
}

Consul Consul module.

func New

func New() *Consul

New creates Consul with default values.

func (Consul) Charts

func (c Consul) Charts() *Charts

Charts creates Charts.

func (*Consul) Check

func (c *Consul) Check() bool

Check makes check.

func (Consul) Cleanup

func (Consul) Cleanup()

Cleanup makes cleanup.

func (*Consul) Collect

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

Collect collects metrics.

func (*Consul) Init

func (c *Consul) Init() bool

Init makes initialization.

type Dim

type Dim = module.Dim

Dim is an alias for module.Dim