Go to file
Evan Phoenix 92acd88523 Merge pull request #7 from influxdb/beckettsean-patch-3
use localhost by default
2015-05-22 19:06:08 -07:00
cmd/telegraf Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
plugins Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
testdata Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
testutil Add postgresql plugin 2015-05-18 11:53:17 -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 Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -07:00
README.md Update README.md 2015-05-22 17:17:43 -07:00
Vagrantfile Add release.sh and Vagrantfile 2015-04-07 09:31:28 -07:00
accumulator.go Tivan is dead, long live Telegraf. Fixes #3 2015-05-22 16:45:14 -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 use localhost by default 2015-05-22 17:09:20 -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 hostname of 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: currently non-functional. Run telegraf -config telegraf.toml -debug to gather and send metrics to InfluxDB and to STDOUT for debugging purposes

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.