如何使用 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 选项 来声明项目。

🐰 重要: 一旦一个项目被 claimed,它将不能被匿名提交。 您 必须 使用 API 令牌与 --token 选项

创建 API 令牌

为了使用 bencher run CLI 子命令与 --token 选项,您需要创建一个 API 令牌。

点击添加 API 令牌

步骤:

  1. 前往 Bencher 控制台。
  2. 将鼠标悬停在右上角的您的名字上。
  3. 应出现一个下拉菜单。选择 Tokens
  4. 在 API 令牌页面,点击 ➕ Add 按钮。

实时项目

Bencher 允许您即时创建 claimedunclaimed 项目。当您调用 bencher run CLI 子命令时,如果没有设置 --project 选项,或者指定的 slug 不匹配现有项目,Bencher 将为您的基准测试结果创建一个新的即时项目。如果您已按照快速开始自托管快速开始教程进行操作,您就已经在利用此功能。

如果未指定 --project 选项,将基于以下信息为您生成一个即时项目 slug:

  1. git 仓库父目录的名称(如果可用)。
  2. git 仓库初始提交的 7 位十六进制短哈希值(如果可用)。
  3. 对于支持的操作系统,本地机器的 13 位字母数字指纹。

例如,生成的即时项目 slug 可能看起来像这样:project-abc4567-wxyz123456789

🐰 重要提示: 如果您依赖即时项目 slug,并且希望跨不同机器跟踪基准测试结果,您必须使用 --project 选项 来指定项目 slug。否则,可能会为每台不同的机器创建一个新的即时项目。



🐰 恭喜!您已学会如何认领基准测试结果!🎉


继续学习:在 CI 中追踪基准测试 ➡

🤖 该文档由 OpenAI GPT-4 自动生成。 它可能不准确并且可能包含错误。 如果您发现任何错误,请在 GitHub 上提出问题.


Published: Tue, April 8, 2025 at 10:00:00 PM UTC