RustのCriterionベンチマークをCIで追跡する方法

Everett Pompeii

Criterionを使用してRustコードをベンチマークする方法を学んだので、次に、それらのベンチマークをCIで追跡する方法を見てみましょう。 継続的ベンチマークは、パフォーマンスの低下を引き起こさないように、各変更セットでベンチマークを実行するプラクティスです。 Criterionベンチマークを使用して継続的ベンチマークを実装する最も簡単な方法は、Bencherを使用することです。

Bencherとは？

Bencherは、継続的ベンチマーキングツールのスイートです。 パフォーマンスの後退があなたのユーザーに影響を与えたことはありますか？ Bencherなら、それが起こるのを防げた可能性があります。 Bencherは、パフォーマンスの低下が_マージされる_前に検出し、防止することを可能にします。

• 実行: _まったく同じ_ベアメタルランナーとお気に入りのベンチマーキングツールを使用して、ベンチマークをローカルまたはCIで実行します。bencher CLIはベアメタル上でのベンチマークの実行をオーケストレーションし、その結果を保存します。
• 追跡: ベンチマークの結果を時間と共に追跡します。ソースブランチ、テストベッド、測定基準に基づいてBencherのWebコンソールを使用して結果を監視、クエリ、グラフ化します。
• キャッチ: _まったく同じ_ベアメタルハードウェアを使用して、ローカルまたはCIでパフォーマンスの後退をキャッチします。Bencherは最先端のカスタマイズ可能な分析を使用して、パフォーマンスの後退がマージされる前にそれを検出します。

機能の後退を防ぐためにユニットテストが実行されるのと同じ理由で、Bencherを使用してベンチマークを実行してパフォーマンスの後退を防ぐべきです。パフォーマンスのバグはバグです！

Bencher Cloud の手順

1. Bencher Cloud アカウントを作成する。
2. API トークンを作成し、それを秘密として CI に追加する。
3. GitHub Actions や GitLab CI/CD のような CI のワークフローを作成する。
4. Bencher CLI をインストールして CI ワークフローに組み込む。
5. CI ワークフロー内で bencher run サブコマンドを使ってベンチマークを実行し、 rust_criterion アダプターを使用する。

Bencher Self-Hosted の手順

1. Bencher Self-Hosted インスタンスを作成します。
2. Bencher Self-Hosted インスタンスでアカウントを作成します。
3. API トークンを作成し、それをシークレットとして CI に追加します。
4. GitHub Actions や GitLab CI/CD など、CI のワークフローを作成します。
5. CI ワークフローで Bencher CLI をインストール します。CLI のバージョンが Bencher Self-Hosted インスタンスのバージョンと一致していることを確認してください。
6. 次のサブコマンドを使用して CI ワークフローでベンチマークを実行します: bencher run rust_criterion アダプターを使用して、 --host オプション を Bencher Self-Hosted インスタンスの URL に設定します。

🦀 Rust Criterion

Rust Criterionアダプター (rust_criterion) はCriterionの出力を期待しています。 latency 測定（つまり ナノ秒 (ns)）が収集されます。 lower_value と upper_value は、利用可能な場合は傾き、そうでない場合は平均（つまり value）のそれぞれ下限と上限です。

bencher run --adapter rust_criterion "cargo bench"