|
| 1 | +## Benchmark specifications goal |
| 2 | + |
| 3 | +The Redis benchmarks specification describes the cross-language/tools requirements and expectations to foster performance and observability standards around redis related technologies. |
| 4 | + |
| 5 | +Members from both industry and academia, including organizations and individuals are encouraged to contribute. |
| 6 | + |
| 7 | +Currently, the following members actively support this project: |
| 8 | + |
| 9 | +- [Redis Labs](https://redislabs.com/): providing steady-stable infrastructure platform to run the benchmark suite. Supporting the active development of this project with the company. |
| 10 | + |
| 11 | + |
| 12 | +## Directory layout |
| 13 | + |
| 14 | +* `setups` |
| 15 | + * [`platforms`](./setups/platforms/): contains the standard platforms considered to provide steady stable results, and to represent common deployment targets. |
| 16 | + * [`topologies`](./setups/topologies/): contains the standard deployment topologies definition with the associated minimum specs to enable the topology definition. |
| 17 | +* [`test_suites`](./test-suites/): contains the benchmark suites definitions, specifying the target redis topology, the tested commands, the benchmark utility to use (the client), and if required the preloading dataset steps. |
| 18 | +* [`validator`](./validator/): contains the benchmark specifications validator utility |
| 19 | +* [`build_agent`](./build_agent/): contains the benchmark build agent utility that receives an event indicating a new build variant, generates the required redis binaries to test, and triggers the benchmark run on the listening agents. |
| 20 | +* [`benchmark_coordinator`](./benchmark_coordinator/): contains the coordinator utility that listens for benchmark suite run requests and setups the required steps to spin the actual benchmark topologies and to trigger the actual benchmarks. |
| 21 | + |
| 22 | + |
| 23 | +## Scope |
| 24 | + |
| 25 | +This repo aims to provide Redis related benchmark standards and methodologies for: |
| 26 | + |
| 27 | +- Management of benchmark data and specifications across different setups |
| 28 | + |
| 29 | +- Running benchmarks and recording results |
| 30 | + |
| 31 | +- Exporting performance results in several formats (CSV, RedisTimeSeries, JSON) |
| 32 | + |
| 33 | +- **[SOON]** Finding on-cpu, off-cpu, io, and threading performance problems by attaching profiling tools/probers ( perf (a.k.a. perf_events), bpf tooling, vtune ) |
| 34 | + |
| 35 | +- **[SOON]** Finding performance problems by attaching telemetry probes |
| 36 | + |
| 37 | +Current supported benchmark tools: |
| 38 | + |
| 39 | +- [redis-benchmark](https://github.com/redis/redis) |
| 40 | +- [SOON][memtier_benchmark](https://github.com/RedisLabs/memtier_benchmark) |
| 41 | +- [SOON][redis-benchmark-go](https://github.com/filipecosta90/redis-benchmark-go) |
| 42 | +- [SOON][redis-benchmark-go](https://github.com/filipecosta90/redis-benchmark-go) |
| 43 | + |
| 44 | + |
| 45 | +# Contributing guidelines |
| 46 | + |
| 47 | +## Adding new test suites |
| 48 | + |
| 49 | +TBD |
| 50 | + |
| 51 | +## Adding new topologies |
| 52 | + |
| 53 | +TBD |
| 54 | + |
| 55 | +## Adding new test platforms |
| 56 | + |
| 57 | +TBD |
| 58 | + |
| 59 | +# License |
| 60 | + |
| 61 | +redis-benchmark-specifications is distributed under the Apache 2 license - see [LICENSE](LICENSE) |
0 commit comments