graphite

README

Graphite Output Plugin

This plugin writes to Graphite via raw TCP.

Configuration:

# Configuration for Graphite server to send metrics to
[[outputs.graphite]]
  ## TCP endpoint for your graphite instance.
  ## If multiple endpoints are configured, the output will be load balanced.
  ## Only one of the endpoints will be written to with each iteration.
  servers = ["localhost:2003"]
  ## Prefix metrics name
  prefix = ""
  ## Graphite output template
  ## see https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md
  template = "host.tags.measurement.field"
  ## timeout in seconds for the write connection to graphite
  timeout = 2

  ## Optional SSL Config
  # ssl_ca = "/etc/telegraf/ca.pem"
  # ssl_cert = "/etc/telegraf/cert.pem"
  # ssl_key = "/etc/telegraf/key.pem"
  ## Use SSL but skip chain & host verification
  # insecure_skip_verify = false

Parameters:

Servers  []string
Prefix   string
Timeout  int
Template string

// Path to CA file
SSLCA string
// Path to host cert file
SSLCert string
// Path to cert key file
SSLKey string
// Skip SSL verification
InsecureSkipVerify bool

Required parameters:

• servers: List of strings, ["mygraphiteserver:2003"].
• prefix: String use to prefix all sent metrics.
• timeout: Connection timeout in seconds.
• template: Template for graphite output format, see https://github.com/influxdata/telegraf/blob/master/docs/DATA_FORMATS_OUTPUT.md for more details.

Optional parameters:

• ssl_ca: SSL CA
• ssl_cert: SSL CERT
• ssl_key: SSL key
• insecure_skip_verify: Use SSL but skip chain & host verification (default: false)

Documentation

Index

• type Graphite
  • func (g *Graphite) Close() error
  • func (g *Graphite) Connect() error
  • func (g *Graphite) Description() string
  • func (g *Graphite) SampleConfig() string
  • func (g *Graphite) Write(metrics []telegraf.Metric) error

Types

type Graphite

type Graphite struct {
	// URL is only for backwards compatibility
	Servers  []string
	Prefix   string
	Template string
	Timeout  int

	// Path to CA file
	SSLCA string `toml:"ssl_ca"`
	// Path to host cert file
	SSLCert string `toml:"ssl_cert"`
	// Path to cert key file
	SSLKey string `toml:"ssl_key"`
	// Skip SSL verification
	InsecureSkipVerify bool
	// contains filtered or unexported fields
}

func (*Graphite) Close

func (g *Graphite) Close() error

func (*Graphite) Connect

func (g *Graphite) Connect() error

func (*Graphite) Description

func (g *Graphite) Description() string

func (*Graphite) SampleConfig

func (g *Graphite) SampleConfig() string

func (*Graphite) Write

func (g *Graphite) Write(metrics []telegraf.Metric) error

Choose a random server in the cluster to write to until a successful write occurs, logging each unsuccessful. If all servers fail, return error.