telegraf

README

Telegraf

Telegraf is an agent written in Go for collecting metrics from the system it's running on, or from other services, and writing them into InfluxDB or other outputs.

Design goals are to have a minimal memory footprint with a plugin system so that developers in the community can easily add support for collecting metrics from well known services (like Hadoop, Postgres, or Redis) and third party APIs (like Mailchimp, AWS CloudWatch, or Google Analytics).

New input and output plugins are designed to be easy to contribute, we'll eagerly accept pull requests and will manage the set of plugins that Telegraf supports. See the contributing guide for instructions on writing new plugins.

Installation:

Linux deb and rpm Packages:

Latest:

• http://get.influxdb.org/telegraf/telegraf_0.11.1-1_amd64.deb
• http://get.influxdb.org/telegraf/telegraf-0.11.1-1.x86_64.rpm

Latest (arm):

• http://get.influxdb.org/telegraf/telegraf_0.11.1-1_armhf.deb
• http://get.influxdb.org/telegraf/telegraf-0.11.1-1.armhf.rpm

Package Instructions:

• Telegraf binary is installed in /usr/bin/telegraf
• Telegraf daemon configuration file is in /etc/telegraf/telegraf.conf
• On sysv systems, the telegraf daemon can be controlled via service telegraf [action]
• On systemd systems (such as Ubuntu 15+), the telegraf daemon can be controlled via systemctl [action] telegraf

yum/apt Repositories:

There is a yum/apt repo available for the whole InfluxData stack, see here for instructions on setting up the repo. Once it is configured, you will be able to use this repo to install & update telegraf.

Linux tarballs:

Latest:

• http://get.influxdb.org/telegraf/telegraf-0.11.1-1_linux_amd64.tar.gz
• http://get.influxdb.org/telegraf/telegraf-0.11.1-1_linux_i386.tar.gz
• http://get.influxdb.org/telegraf/telegraf-0.11.1-1_linux_armhf.tar.gz

tarball Instructions:

To install the full directory structure with config file, run:

sudo tar -C / -zxvf ./telegraf-0.11.1-1_linux_amd64.tar.gz

To extract only the binary, run:

tar -zxvf telegraf-0.11.1-1_linux_amd64.tar.gz --strip-components=3 ./usr/bin/telegraf

FreeBSD tarball:

Latest:

• http://get.influxdb.org/telegraf/telegraf-0.11.1-1_freebsd_amd64.tar.gz

tarball Instructions:

See linux instructions above.

Ansible Role:

Ansible role: https://github.com/rossmcdonald/telegraf

OSX via Homebrew:

brew update
brew install telegraf

Windows Binaries (EXPERIMENTAL)

Latest:

• http://get.influxdb.org/telegraf/telegraf-0.11.1-1_windows_amd64.zip
• http://get.influxdb.org/telegraf/telegraf-0.11.1-1_windows_i386.zip

From Source:

Telegraf manages dependencies via gdm, which gets installed via the Makefile if you don't have it already. You also must build with golang version 1.5+.

1. Install Go
2. Setup your GOPATH
3. Run go get github.com/influxdata/telegraf
4. Run cd $GOPATH/src/github.com/influxdata/telegraf
5. Run make

How to use it:

$ telegraf -help
Telegraf, The plugin-driven server agent for collecting and reporting metrics.

Usage:

  telegraf <flags>

The flags are:

  -config <file>     configuration file to load
  -test              gather metrics once, print them to stdout, and exit
  -sample-config     print out full sample configuration to stdout
  -config-directory  directory containing additional *.conf files
  -input-filter      filter the input plugins to enable, separator is :
  -output-filter     filter the output plugins to enable, separator is :
  -usage             print usage for a plugin, ie, 'telegraf -usage mysql'
  -debug             print metrics as they're generated to stdout
  -quiet             run in quiet mode
  -version           print the version to stdout

Examples:

  # generate a telegraf config file:
  telegraf -sample-config > telegraf.conf

  # generate config with only cpu input & influxdb output plugins defined
  telegraf -sample-config -input-filter cpu -output-filter influxdb

  # run a single telegraf collection, outputing metrics to stdout
  telegraf -config telegraf.conf -test

  # run telegraf with all plugins defined in config file
  telegraf -config telegraf.conf

  # run telegraf, enabling the cpu & memory input, and influxdb output plugins
  telegraf -config telegraf.conf -input-filter cpu:mem -output-filter influxdb

Configuration

See the configuration guide for a rundown of the more advanced configuration options.

Supported Input Plugins

Telegraf currently has support for collecting metrics from many sources. For more information on each, please look at the directory of the same name in plugins/inputs.

Currently implemented sources:

• aerospike
• apache
• bcache
• couchbase
• couchdb
• disque
• dns query time
• docker
• dovecot
• elasticsearch
• exec (generic executable plugin, support JSON, influx, graphite and nagios)
• haproxy
• httpjson (generic JSON-emitting http service plugin)
• influxdb
• jolokia
• leofs
• lustre2
• mailchimp
• memcached
• mesos
• mongodb
• mysql
• net_response
• nginx
• nsq
• ntpq
• phpfpm
• phusion passenger
• ping
• postgresql
• postgresql_extensible
• powerdns
• procstat
• prometheus
• puppetagent
• rabbitmq
• raindrops
• redis
• rethinkdb
• riak
• sensors (only available if built from source)
• snmp
• sql server (microsoft)
• twemproxy
• zfs
• zookeeper
• win_perf_counters (windows performance counters)
• system
  • cpu
  • mem
  • net
  • netstat
  • disk
  • diskio
  • swap
  • processes
  • kernel (/proc/stat)

Telegraf can also collect metrics via the following service plugins:

• statsd
• udp_listener
• tcp_listener
• mqtt_consumer
• kafka_consumer
• nats_consumer
• github_webhooks

We'll be adding support for many more over the coming months. Read on if you want to add support for another service or third-party API.

Supported Output Plugins

• influxdb
• amon
• amqp
• aws kinesis
• aws cloudwatch
• datadog
• graphite
• kafka
• librato
• mqtt
• nsq
• opentsdb
• prometheus
• riemann

Contributing

Please see the contributing guide for details on contributing a plugin to Telegraf.

Documentation

Index

• type Accumulator
• type Input
• type Metric
  • func NewMetric(name string, tags map[string]string, fields map[string]interface{}, ...) (Metric, error)
• type Output
• type ServiceInput
• type ServiceOutput

Types

type Accumulator

type Accumulator interface {
	// Create a point with a value, decorating it with tags
	// NOTE: tags is expected to be owned by the caller, don't mutate
	// it after passing to Add.
	Add(measurement string,
		value interface{},
		tags map[string]string,
		t ...time.Time)

	AddFields(measurement string,
		fields map[string]interface{},
		tags map[string]string,
		t ...time.Time)

	Debug() bool
	SetDebug(enabled bool)
}

type Input

type Input interface {
	// SampleConfig returns the default configuration of the Input
	SampleConfig() string

	// Description returns a one-sentence description on the Input
	Description() string

	// Gather takes in an accumulator and adds the metrics that the Input
	// gathers. This is called every "interval"
	Gather(Accumulator) error
}

type Metric

type Metric interface {
	// Name returns the measurement name of the metric
	Name() string

	// Name returns the tags associated with the metric
	Tags() map[string]string

	// Time return the timestamp for the metric
	Time() time.Time

	// UnixNano returns the unix nano time of the metric
	UnixNano() int64

	// Fields returns the fields for the metric
	Fields() map[string]interface{}

	// String returns a line-protocol string of the metric
	String() string

	// PrecisionString returns a line-protocol string of the metric, at precision
	PrecisionString(precison string) string

	// Point returns a influxdb client.Point object
	Point() *client.Point
}

func NewMetric

func NewMetric(
	name string,
	tags map[string]string,
	fields map[string]interface{},
	t ...time.Time,
) (Metric, error)

NewMetric returns a metric with the given timestamp. If a timestamp is not given, then data is sent to the database without a timestamp, in which case the server will assign local time upon reception. NOTE: it is recommended to send data with a timestamp.

type Output

type Output interface {
	// Connect to the Output
	Connect() error
	// Close any connections to the Output
	Close() error
	// Description returns a one-sentence description on the Output
	Description() string
	// SampleConfig returns the default configuration of the Output
	SampleConfig() string
	// Write takes in group of points to be written to the Output
	Write(metrics []Metric) error
}

type ServiceInput

type ServiceInput interface {
	// SampleConfig returns the default configuration of the Input
	SampleConfig() string

	// Description returns a one-sentence description on the Input
	Description() string

	// Gather takes in an accumulator and adds the metrics that the Input
	// gathers. This is called every "interval"
	Gather(Accumulator) error

	// Start starts the ServiceInput's service, whatever that may be
	Start(Accumulator) error

	// Stop stops the services and closes any necessary channels and connections
	Stop()
}

type ServiceOutput

type ServiceOutput interface {
	// Connect to the Output
	Connect() error
	// Close any connections to the Output
	Close() error
	// Description returns a one-sentence description on the Output
	Description() string
	// SampleConfig returns the default configuration of the Output
	SampleConfig() string
	// Write takes in group of points to be written to the Output
	Write(metrics []Metric) error
	// Start the "service" that will provide an Output
	Start() error
	// Stop the "service" that will provide an Output
	Stop()
}