dom
/
telegraf
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Start of a README.md

This commit is contained in:
Evan Phoenix 2015-05-19 22:26:13 -07:00
parent 8aa7e355f6
commit 64d0056a8a
1 changed files with 25 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1 +1,25 @@
# tivan # 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.