64a832467e | ||
---|---|---|
cmd/telegraf | ||
etc | ||
internal | ||
outputs | ||
plugins | ||
scripts | ||
testutil | ||
.gitignore | ||
CHANGELOG.md | ||
CONFIGURATION.md | ||
CONTRIBUTING.md | ||
Godeps | ||
LICENSE | ||
LICENSE_OF_DEPENDENCIES.md | ||
Makefile | ||
README.md | ||
accumulator.go | ||
agent.go | ||
agent_test.go | ||
circle.yml |
README.md
Telegraf - A native agent for InfluxDB
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.
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).
We'll eagerly accept pull requests for new plugins 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.2.4_amd64.deb
- http://get.influxdb.org/telegraf/telegraf-0.2.4-1.x86_64.rpm
Package instructions:
- Telegraf binary is installed in
/opt/telegraf/telegraf
- Telegraf daemon configuration file is in
/etc/opt/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.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
Version 0.3.0 Beta
Version 0.3.0 will introduce many new breaking changes to Telegraf. For starters,
plugin measurements will be aggregated into fields. This means that there will no
longer be a cpu_usage_idle
measurement, there will be a cpu
measurement with
a usage_idle
field.
There will also be config file changes, meaning that your 0.2.x Telegraf config
files will no longer work properly. It is recommended that you use the
-sample-config
flag to generate a new config file to see what the changes are.
You can also read the
0.3.0 configuration guide
to see some of the new features and options available.
You can read more about the justifications for the aggregated measurements here, and a more detailed breakdown of the work here. Once we're closer to a full release, there will be a detailed blog post explaining all the changes.
- http://get.influxdb.org/telegraf/telegraf_0.3.0-beta2_amd64.deb
- http://get.influxdb.org/telegraf/telegraf-0.3.0_beta2-1.x86_64.rpm
- http://get.influxdb.org/telegraf/telegraf_linux_amd64_0.3.0-beta2.tar.gz
- http://get.influxdb.org/telegraf/telegraf_linux_386_0.3.0-beta2.tar.gz
- http://get.influxdb.org/telegraf/telegraf_linux_arm_0.3.0-beta2.tar.gz
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+.
- Install Go
- Setup your GOPATH
- Run
go get github.com/influxdb/telegraf
- Run
cd $GOPATH/src/github.com/influxdb/telegraf
- Run
make
How to use it:
- Run
telegraf -sample-config > telegraf.conf
to create an initial configuration. - Or run
telegraf -sample-config -filter cpu:mem -outputfilter influxdb > telegraf.conf
. to create a config file with only CPU and memory plugins defined, and InfluxDB output defined. - Edit the configuration to match your needs.
- Run
telegraf -config telegraf.conf -test
to output one full measurement sample to STDOUT. NOTE: you may want to run as the telegraf user if you are using the linux packagessudo -u telegraf telegraf -config telegraf.conf -test
- Run
telegraf -config telegraf.conf
to gather and send metrics to configured outputs. - Run
telegraf -config telegraf.conf -filter system:swap
. to run telegraf with only the system & swap plugins defined in the config.
Telegraf Options
Telegraf has a few options you can configure under the agent
section of the
config.
- hostname: The hostname is passed as a tag. By default this will be
the value returned by
hostname
on the machine running Telegraf. You can override that value here. - interval: How often to gather metrics. Uses a simple number + unit parser, e.g. "10s" for 10 seconds or "5m" for 5 minutes.
- debug: Set to true to gather and send metrics to STDOUT as well as InfluxDB.
Configuration
See the configuration guide for a rundown of the more advanced configuration options.
Supported Plugins
You can view usage instructions for each plugin by running
telegraf -usage <pluginname>
.
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
Supported Service Plugins
Telegraf can collect metrics via the following services:
- 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 Outputs
- influxdb
- nsq
- kafka
- datadog
- opentsdb
- amqp (rabbitmq)
- mqtt
- librato
- prometheus
- amon
- riemann
Contributing
Please see the contributing guide for details on contributing a plugin or output to Telegraf.