如何使用 Bencher 认领基准测试结果
大多数基准测试结果是短暂的。 它们会在终端达到滚动限制时消失。 一些基准测试工具允许您缓存结果,但大多数仅在本地进行。 Bencher 允许您从本地和 CI 运行中跟踪您的基准测试并比较结果,同时仍然使用您喜欢的基准测试工具。 Bencher 有一些功能可以轻松跟踪本地基准测试结果,这在过渡到在 CI 中跟踪基准测试时需要考虑。
unclaimed 项目
Bencher 允许您在无需创建账户的情况下跟踪基准测试结果。 当您调用 bencher run CLI 子命令而不设置 --key 选项时,Bencher 将为您的基准测试结果创建一个新的、动态的 unclaimed 项目。 如果您按照快速开始或自托管快速开始教程进行操作,您已经利用了此功能。
任何人都可以查看并向 unclaimed 项目提交基准测试结果。 为了声明一个 unclaimed 项目,您需要创建一个账户。 如果您在 bencher run 输出的末尾点击 Claim this project 的注册链接,您的账户创建后会自动声明该项目。
如果您已经有 Bencher 账户,请先登录,然后打开同一个 Claim this project 链接:它会为您的账户声明该项目。 同样地,如果您已经有一个用户 API 密钥,则可以在下次调用 bencher run 时将该用户 API 密钥与 --key 选项 一起使用来声明项目。
🐰 重要: 一旦一个项目被
claimed,它将不能被匿名提交。 您 必须 使用用户 API 密钥与--key选项。
创建 API 密钥
为了使用 bencher run CLI 子命令与 --key 选项,您需要创建一个用户 API 密钥。
点击添加 API 密钥
步骤:
- 前往 Bencher 控制台。
- 将鼠标悬停在右上角的您的名字上。
- 应出现一个下拉菜单。选择
Keys。 - 在 API 密钥页面,点击
➕ Add按钮。
即时(On-the-Fly)项目
Bencher 允许你即时创建 claimed 和 unclaimed 项目。
当你在未设置 --project option 的情况下调用 bencher run CLI 子命令,或者指定的 slug 未匹配现有项目时,Bencher 会为你的基准测试结果创建一个新的即时项目。
如果你遵循了 Quickstart 或 Self-Hosted Quickstart 教程,你已经利用了此功能。
如果未指定 --project option,则会基于以下内容为你生成一个即时项目的 slug:
git仓库父目录的名称(如果可用)。git仓库首次提交的 7 位十六进制短哈希(如果可用)。- 本地机器的 13 位字母数字指纹(适用于受支持的操作系统)。
例如,生成的即时项目 slug 可能类似: project-abc4567-wxyz123456789
如果你依赖于即时项目的 slug 并希望在不同机器间跟踪基准测试结果,必须使用 --project option 来指定项目。否则,可能会为每台不同的机器创建新的即时项目。
🐰 重要:如果
CI环境变量被设置为true, 则你需要使用--projectoption 来指定项目, 或设置--ci-on-the-flyflag。
🐰 恭喜!您已学会如何认领基准测试结果!🎉