statsd-exec is small shell command "wrapper" to run any arbitrary command and report execution time, success and failure information to statsd.
Note: Tested only on Linux and Mac. If you test on any other platform, please me know!
statsd-exec <Add command or script here>- Download binary from releases
- Give execution rights (
chmod +x statsd-exec) and add it into your $PATH - Add
STATSD_PREFIX="my.prefix" statsd-execin front of any command - See below more examples!
Configuration happens through environment variables
| Environment variable | Required | Default | Description |
|---|---|---|---|
| STATSD_METRIC_NAME | true | - | Name of the metric |
| STATSD_PREFIX | false | stats | Prefix for all stats |
| STATSD_HOST | false | localhost | Hostname for Statsd client |
| STATSD_PORT | false | 8125 | Port for Statsd client |
If command returns successfully (exit code 0)
STATSD_METRIC_NAME="process.helloworld" statsd-exec echo "Hello World"
This would send following metrics:
stats.process.helloworld.executed:1|cstats.process.helloworld.duration:8.167651|msstats.process.helloworld.success:1|cstats.process.helloworld.failed:0|c
If command returns failure
STATSD_METRIC_NAME="process.helloworld" statsd-exec test "foo" == "bar"
This would send following metrics:
stats.process.helloworld.executed:1|cstats.process.helloworld.duration:6.332267|msstats.process.helloworld.success:0|cstats.process.helloworld.failed:1|c
You can for instance set global prefix for all metrics and define only metric name for each execution
export STATSD_PREFIX="stats.testing"
STATSD_METRIC_NAME="foo" statsd-exec echo "Hello Foo"
STATSD_METRIC_NAME="bar" statsd-exec echo "Hello Bar"
This would send following metrics:
stats.testing.foo.*stats.testing.bar.*
go get ./...See statsd documentation how to run it locally.
Highly suggest to set debug:true and dumpMessages:true in the configuration to see the messages in terminal output.
STATSD_PREFIX="testing" go run main.go echo "Hello World!"