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 . For an example configuration referencet from local or remote services.

Telegraf is plugin-driven and has the concept of 4 distinct plugins:

1. Input Plugins collect metrics from the system, services, or 3rd party APIs
2. Processor Plugins transform, decorate, and/or filter metrics
3. Aggregator Plugins create aggregate metrics (e.g. mean, min, max, quantiles, etc.)
4. 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.

Contributing

There are many ways to contribute:

• Fix and report bugs
• Improve documentation
• Review code and feature proposals
• Answer questions on github and on the Community Site
• Contribute plugins

Installation:

You can download the binaries directly from the downloads page or from the releases section.

Ansible Role:

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

From Source:

Telegraf requires golang version 1.8+, the Makefile requires GNU make.

Dependencies are managed with gdm, which is installed by the Makefile if you don't have it already.

1. Install Go
2. Setup your GOPATH
3. Run go get -d github.com/influxdata/telegraf
4. Run cd $GOPATH/src/github.com/influxdata/telegraf
5. Run make

Nightly Builds

These builds are generated from the master branch:

• telegraf_nightly_amd64.deb
• telegraf_nightly_arm64.deb
• telegraf-nightly.arm64.rpm
• telegraf_nightly_armel.deb
• telegraf-nightly.armel.rpm
• telegraf_nightly_armhf.deb
• telegraf-nightly.armv6hl.rpm
• telegraf-nightly_freebsd_amd64.tar.gz
• telegraf-nightly_freebsd_i386.tar.gz
• telegraf_nightly_i386.deb
• telegraf-nightly.i386.rpm
• telegraf-nightly_linux_amd64.tar.gz
• telegraf-nightly_linux_arm64.tar.gz
• telegraf-nightly_linux_armel.tar.gz
• telegraf-nightly_linux_armhf.tar.gz
• telegraf-nightly_linux_i386.tar.gz
• telegraf-nightly_linux_s390x.tar.gz
• telegraf_nightly_s390x.deb
• telegraf-nightly.s390x.rpm
• telegraf-nightly_windows_amd64.zip
• telegraf-nightly_windows_i386.zip
• telegraf-nightly.x86_64.rpm
• telegraf-static-nightly_linux_amd64.tar.gz

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

• aerospike
• amqp_consumer (rabbitmq)
• apache
• aws cloudwatch
• bcache
• bond
• cassandra (deprecated, use jolokia2)
• ceph
• cgroup
• chrony
• consul
• conntrack
• couchbase
• couchdb
• DC/OS
• disque
• dmcache
• dns query time
• docker
• dovecot
• elasticsearch
• exec (generic executable plugin, support JSON, influx, graphite and nagios)
• fail2ban
• fibaro
• filestat
• fluentd
• graylog
• haproxy
• hddtemp
• http (generic HTTP plugin, supports using input data formats)
• http_response
• httpjson (generic JSON-emitting http service plugin)
• internal
• influxdb
• interrupts
• ipmi_sensor
• iptables
• ipset
• jolokia (deprecated, use jolokia2)
• jolokia2 (java, cassandra, kafka)

• jti_openconfig_telemetry

• kapacitor
• kubernetes
• leofs
• lustre2
• mailchimp
• mcrouter
• memcached
• mesos
• minecraft
• mongodb
• mysql
• nats
• net_response
• nginx
• nginx_plus
• nsq
• nstat
• ntpq
• nvidia_smi
• openldap
• opensmtpd
• pf
• phpfpm
• phusion passenger
• ping
• postfix
• postgresql_extensible
• postgresql
• powerdns
• procstat
• prometheus (can be used for Caddy server)
• puppetagent
• rabbitmq
• raindrops
• redis
• rethinkdb
• riak
• salesforce
• sensors
• smart
• snmp
• snmp_legacy
• solr
• sql server (microsoft)
• teamspeak
• tomcat
• twemproxy
• unbound
• varnish
• zfs
• zookeeper
• win_perf_counters (windows performance counters)
• win_services
• sysstat
• system
  • cpu
  • mem
  • net
  • netstat
  • disk
  • diskio
  • swap
  • processes
  • kernel (/proc/stat)
  • kernel (/proc/vmstat)
  • linux_sysctl_fs (/proc/sys/fs)

Telegraf can also collect metrics via the following service plugins:

• http_listener
• kafka_consumer
• mqtt_consumer
• nats_consumer
• nsq_consumer
• logparser
• statsd
• socket_listener
• tail
• tcp_listener
• udp_listener
• webhooks
  • filestack
  • github
  • mandrill
  • papertrail
  • particle
  • rollbar
• zipkin

Telegraf is able to parse the following input data formats into metrics, these formats may be used with input plugins supporting the data_format option:

• InfluxDB Line Protocol
• JSON
• Graphite
• Value
• Nagios
• Collectd
• Dropwizard

Processor Plugins

• override
• printer
• topk

Aggregator Plugins

• basicstats
• minmax
• histogram

Output Plugins

• influxdb
• amon
• amqp (rabbitmq)
• aws kinesis
• aws cloudwatch
• cratedb
• datadog
• discard
• elasticsearch
• file
• graphite
• graylog
• http
• instrumental
• kafka
• librato
• mqtt
• nats
• nsq
• opentsdb
• prometheus
• riemann
• riemann_legacy
• socket_writer
• tcp
• udp
• wavefront