benchie

A simple benchmarking tool.

Usage

1. Vendor benchie.sh into your benchmark repo. E.g. my-benchmarks

cd my-benchmarks
git submodule add https://github.com/theohbrothers/benchie tools/benchie

2. Create a new benchmark. E.g. client-network-latency

mkdir -p client-network-latency
echo 'ping -W 1 1.1.1.1' > client-network-latency/commands
echo 'ping -W 1 192.168.0.1' >> client-network-latency/commands

3. Start benchmark

./tools/benchie/benchie.sh start client-network-latency <benchmark_label>
# Benchmark data now in ./client-network-latency/data

4. Get status of benchmark

./tools/benchie/benchie.sh status client-network-latency

5. Stop benchmark

./tools/benchie/benchie.sh status client-network-latency

6. Commit benchmark data to your benchmark repo

git commit -am 'Add client-network-latency benchmark results'

7. Clean benchmark data

./tools/benchie/benchie.sh clean client-network-latency
# Benchmark data removed in ./client-network-latency/data

Notes

Use benchie.sh --help for command line usage.