68f132001f
For gather data from the shared memory exposed by running processes. |
||
---|---|---|
.github | ||
agent | ||
cmd/telegraf | ||
docs | ||
etc | ||
filter | ||
internal | ||
logger | ||
plugins | ||
scripts | ||
testutil | ||
.gitattributes | ||
.gitignore | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
Godeps | ||
Godeps_windows | ||
LICENSE | ||
Makefile | ||
README.md | ||
accumulator.go | ||
aggregator.go | ||
circle.yml | ||
input.go | ||
metric.go | ||
metric_test.go | ||
output.go | ||
processor.go |
README.md
Telegraf
Telegraf is an agent written in Go for collecting, processing, aggregating, and writing metrics.
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).
Telegraf is plugin-driven and has the concept of 4 distinct plugins:
- Input Plugins collect metrics from the system, services, or 3rd party APIs
- Processor Plugins transform, decorate, and/or filter metrics
- Aggregator Plugins create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
- Output Plugins write metrics to various destinations
For more information on Processor and Aggregator plugins please read this.
New 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:
Linux deb and rpm Packages:
Latest:
- https://dl.influxdata.com/telegraf/releases/telegraf_1.0.1_amd64.deb
- https://dl.influxdata.com/telegraf/releases/telegraf-1.0.1.x86_64.rpm
Latest (arm):
- https://dl.influxdata.com/telegraf/releases/telegraf_1.0.1_armhf.deb
- https://dl.influxdata.com/telegraf/releases/telegraf-1.0.1.armhf.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
yum/apt Repositories:
There is a yum/apt repo available for the whole InfluxData stack, see here for instructions on setting up the repo. Once it is configured, you will be able to use this repo to install & update telegraf.
Linux tarballs:
Latest:
- https://dl.influxdata.com/telegraf/releases/telegraf-1.0.1_linux_amd64.tar.gz
- https://dl.influxdata.com/telegraf/releases/telegraf-1.0.1_linux_i386.tar.gz
- https://dl.influxdata.com/telegraf/releases/telegraf-1.0.1_linux_armhf.tar.gz
FreeBSD tarball:
Latest:
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:
See usage with:
telegraf --help
Generate a telegraf config file:
telegraf config > telegraf.conf
Generate config with only cpu input & influxdb output plugins defined
telegraf --input-filter cpu --output-filter influxdb config
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.
Input Plugins
- aws cloudwatch
- aerospike
- apache
- bcache
- cassandra
- ceph
- chrony
- consul
- conntrack
- couchbase
- couchdb
- disque
- dns query time
- docker
- dovecot
- elasticsearch
- exec (generic executable plugin, support JSON, influx, graphite and nagios)
- filestat
- haproxy
- hddtemp
- hsperfdata (Hostpot JVMs)
- http_response
- httpjson (generic JSON-emitting http service plugin)
- influxdb
- ipmi_sensor
- iptables
- jolokia
- leofs
- lustre2
- mailchimp
- memcached
- mesos
- mongodb
- mysql
- net_response
- nginx
- nsq
- nstat
- ntpq
- phpfpm
- phusion passenger
- ping
- postgresql
- postgresql_extensible
- powerdns
- procstat
- prometheus
- puppetagent
- rabbitmq
- raindrops
- redis
- rethinkdb
- riak
- sensors
- snmp
- snmp_legacy
- sql server (microsoft)
- twemproxy
- varnish
- zfs
- zookeeper
- win_perf_counters (windows performance counters)
- sysstat
- system
- cpu
- mem
- net
- netstat
- disk
- diskio
- swap
- processes
- kernel (/proc/stat)
- kernel (/proc/vmstat)
Telegraf can also collect metrics via the following service plugins:
- http_listener
- kafka_consumer
- mqtt_consumer
- nats_consumer
- nsq_consumer
- logparser
- statsd
- tail
- tcp_listener
- udp_listener
- webhooks
Processor Plugins
Aggregator Plugins
Output Plugins
- influxdb
- amon
- amqp
- aws kinesis
- aws cloudwatch
- datadog
- file
- graphite
- graylog
- instrumental
- kafka
- librato
- mqtt
- nats
- nsq
- opentsdb
- prometheus
- riemann
Contributing
Please see the contributing guide for details on contributing a plugin to Telegraf.