Go to file
Todd Persen d30bbde321 Merge pull request #11 from influxdb/fix-measurement
Fix `measurement` => `Measurement`
2015-06-17 21:44:20 -07:00
cmd/telegraf Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
plugins Update plugin registry from name -> measurement 2015-05-29 13:31:27 -07:00
testdata Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
testutil Fix `measurement` => `Measurement` 2015-06-17 21:43:45 -07:00
.gitignore Add release.sh and Vagrantfile 2015-04-07 09:31:28 -07:00
LICENSE Initial commit 2015-04-01 09:28:44 -07:00
PLUGINS.md Update name -> measurement 2015-05-29 13:25:48 -07:00
README.md issue 5 closed, updating readme 2015-05-26 12:33:08 -07:00
Vagrantfile Add release.sh and Vagrantfile 2015-04-07 09:31:28 -07:00
accumulator.go Update name -> measurement 2015-05-29 13:25:48 -07:00
agent.go Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
agent_test.go Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
config.go Update name -> measurement 2015-05-29 13:25:48 -07:00
release.sh Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
telegraf.toml Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00

README.md

Telegraf - A native agent for InfluxDB

Quickstart

  • Build from source or download telegraf (binaries forthcoming)
  • Run telegraf -sample-config > telegraf.toml to create an initial configuration
  • Edit the configuration to match your needs
  • Run telegraf -config telegraf.toml -test to output one full measurement sample to STDOUT
  • Run telegraf -config telegraf.toml to gather and send metrics to InfluxDB

Telegraf Options

Telegraf has a few options you can configure under the agent section of the config. If you don't see an agent section run telegraf -sample-config > telegraf.toml to create a valid initial configuration:

  • hostname: The hostname is passed as a tag. By default this will be the value retured by hostname on the machine running Telegraf. You can override that value here.
  • interval: How ofter to gather metrics. Uses a simple number + unit parser, ie "10s" for 10 seconds or "5m" for 5 minutes.
  • debug: Set to true to gather and send metrics to STDOUT as well as InfluxDB.

Plugin Options

There are 3 configuration options that are configurable per plugin:

  • pass: An array of strings that is used to filter metrics generated by the current plugin. Each string in the array is tested as a prefix against metrics and if it matches, the metric is emitted.
  • drop: The inverse of pass, if a metric matches, it is not emitted.
  • interval: How often to gather this metric. Normal plugins use a single global interval, but if one particular plugin should be run less or more often, you can configure that here.