Bencherでベンチマーク結果を請求する方法
ほとんどのベンチマーク結果は一時的なものです。 端末がスクロールバックの制限に達するとすぐに消えてしまいます。 ベンチマークハーネスの中には結果をキャッシュできるものもありますが、そのほとんどはローカルにしか保存されません。 Bencherは、ローカルおよびCIランのベンチマークを追跡し、結果を比較することができますが、それでもお気に入りのベンチマークハーネスを使用することができます。 Bencherにはローカルベンチマーク結果を追跡するのを簡単にするいくつかの機能があり、それはCIでベンチマークを追跡する際に考慮される必要があります。
unclaimed プロジェクト
Bencherを使用すると、アカウントを作成せずにベンチマークの結果を追跡できます。bencher run CLIサブコマンドを --tokenオプションを設定せずに呼び出すと、Bencherはベンチマークの結果用に新しいunclaimedオンザフライプロジェクトを作成します。クイックスタートや自社ホストクイックスタートチュートリアルに従った場合、あなたはこの機能を活用していました。
誰でもunclaimedプロジェクトにベンチマークの結果を視聴したり投稿したりできます。unclaimedプロジェクトを主張するには、アカウントを作成する必要があります。bencher runの出力の最後にある Claim this project サインアップリンクに従うと、アカウントが作成されると同時にプロジェクトを自動的に主張します。
すでにBencherアカウントを持っている場合、プロジェクトの公開パフォーマンスページに移動し、ページの上部にある Claim this project ボタンをクリックできます。同様に、すでにAPIトークンを持っている場合、次回bencher runを呼び出す際に --tokenオプションとAPIトークンを使用してプロジェクトを主張できます。
🐰 重要: プロジェクトが
claimedになってしまうと、匿名で投稿することはできなくなります。 必ず--tokenオプションを使用してAPIトークンを使用しなければなりません。
APIトークンを作成する
bencher run CLIサブコマンドを
—tokenオプションで使用するには、
APIトークンを作成する必要があります。
APIトークンを追加するにはここをクリック
手順:
- Bencherコンソールに移動します。
- 右上の自分の名前にマウスを合わせます。
- ドロップダウンメニューが表示されます。
Tokensを選択します。 - APIトークンのページで、
➕ Addボタンをクリックします。
オンザフライのプロジェクト
Bencherでは、claimed と unclaimed の両方のプロジェクトをオンザフライで作成できます。
bencher run CLI サブコマンドを
--project オプション を設定せずに呼び出すか、指定したスラッグが既存のプロジェクトと一致しない場合、
Bencher はベンチマーク結果用の新しいオンザフライプロジェクトを作成します。
クイックスタート や セルフホスト版クイックスタート チュートリアルに従った場合は、
この機能を利用していたことになります。
--project オプション が指定されていない場合、オンザフライのプロジェクトスラッグは次に基づいて生成されます:
- 利用可能であれば、
gitリポジトリの親ディレクトリ名。 - 利用可能であれば、
gitリポジトリの初回コミットの7桁の16進数短縮ハッシュ。 - 対応するOSでは、ローカルマシンの13桁の英数字フィンガープリント。
たとえば、生成されるオンザフライのプロジェクトスラッグは次のようになります: project-abc4567-wxyz123456789
オンザフライのプロジェクトスラッグに依存していて、複数のマシンでベンチマーク結果を追跡したい場合は、
プロジェクトを指定するために必ず--project オプション を使用してください。
そうしないと、マシンごとに新しいオンザフライプロジェクトが作成される可能性があります。
🐰 重要:
CI環境変数がtrueに設定されている場合は、 プロジェクトを指定するために--projectオプション を使用するか、--ci-on-the-flyフラグ を設定する必要があります。
🐰 おめでとうございます！ベンチマーク結果の請求方法を学びました！ 🎉