Go to file
Evan Phoenix ebac4d8346 Start of a PLUGINS.md 2015-05-19 22:37:39 -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 Start of a PLUGINS.md 2015-05-19 22:37:39 -07:00
README.md Start of a README.md 2015-05-19 22:26:13 -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 Add pass, drop, and interval to the plugin options 2015-05-19 22:19:32 -07:00
agent_test.go Switch plugin API to use an accumulator 2015-04-06 09:32:10 -07:00
config.go Add pass, drop, and interval to the plugin options 2015-05-19 22:19:32 -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

  • Download tivan
  • 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 see what metrics are gather by your config
  • Run tivan -config tivan.toml to gather and send metrics

Tivan Options

Tivan has a few options you can configure under the agent section of the config:

  • hostname: The name of this machine. The hostname is included in the metric tags for filtering and is by default the hosts hostname. 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: Tell tivan to output information about gathered metrics.

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.