Last built 1 year ago using go version go1.5.1 linux/amd64 and 223 seconds of time
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.
service telegraf [action]
systemctl [action] telegraf
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
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.
brew update brew install telegraf
Telegraf manages dependencies via
godep, which gets installed via the Makefile
if you don’t have it already. You also must build with golang version 1.4+.
go get github.com/influxdb/telegraf
telegraf -sample-config > telegraf.confto create an initial configuration.
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.
telegraf -config telegraf.conf -testto output one full measurement sample to STDOUT. NOTE: you may want to run as the telegraf user if you are using the linux packages
sudo -u telegraf telegraf -config telegraf.conf -test
telegraf -config telegraf.confto gather and send metrics to configured outputs.
telegraf -config telegraf.conf -filter system:swap. to run telegraf with only the system & swap plugins defined in the config.
Telegraf has a few options you can configure under the
agent section of the
hostnameon the machine running Telegraf. You can override that value here.
There are 5 configuration options that are configurable per plugin:
This is a full working config that will output CPU data to an InfluxDB instance
at 192.168.59.103:8086, tagging measurements with dc=“denver-1”. It will output
measurements at a 10s interval and will collect per-cpu data, dropping any
measurements which begin with
[tags] dc = "denver-1" [agent] interval = "10s" # OUTPUTS [outputs] [[outputs.influxdb]] url = "http://192.168.59.103:8086" # required. database = "telegraf" # required. precision = "s" # PLUGINS [plugins] [[plugins.cpu]] percpu = true totalcpu = false drop = ["cpu_time*"]
Below is how to configure
[plugins] [[plugins.cpu]] percpu = true totalcpu = false drop = ["cpu_time"] # Don't collect CPU data for cpu6 & cpu7 [plugins.cpu.tagdrop] cpu = [ "cpu6", "cpu7" ] [[plugins.disk]] [plugins.disk.tagpass] # tagpass conditions are OR, not AND. # If the (filesystem is ext4 or xfs) OR (the path is /opt or /home) # then the metric passes fstype = [ "ext4", "xfs" ] # Globs can also be used on the tag values path = [ "/opt", "/home*" ]
Below is how to configure
# Drop all metrics for guest CPU usage [[plugins.cpu]] drop = [ "cpu_usage_guest" ] # Only store inode related metrics for disks [[plugins.disk]] pass = [ "disk_inodes*" ]
Additional plugins (or outputs) of the same type can be specified, just define more instances in the config file:
[[plugins.cpu]] percpu = false totalcpu = true [[plugins.cpu]] percpu = true totalcpu = false drop = ["cpu_time*"]
You can view usage instructions for each plugin by running
telegraf -usage <pluginname>.
Telegraf currently has support for collecting metrics from:
Telegraf can collect metrics via the following services:
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.
Telegraf also supports specifying multiple output sinks to send data to,
configuring each output sink is different, but examples can be
found by running
Outputs also support the same configurable options as plugins (pass, drop, tagpass, tagdrop), added in 0.2.4
[[outputs.influxdb]] urls = [ "http://localhost:8086" ] database = "telegraf" precision = "s" # Drop all measurements that start with "aerospike" drop = ["aerospike*"] [[outputs.influxdb]] urls = [ "http://localhost:8086" ] database = "telegraf-aerospike-data" precision = "s" # Only accept aerospike data: pass = ["aerospike*"] [[outputs.influxdb]] urls = [ "http://localhost:8086" ] database = "telegraf-cpu0-data" precision = "s" # Only store measurements where the tag "cpu" matches the value "cpu0" [outputs.influxdb.tagpass] cpu = ["cpu0"]
Please see the contributing guide for details on contributing a plugin or output to Telegraf.