Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
thsutton committed Mar 3, 2015
1 parent 0dabfa4 commit 347ecda
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion README.md
@@ -1,2 +1,35 @@
# nagios-plugin-vaultaire-throughput
Checks if the data coming into a Vaultaire origin drops below a threshold

Accesses a Vaultaire telemetry origin and checks the write throughput for
a given origin. The check passes only when the origin has addresses, all of
them can be read, and at least one of them has been written to in the last 10
minutes.

Running the check is straightforward:

````
$ nagios-plugin-vaultaire-throughput -b chateau-02.syd1 \
-c tcp://chevalier-02.syd1:6283 \
X14C82 \
894LRK
OK: Nonzero points written for origin 894LRK | points-written=556727;0;;;
````

For detailed usage instructions use the `--help` command-line option:

```
Usage: nagios-plugin-vaultaire-throughput [-b|--broker-host BROKER-HOST]
[-c|--chevalier-uri CHEVALIER-URI]
TELEMETRY-ORIGIN CHECK-ORIGIN
Available options:
-h,--help Show this help text
-b,--broker-host BROKER-HOST
Vault broker host (default: "localhost")
-c,--chevalier-uri CHEVALIER-URI
Chevalier reader URI (default: tcp://localhost:6283)
TELEMETRY-ORIGIN Origin Vaultaire telemetry is written to
CHECK-ORIGIN Origin for which to check throughput
```


0 comments on commit 347ecda

Please sign in to comment.