Generate text reports and graphical charts from the benchmark results generated
by gauge or criterion and stored in a CSV file. This tool is especially
useful when you have many benchmarks or if you want to compare benchmarks
across multiple packages. You can generate many interesting reports
including:
Show individual reports for all the fields measured e.g. time taken, peak
memory usage, allocations, among many other fields measured by gauge
Sort benchmark results on a specified criterion e.g. you may want to see the
biggest cpu hoggers or biggest memory hoggers on top
Across two benchmark runs (e.g. before and after a change), show all the
operations that resulted in a regression of more than x% in descending
order, so that we can quickly identify and fix performance problems in our
application.
Across two (or more) packages providing similar functionality, show all the
operations where the performance differs by more than 10%, so that we can
critically analyze the packages and choose the right one.
Quick Start: Use gauge or criterion to generate a results.csv file, and
then use either the bench-show executable or the library APIs to generate
textual or graphical reports.
There are many ways to present the reports, for example, you can show can
show % regression from a baseline in descending order textually as follows:
To show the same graphically: