1 unstable release
0.1.0 | Aug 29, 2023 |
---|
#36 in #health-check
21KB
479 lines
cmdprobe
A utility for running arbitrary commands and checking their output
Install
cargo install cmdprobe
Usage
Basic execution
See the example cmdprobe.yaml
file for what configuration is available.
Construct your own configuration file, and then run cmdprobe against it to execute all the checks that you need to do.
cmdprobe --config-file /etc/cmdprobe.yml
Emitting statsd metrics
You can supply a statsd host and cmdprobe
will emit metrics for each test & stage.
cmdprobe --config-file /etc/cmdprobe.yml --statsd-address 127.0.0.1:8125
The following metrics will be emitted:
# Did the entire probe run fail/succeed
cmdprobe.probe.failed
cmdprobe.probe.passed
# Did one check (a collection of stages) fail/succeed
cmdprobe.check.failed
cmdprobe.check.passed
# Did an indidivual stage within a check fail/succeed
cmdprobe.stage.failed
cmdprobe.stage.passed
Running locally
Ensure you have a cmdprobe.yaml
file in the current directory
# Start the httpbin for testing
docker-compose up -d
# Run cmdprobe with the local config file
RUST_LOG=cmdprobe=INFO cargo run
Dependencies
~13MB
~256K SLoC