telegraf

package module
Version: v0.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 27, 2016 License: MIT Imports: 15 Imported by: 0

README

Telegraf Circle CI

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.

For more details on the differences between Telegraf 0.2.x and 0.10.x, see the release blog post.

Linux deb and rpm packages:

Latest:

0.2.x:

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

Latest:

0.2.x:

tarball instructions:

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

sudo tar -C / -xvf ./telegraf-v0.10.1-1_linux_amd64.tar.gz

To extract only the binary, run:

tar -zxvf telegraf-v0.10.1-1_linux_amd64.tar.gz --strip-components=3 ./usr/bin/telegraf
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.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
  • disque
  • docker
  • elasticsearch
  • exec (generic JSON-emitting executable plugin)
  • haproxy
  • httpjson (generic JSON-emitting http service plugin)
  • influxdb
  • jolokia
  • leofs
  • lustre2
  • mailchimp
  • memcached
  • mongodb
  • mysql
  • nginx
  • nsq
  • phpfpm
  • phusion passenger
  • ping
  • postgresql
  • procstat
  • prometheus
  • puppetagent
  • rabbitmq
  • redis
  • rethinkdb
  • sql server (microsoft)
  • twemproxy
  • zfs
  • zookeeper
  • sensors
  • snmp
  • system
    • cpu
    • mem
    • net
    • netstat
    • disk
    • diskio
    • swap

Telegraf can also collect metrics via the following service plugins:

  • statsd
  • kafka_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 or output to Telegraf.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Accumulator added in v0.2.0

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 added in v0.2.0

func NewAccumulator(
	inputConfig *models.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 added in v0.1.4

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL