Skip to content

Commit

Permalink
Add sample for exec plugin. Fixes #245
Browse files Browse the repository at this point in the history
Closes #258
  • Loading branch information
Eugene Dementiev authored and sparrc committed Oct 13, 2015
1 parent 0bc76f0 commit 2a9f31b
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions plugins/exec/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Exec Plugin

The exec plugin can execute arbitrary commands which return flattened
JSON.
The exec plugin can execute arbitrary commands which output JSON. Then it flattens JSON and finds
all numeric values, treating them as floats.

For example, if you have a json-returning command called mycollector, you could
setup the exec plugin with:
Expand All @@ -18,3 +18,25 @@ The name is used as a prefix for the measurements.
The interval is used to determine how often a particular command should be run. Each
time the exec plugin runs, it will only run a particular command if it has been at least
`interval` seconds since the exec plugin last ran the command.


# Sample

Let's say that we have a command named "mycollector", which gives the following output:
```json
{
"a": 0.5,
"b": {
"c": "some text",
"d": 0.1,
"e": 5
}
}
```

The collected metrics will be:
```
exec_mycollector_a value=0.5
exec_mycollector_b_d value=0.1
exec_mycollector_b_e value=5
```

0 comments on commit 2a9f31b

Please sign in to comment.