dom

telegraf

Go to file

Cameron Sparr b2a4d4a018 Allow ssl option specification for httpjson plugin closes #769		2016-03-01 18:17:19 +00:00
agent	Add metric pass/drop filter	2016-02-22 12:11:33 -07:00
cmd/telegraf	Implementing generic parser plugins and documentation	2016-02-08 21:08:44 -07:00
docs	Change pass/drop to namepass/namedrop for outputs	2016-02-22 13:35:06 -07:00
etc	Support specifying influxdb retention policy	2016-02-29 18:10:32 +00:00
internal	Remove naoina/toml dependency, use influxdata/toml	2016-03-01 10:17:02 +00:00
plugins	Allow ssl option specification for httpjson plugin	2016-03-01 18:17:19 +00:00
scripts	Create a FreeBSD build	2016-03-01 09:38:58 +00:00
testutil	httpjson test real response from issue #729	2016-02-23 09:34:01 -07:00
.gitignore	Added a `build.py` script for compiling and packaging. Added post and pre install scripts to handle installation and upgrades in a cleaner way. Minor fixes to the init script and service unit file.	2016-01-08 15:28:33 -06:00
CHANGELOG.md	Allow ssl option specification for httpjson plugin	2016-03-01 18:17:19 +00:00
CONTRIBUTING.md	Seems to be a toml parse bug around triple pounds	2016-02-18 14:36:03 -07:00
Godeps	Remove naoina/toml dependency, use influxdata/toml	2016-03-01 10:17:02 +00:00
Godeps_windows	Experimental windows build process changes	2016-02-23 13:52:24 -07:00
LICENSE	Initial commit	2015-04-01 09:28:44 -07:00
Makefile	dns_query plugin fixups:	2016-02-21 16:33:04 -07:00
README.md	Add udp listener to readme list of plugins	2016-03-01 15:46:29 +00:00
accumulator.go	Create public models for telegraf metrics, accumlator, plugins	2016-01-27 15:42:50 -07:00
circle.yml	Turn GOGC on for packaging, use go 1.5.3	2016-02-21 10:41:46 -07:00
input.go	Flush based on buffer size rather than time	2016-02-16 22:25:22 -07:00
metric.go	Implementing generic parser plugins and documentation	2016-02-08 21:08:44 -07:00
metric_test.go	Implementing generic parser plugins and documentation	2016-02-08 21:08:44 -07:00
output.go	Throughout telegraf, use telegraf.Metric rather than client.Point	2016-01-27 23:47:32 -07:00

README.md

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.

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:

Latest (arm):

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

yum/apt Repositories:

There is a yum/apt repo available for the whole InfluxData stack, see here for instructions, replacing the influxdb package name with telegraf.

Linux tarballs:

Latest:

0.2.x:

tarball Instructions:

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

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

To extract only the binary, run:

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

Ansible Role:

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

OSX via Homebrew:

brew update
brew install telegraf

Windows Binaries (EXPERIMENTAL)

Latest:

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

Install Go
Setup your GOPATH
Run go get github.com/influxdata/telegraf
Run cd $GOPATH/src/github.com/influxdata/telegraf
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
couchdb
disque
dns query time
docker
dovecot
elasticsearch
exec (generic executable plugin, support JSON, influx and graphite)
haproxy
httpjson (generic JSON-emitting http service plugin)
influxdb
jolokia
leofs
lustre2
mailchimp
memcached
mesos
mongodb
mysql
net_response
nginx
nsq
phpfpm
phusion passenger
ping
postgresql
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

Telegraf can also collect metrics via the following service plugins:

statsd
udp 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.