How to track Rust Iai benchmarks in CI

Everett Pompeii

Now that you have learned how to benchmark Rust code with Iai, let’s see how to track those benchmarks in CI. Continuous Benchmarking is the practice of running benchmarks on every changeset to ensure the changes do not introduce a performance regressions. The easiest way to implement Continuous Benchmarking with Criterion benchmarks is to use Bencher.

What is Bencher?

Bencher is a suite of continuous benchmarking tools. Have you ever had a performance regression impact your users? Bencher could have prevented that from happening. Bencher allows you to detect and prevent performance regressions before they make it to production.

• Run: Run your benchmarks locally or in CI using your favorite benchmarking tools. The bencher CLI simply wraps your existing benchmark harness and stores its results.
• Track: Track the results of your benchmarks over time. Monitor, query, and graph the results using the Bencher web console based on the source branch, testbed, benchmark, and measure.
• Catch: Catch performance regressions in CI. Bencher uses state of the art, customizable analytics to detect performance regressions before they make it to production.

For the same reasons that unit tests are run in CI to prevent feature regressions, benchmarks should be run in CI with Bencher to prevent performance regressions. Performance bugs are bugs!

Steps for Bencher Cloud

1. Create a Bencher Cloud account.
2. Create an API token and add it to your CI as a secret.
3. Create a workflow for your CI, like GitHub Actions or GitLab CI/CD.
4. Install the Bencher CLI in your CI workflow.
5. Run your benchmarks with the bencher run subcommand in your CI workflow using the rust_iai adapter.

Steps for Bencher Self-Hosted

1. Create a Bencher Self-Hosted instance.
2. Create an account on your Bencher Self-Hosted instance.
3. Create an API token and add it to your CI as a secret.
4. Create a workflow for your CI, like GitHub Actions or GitLab CI/CD.
5. Install the Bencher CLI in your CI workflow. Make sure the CLI version matches the version of your Bencher Self-Hosted instance.
6. Run your benchmarks with the bencher run subcommand in your CI workflow using the rust_iai adapter and setting the --host option to your Bencher Self-Hosted instance URL.

🦀 Rust Iai

The Rust Iai Adapter (rust_iai) expects Iai output. The instructions, l1-accesses, l2-accesses, ram-accesses, and estimated-cycles Measures are gathered. Only the reported value (ie value) is available is available for these Measures. Neither lower_value nor upper_value are collected. The Measures for this adapter are not created by default for all projects. However, when you use this adapter, these Measures will be automatically created for your Project.

bencher run --adapter rust_iai "cargo bench"