Go to file
Evan Phoenix 75439f9185 Merge pull request #2 from influxdb/beckettsean-patch-2
clarifying readme
2015-05-22 16:16:28 -07:00
cmd/tivan Add pass, drop, and interval to the plugin options 2015-05-19 22:19:32 -07:00
plugins Add rule about 'localhost' 2015-05-18 16:08:22 -07:00
testdata Add redis plugin 2015-04-07 11:54:21 -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 Add docs about how to use the Accumulator 2015-05-20 09:16:54 -07:00
README.md clarifying readme 2015-05-22 16:14:41 -07:00
Vagrantfile Add release.sh and Vagrantfile 2015-04-07 09:31:28 -07:00
accumulator.go Add pass, drop, and interval to the plugin options 2015-05-19 22:19:32 -07:00
agent.go Actually write the points 2015-05-20 17:11:43 -07:00
agent_test.go Switch plugin API to use an accumulator 2015-04-06 09:32:10 -07:00
config.go Clearify some required config parameters 2015-05-21 09:45:09 -07:00
release.sh Add release.sh and Vagrantfile 2015-04-07 09:31:28 -07:00
tivan.toml Add rule about 'localhost' 2015-05-18 16:08:22 -07:00

README.md

Tivan - A native agent for InfluxDB

Quickstart

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

Tivan Options

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

  • hostname: The hostname is passed as a tag. By default this should be set to the name of the machine running Tivan. You can override that behavior 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 tivan -config tivan.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.