1388e2cf92
It is not possible to encode a measurement, tag, or field whose last character is a backslash due to it being an unescapable character. Because the tight coupling between line protocol and the internal metric model, prevent metrics like this from being created. Measurements with a trailing slash are not allowed and the point will be dropped. Tags and fields with a trailing a slash will be dropped from the point. |
||
|---|---|---|
| .github | ||
| agent | ||
| cmd/telegraf | ||
| docs | ||
| etc | ||
| filter | ||
| internal | ||
| logger | ||
| metric | ||
| plugins | ||
| scripts | ||
| selfstat | ||
| testutil | ||
| .gitattributes | ||
| .gitignore | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| Godeps | ||
| Godeps_windows | ||
| LICENSE | ||
| Makefile | ||
| README.md | ||
| accumulator.go | ||
| aggregator.go | ||
| circle.yml | ||
| input.go | ||
| metric.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.
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 either download the binaries directly from the downloads page.
A few alternate installs are available here as well:
FreeBSD tarball:
Latest:
Ansible Role:
Ansible role: https://github.com/rossmcdonald/telegraf
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.8+.
- 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
- aerospike
- amqp_consumer (rabbitmq)
- apache
- aws cloudwatch
- bcache
- cassandra
- ceph
- cgroup
- chrony
- consul
- conntrack
- couchbase
- couchdb
- disque
- dmcache
- dns query time
- docker
- dovecot
- elasticsearch
- exec (generic executable plugin, support JSON, influx, graphite and nagios)
- fail2ban
- filestat
- graylog
- haproxy
- hddtemp
- http_response
- httpjson (generic JSON-emitting http service plugin)
- internal
- influxdb
- interrupts
- ipmi_sensor
- iptables
- jolokia
- kapacitor
- kubernetes
- leofs
- lustre2
- mailchimp
- memcached
- mesos
- mongodb
- mysql
- net_response
- nginx
- nsq
- nstat
- ntpq
- phpfpm
- phusion passenger
- ping
- postgresql
- postgresql_extensible
- powerdns
- procstat
- prometheus (can be used for Caddy server)
- 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)
- 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
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: