2016-01-07 22:21:10 +00:00
|
|
|
# Telegraf [![Circle CI](https://circleci.com/gh/influxdata/telegraf.svg?style=svg)](https://circleci.com/gh/influxdata/telegraf)
|
2015-05-20 05:26:13 +00:00
|
|
|
|
2015-08-06 20:00:14 +00:00
|
|
|
Telegraf is an agent written in Go for collecting metrics from the system it's
|
2016-01-07 22:21:10 +00:00
|
|
|
running on, or from other services, and writing them into InfluxDB or other
|
|
|
|
[outputs](https://github.com/influxdata/telegraf#supported-output-plugins).
|
2015-06-19 16:34:27 +00:00
|
|
|
|
2015-08-06 20:00:14 +00:00
|
|
|
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
|
2015-09-09 17:00:19 +00:00
|
|
|
from well known services (like Hadoop, Postgres, or Redis) and third party
|
2015-08-06 20:00:14 +00:00
|
|
|
APIs (like Mailchimp, AWS CloudWatch, or Google Analytics).
|
2015-06-19 16:34:27 +00:00
|
|
|
|
2016-01-07 22:21:10 +00:00
|
|
|
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](CONTRIBUTING.md) for instructions on writing
|
|
|
|
new plugins.
|
2015-06-19 16:34:27 +00:00
|
|
|
|
2015-09-09 17:00:19 +00:00
|
|
|
## Installation:
|
2015-05-20 05:26:13 +00:00
|
|
|
|
2016-01-14 17:20:01 +00:00
|
|
|
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.
|
2016-01-07 22:21:10 +00:00
|
|
|
|
2016-01-14 17:20:01 +00:00
|
|
|
For more details on the differences between Telegraf 0.2.x and 0.10.x, see
|
|
|
|
the [release blog post](https://influxdata.com/blog/announcing-telegraf-0-10-0/).
|
2016-01-07 22:21:10 +00:00
|
|
|
|
2015-09-09 17:00:19 +00:00
|
|
|
### Linux deb and rpm packages:
|
|
|
|
|
2015-08-20 21:18:45 +00:00
|
|
|
Latest:
|
2016-01-11 20:33:19 +00:00
|
|
|
* http://get.influxdb.org/telegraf/telegraf_0.10.0-1_amd64.deb
|
2016-01-09 00:22:23 +00:00
|
|
|
* http://get.influxdb.org/telegraf/telegraf-0.10.0-1.x86_64.rpm
|
2016-01-07 22:21:10 +00:00
|
|
|
|
|
|
|
0.2.x:
|
2015-12-07 19:22:52 +00:00
|
|
|
* http://get.influxdb.org/telegraf/telegraf_0.2.4_amd64.deb
|
|
|
|
* http://get.influxdb.org/telegraf/telegraf-0.2.4-1.x86_64.rpm
|
2015-09-09 17:00:19 +00:00
|
|
|
|
|
|
|
##### Package instructions:
|
|
|
|
|
2016-01-08 22:07:44 +00:00
|
|
|
* Telegraf binary is installed in `/usr/bin/telegraf`
|
|
|
|
* Telegraf daemon configuration file is in `/etc/telegraf/telegraf.conf`
|
2015-09-09 17:00:19 +00:00
|
|
|
* 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:
|
2016-01-11 20:33:19 +00:00
|
|
|
* http://get.influxdb.org/telegraf/telegraf-0.10.0_linux_amd64.tar.gz
|
|
|
|
* http://get.influxdb.org/telegraf/telegraf-0.10.0_linux_386.tar.gz
|
|
|
|
* http://get.influxdb.org/telegraf/telegraf-0.10.0_linux_arm.tar.gz
|
2016-01-07 22:21:10 +00:00
|
|
|
|
|
|
|
0.2.x:
|
2015-12-07 19:22:52 +00:00
|
|
|
* 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
|
2015-09-04 20:12:50 +00:00
|
|
|
|
2015-09-09 17:00:19 +00:00
|
|
|
##### 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.
|
2015-06-19 16:34:27 +00:00
|
|
|
|
2015-06-20 01:53:35 +00:00
|
|
|
### OSX via Homebrew:
|
|
|
|
|
|
|
|
```
|
|
|
|
brew update
|
|
|
|
brew install telegraf
|
|
|
|
```
|
|
|
|
|
2015-08-18 16:16:59 +00:00
|
|
|
### From Source:
|
|
|
|
|
2015-12-08 23:18:23 +00:00
|
|
|
Telegraf manages dependencies via [gdm](https://github.com/sparrc/gdm),
|
|
|
|
which gets installed via the Makefile
|
2016-01-19 16:37:17 +00:00
|
|
|
if you don't have it already. You also must build with golang version 1.5+.
|
2015-08-26 00:16:01 +00:00
|
|
|
|
|
|
|
1. [Install Go](https://golang.org/doc/install)
|
|
|
|
2. [Setup your GOPATH](https://golang.org/doc/code.html#GOPATH)
|
2016-01-20 18:57:35 +00:00
|
|
|
3. Run `go get github.com/influxdata/telegraf`
|
|
|
|
4. Run `cd $GOPATH/src/github.com/influxdata/telegraf`
|
2015-10-19 21:26:08 +00:00
|
|
|
5. Run `make`
|
2015-08-18 16:16:59 +00:00
|
|
|
|
2015-06-20 01:53:35 +00:00
|
|
|
### How to use it:
|
|
|
|
|
2016-01-07 22:21:10 +00:00
|
|
|
```console
|
|
|
|
$ telegraf -help
|
2016-01-15 19:25:56 +00:00
|
|
|
Telegraf, The plugin-driven server agent for collecting and reporting metrics.
|
2016-01-07 22:21:10 +00:00
|
|
|
|
|
|
|
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'
|
2016-01-15 19:25:56 +00:00
|
|
|
-debug print metrics as they're generated to stdout
|
|
|
|
-quiet run in quiet mode
|
2016-01-07 22:21:10 +00:00
|
|
|
-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
|
|
|
|
```
|
2015-05-20 05:26:13 +00:00
|
|
|
|
2015-12-11 20:07:32 +00:00
|
|
|
## Configuration
|
2015-12-01 14:15:28 +00:00
|
|
|
|
2015-12-11 20:07:32 +00:00
|
|
|
See the [configuration guide](CONFIGURATION.md) for a rundown of the more advanced
|
|
|
|
configuration options.
|
2015-11-24 21:22:11 +00:00
|
|
|
|
2016-01-07 22:21:10 +00:00
|
|
|
## Supported Input Plugins
|
2015-08-13 19:44:41 +00:00
|
|
|
|
2016-01-14 19:34:22 +00:00
|
|
|
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:
|
2015-08-13 19:44:41 +00:00
|
|
|
|
2015-10-22 00:08:43 +00:00
|
|
|
* aerospike
|
2015-09-04 23:05:50 +00:00
|
|
|
* apache
|
2015-10-19 17:38:16 +00:00
|
|
|
* bcache
|
2015-08-20 20:40:23 +00:00
|
|
|
* disque
|
2016-01-20 23:21:19 +00:00
|
|
|
* docker
|
2015-08-20 20:40:23 +00:00
|
|
|
* elasticsearch
|
2015-08-24 20:08:47 +00:00
|
|
|
* exec (generic JSON-emitting executable plugin)
|
2015-08-20 20:40:23 +00:00
|
|
|
* haproxy
|
|
|
|
* httpjson (generic JSON-emitting http service plugin)
|
2015-12-18 23:21:39 +00:00
|
|
|
* influxdb
|
2015-12-11 20:07:32 +00:00
|
|
|
* jolokia
|
2015-08-20 20:40:23 +00:00
|
|
|
* leofs
|
|
|
|
* lustre2
|
2015-12-01 21:05:24 +00:00
|
|
|
* mailchimp
|
2015-08-20 20:40:23 +00:00
|
|
|
* memcached
|
|
|
|
* mongodb
|
|
|
|
* mysql
|
|
|
|
* nginx
|
2016-01-17 00:29:02 +00:00
|
|
|
* nsq
|
2015-10-16 12:13:09 +00:00
|
|
|
* phpfpm
|
2016-01-15 01:09:38 +00:00
|
|
|
* phusion passenger
|
2015-09-04 23:05:50 +00:00
|
|
|
* ping
|
2015-08-20 20:40:23 +00:00
|
|
|
* postgresql
|
2015-10-07 18:31:49 +00:00
|
|
|
* procstat
|
2015-08-20 20:40:23 +00:00
|
|
|
* prometheus
|
2015-10-16 17:48:33 +00:00
|
|
|
* puppetagent
|
2015-08-20 20:40:23 +00:00
|
|
|
* rabbitmq
|
|
|
|
* redis
|
|
|
|
* rethinkdb
|
2015-11-12 16:25:42 +00:00
|
|
|
* twemproxy
|
2015-11-09 12:37:00 +00:00
|
|
|
* zfs
|
2015-10-14 23:53:47 +00:00
|
|
|
* zookeeper
|
2016-01-15 12:22:04 +00:00
|
|
|
* sensors
|
2016-01-20 20:11:28 +00:00
|
|
|
* snmp
|
2015-09-04 23:05:50 +00:00
|
|
|
* system
|
|
|
|
* cpu
|
|
|
|
* mem
|
|
|
|
* net
|
2015-10-14 23:53:47 +00:00
|
|
|
* netstat
|
2015-09-04 23:05:50 +00:00
|
|
|
* disk
|
2015-12-11 20:07:32 +00:00
|
|
|
* diskio
|
2015-09-04 23:05:50 +00:00
|
|
|
* swap
|
2015-08-13 19:44:41 +00:00
|
|
|
|
2016-01-08 22:07:44 +00:00
|
|
|
Telegraf can also collect metrics via the following service plugins:
|
2015-10-07 22:11:52 +00:00
|
|
|
|
|
|
|
* statsd
|
2015-11-16 20:12:45 +00:00
|
|
|
* kafka_consumer
|
2015-10-07 22:11:52 +00:00
|
|
|
|
2015-08-13 19:44:41 +00:00
|
|
|
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.
|
|
|
|
|
2016-01-07 22:21:10 +00:00
|
|
|
## Supported Output Plugins
|
2015-06-19 16:38:31 +00:00
|
|
|
|
2015-08-28 16:18:46 +00:00
|
|
|
* influxdb
|
2016-01-08 22:07:44 +00:00
|
|
|
* amon
|
|
|
|
* amqp
|
2016-01-18 19:39:14 +00:00
|
|
|
* aws kinesis
|
|
|
|
* aws cloudwatch
|
2015-08-28 16:18:46 +00:00
|
|
|
* datadog
|
2016-01-17 00:29:02 +00:00
|
|
|
* graphite
|
2016-01-08 22:07:44 +00:00
|
|
|
* kafka
|
2015-10-26 18:31:21 +00:00
|
|
|
* librato
|
2016-01-08 22:07:44 +00:00
|
|
|
* mqtt
|
|
|
|
* nsq
|
|
|
|
* opentsdb
|
2015-10-28 22:19:13 +00:00
|
|
|
* prometheus
|
2015-10-22 21:50:19 +00:00
|
|
|
* riemann
|
2015-06-19 16:38:31 +00:00
|
|
|
|
2015-08-28 16:18:46 +00:00
|
|
|
## Contributing
|
2015-06-19 16:38:31 +00:00
|
|
|
|
2015-08-28 16:18:46 +00:00
|
|
|
Please see the
|
2015-09-09 17:00:19 +00:00
|
|
|
[contributing guide](CONTRIBUTING.md)
|
2015-10-19 21:26:08 +00:00
|
|
|
for details on contributing a plugin or output to Telegraf.
|