consul

README

Consul Input Plugin

This plugin will collect statistics about all health checks registered in the Consul. It uses Consul API to query the data. It will not report the telemetry but Consul can report those stats already using StatsD protocol if needed.

Global configuration options

In addition to the plugin-specific configuration settings, plugins support additional global and plugin configuration settings. These settings are used to modify metrics, tags, and field or create aliases and configure ordering, etc. See the CONFIGURATION.md for more details.

Configuration

# Gather health check statuses from services registered in Consul
[[inputs.consul]]
  ## Consul server address
  # address = "localhost:8500"

  ## URI scheme for the Consul server, one of "http", "https"
  # scheme = "http"

  ## Metric version controls the mapping from Consul metrics into
  ## Telegraf metrics. Version 2 moved all fields with string values
  ## to tags.
  ##
  ##   example: metric_version = 1; deprecated in 1.16
  ##            metric_version = 2; recommended version
  # metric_version = 1

  ## ACL token used in every request
  # token = ""

  ## HTTP Basic Authentication username and password.
  # username = ""
  # password = ""

  ## Data center to query the health checks from
  # datacenter = ""

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = true

  ## Consul checks' tag splitting
  # When tags are formatted like "key:value" with ":" as a delimiter then
  # they will be split and reported as proper key:value in Telegraf
  # tag_delimiter = ":"

Metrics

metric_version = 1

• consul_health_checks
  • tags:
    • node (node that check/service is registered on)
    • service_name
    • check_id
  • fields:
    • check_name
    • service_id
    • status
    • passing (integer)
    • critical (integer)
    • warning (integer)

metric_version = 2

• consul_health_checks
  • tags:
    • node (node that check/service is registered on)
    • service_name
    • check_id
    • check_name
    • service_id
    • status
  • fields:
    • passing (integer)
    • critical (integer)
    • warning (integer)

passing, critical, and warning are integer representations of the health check state. A value of 1 represents that the status was the state of the health check at this sample. status is string representation of the same state.

Example Output

consul_health_checks,host=wolfpit,node=consul-server-node,check_id="serfHealth" check_name="Serf Health Status",service_id="",status="passing",passing=1i,critical=0i,warning=0i 1464698464486439902
consul_health_checks,host=wolfpit,node=consul-server-node,service_name=www.example.com,check_id="service:www-example-com.test01" check_name="Service 'www.example.com' check",service_id="www-example-com.test01",status="critical",passing=0i,critical=1i,warning=0i 1464698464486519036

Documentation

Index

• type Consul
  • func (c *Consul) Gather(acc telegraf.Accumulator) error
  • func (c *Consul) GatherHealthCheck(acc telegraf.Accumulator, checks []*api.HealthCheck)
  • func (c *Consul) Init() error
  • func (*Consul) SampleConfig() string

Types

type Consul

type Consul struct {
	Address    string
	Scheme     string
	Token      string
	Username   string
	Password   string
	Datacentre string `toml:"datacentre" deprecated:"1.10.0;use 'datacenter' instead"`
	Datacenter string
	tls.ClientConfig
	TagDelimiter  string
	MetricVersion int
	Log           telegraf.Logger
	// contains filtered or unexported fields
}

func (*Consul) Gather

func (c *Consul) Gather(acc telegraf.Accumulator) error

func (*Consul) GatherHealthCheck

func (c *Consul) GatherHealthCheck(acc telegraf.Accumulator, checks []*api.HealthCheck)

func (*Consul) Init

func (c *Consul) Init() error

func (*Consul) SampleConfig

func (*Consul) SampleConfig() string