Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

clarifying readme #2

Merged
merged 1 commit into from
May 22, 2015
Merged

clarifying readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,19 @@

## Quickstart

* Download tivan
* 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 see what metrics are gather by your config
* Run `tivan -config tivan.toml` to gather and send metrics
* 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:
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 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.
* **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**: Tell tivan to output information about gathered metrics.
* **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

Expand Down