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:

NOTE: Telegraf 0.10.x is not backwards-compatible with previous versions of telegraf, both in the database layout and the configuration file. 0.2.x will continue to be supported, see below for download links.

TODO: link to blog post about 0.10.x changes.

Linux deb and rpm packages:

Latest:

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

0.2.x:

• http://get.influxdb.org/telegraf/telegraf_0.2.4_amd64.deb
• http://get.influxdb.org/telegraf/telegraf-0.2.4-1.x86_64.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

Linux binaries:

Latest:

• http://get.influxdb.org/telegraf/telegraf_linux_amd64_0.10.0.tar.gz
• http://get.influxdb.org/telegraf/telegraf_linux_386_0.10.0.tar.gz
• http://get.influxdb.org/telegraf/telegraf_linux_arm_0.10.0.tar.gz

0.2.x:

• http://get.influxdb.org/telegraf/telegraf_linux_amd64_0.2.4.tar.gz
• http://get.influxdb.org/telegraf/telegraf_linux_386_0.2.4.tar.gz
• http://get.influxdb.org/telegraf/telegraf_linux_arm_0.2.4.tar.gz

Binary instructions:

These are standalone binaries that can be unpacked and executed on any linux system. They can be unpacked and renamed in a location such as /usr/local/bin for convenience. A config file will need to be generated, see "How to use it" below.

OSX via Homebrew:

brew update
brew install telegraf

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.4+.

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

How to use it:

$ telegraf -help
Telegraf, The plugin-driven server agent for reporting metrics into InfluxDB

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'
  -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:

• aerospike
• apache
• bcache
• disque
• elasticsearch
• exec (generic JSON-emitting executable plugin)
• haproxy
• httpjson (generic JSON-emitting http service plugin)
• influxdb
• jolokia
• leofs
• lustre2
• mailchimp
• memcached
• mongodb
• mysql
• nginx
• phpfpm
• ping
• postgresql
• procstat
• prometheus
• puppetagent
• rabbitmq
• redis
• rethinkdb
• twemproxy
• zfs
• zookeeper
• system
  • cpu
  • mem
  • net
  • netstat
  • disk
  • diskio
  • swap

Telegraf can also collect metrics via the following service plugins:

• statsd
• kafka_consumer

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
• datadog
• kafka
• amazon kinesis
• librato
• mqtt
• nsq
• opentsdb
• prometheus
• riemann

Contributing

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

Documentation

Index

• type Accumulator
  • func NewAccumulator(inputConfig *config.InputConfig, points chan *client.Point) Accumulator
• type Agent
  • func NewAgent(config *config.Config) (*Agent, error)
  • func (a *Agent) Close() error
  • func (a *Agent) Connect() error
  • func (a *Agent) Run(shutdown chan struct{}) error
  • func (a *Agent) Test() error

Types

type Accumulator

type Accumulator interface {
	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)

	SetDefaultTags(tags map[string]string)
	AddDefaultTag(key, value string)

	Prefix() string
	SetPrefix(prefix string)

	Debug() bool
	SetDebug(enabled bool)
}

func NewAccumulator

func NewAccumulator(
	inputConfig *config.InputConfig,
	points chan *client.Point,
) Accumulator

type Agent

type Agent struct {
	Config *config.Config
}

Agent runs telegraf and collects data based on the given config

func NewAgent

func NewAgent(config *config.Config) (*Agent, error)

NewAgent returns an Agent struct based off the given Config

func (*Agent) Close

func (a *Agent) Close() error

Close closes the connection to all configured outputs

func (*Agent) Connect

func (a *Agent) Connect() error

Connect connects to all configured outputs

func (*Agent) Run

func (a *Agent) Run(shutdown chan struct{}) error

Run runs the agent daemon, gathering every Interval

func (*Agent) Test

func (a *Agent) Test() error

Test verifies that we can 'Gather' from all inputs with their configured Config struct