Back to Risingwave

Micro Benchmark for Batch Executors

src/batch/executors/benches/README.md

2.8.31.0 KB
Original Source

Micro Benchmark for Batch Executors

We use criterion micro-benchmarking tool. For more details on how to write and run benchmarks, please refer to its documentation.

Run Benchmark

Run all benchmarks

bash
cargo bench -p risingwave_batch_executors

Run a specific benchmark

bash
cargo bench -p risingwave_batch_executors -- <filter>

where <filter> is a regular expression matching the benchmark ID, e.g., top_n.rs uses BenchmarkId::new("TopNExecutor", params) , so we can run TopN benchmarks with

bash
# All TopN benchmarks
cargo bench -p risingwave_batch_executors -- TopN
# One specific setting of TopN benchmarks
cargo bench -p risingwave_batch_executors -- "TopNExecutor/2048\(single_column: true\)"

Note: -p risingwave_batch_executors can be omitted if you are in the src/batch/executors directory.

Add new Benchmarks

  • Add benchmark target to src/batch/executors/Cargo.toml
  • Implement benchmarks in src/batch/executors/benches, referring to existing ones