🐰 Bencher

Showing 25 of 36 from the live probe.

• Submit Run

  Submit benchmark results to create a run. The `results` field takes the raw output of a benchmark harness as strings; the server parses them using the adapter in `settings.adapter` (defaults to `magic` auto-detection). Branch, testbed, and thresholds are created on the fly if they do not exist. Prefer the `bencher run` CLI when benchmarks are executed from a local checkout; use this tool when the results are already in hand.

• List Projects

  List projects. With a project API key (`bencher_run_`), only that project is returned; with a user API key, all projects visible to the user are returned.

• View Project

  View a project. The `project` argument accepts a project slug or UUID.

• List Reports

  List reports for a project, sorted by date time in reverse chronological order by default. Results and alerts are collapsed to counts unless `expand` is set to true.

• Create Report

  Create a report from raw benchmark results for an existing branch and testbed. Prefer `submit_run` unless the branch and testbed are already known to exist.

• View Report

  View a report, including its full results and any alerts.

• List Branches

  List branches for a project.

• Create Branch

  Create a branch for a project.

• View Branch

  View a branch. The `branch` argument accepts a branch slug or UUID.

• Update Branch

  Update a branch. Project API keys (`bencher_run_`) cannot rename branches.

• List Testbeds

  List testbeds for a project.

• Create Testbed

  Create a testbed for a project.

• View Testbed

  View a testbed. The `testbed` argument accepts a testbed slug or UUID.

• Update Testbed

  Update a testbed. Project API keys (`bencher_run_`) cannot rename testbeds.

• List Benchmarks

  List benchmarks for a project.

• Create Benchmark

  Create a benchmark for a project.

• View Benchmark

  View a benchmark. The `benchmark` argument accepts a benchmark slug or UUID.

• Update Benchmark

  Update a benchmark. Project API keys (`bencher_run_`) cannot rename benchmarks.

• List Measures

  List measures for a project (e.g. latency, throughput).

• Create Measure

  Create a measure for a project.

• View Measure

  View a measure. The `measure` argument accepts a measure slug or UUID.

• Update Measure

  Update a measure. Project API keys (`bencher_run_`) cannot rename measures.

• List Thresholds

  List thresholds for a project. A threshold is the combination of a branch, testbed, and measure with a statistical model.

• Create Threshold

  Create a threshold for a project: a branch, testbed, and measure with a statistical model used to detect performance regressions.

• View Threshold

  View a threshold. The `threshold` argument is a threshold UUID.