Performance measurement, storage, and analysis.

Clone this repo:

Branches

  1. e8d778a benchfmt: use constant to avoid repeated definitions by cui fliter · 2 weeks ago master
  2. a1b9949 cmd/benchstat: add examples to README for populating old.txt and new.txt by Eric Chiang · 4 weeks ago
  3. 6646f20 all: replace io/ioutil with io and os package by cui fliter · 3 weeks ago
  4. 7c6e287 benchstat: use safehtml/template, add SafeFormatHTML method by Damien Neil · 4 weeks ago
  5. 28e95a5 benchfmt: remove redundant type conversion by cui fliter · 4 weeks ago

Go benchmark analysis tools

Go Reference

This subrepository holds tools and packages for analyzing Go benchmark results, such as the output of testing package benchmarks.

Tools

This subrepository contains command-line tools for analyzing benchmark result data.

cmd/benchstat computes statistical summaries and A/B comparisons of Go benchmarks.

cmd/benchsave publishes benchmark results to perf.golang.org.

To install all of these commands, run go install golang.org/x/perf/cmd/...@latest. You can also git clone https://go.googlesource.com/perf and run go install ./cmd/... in the checkout.

Packages

Underlying the above tools are several packages for working with benchmark data. These are designed to work together, but can also be used independently.

benchfmt reads and writes the Go benchmark format.

benchunit manipulates benchmark units and formats numbers in those units.

benchproc provides tools for filtering, grouping, and sorting benchmark results.

benchmath provides tools for computing statistics over distributions of benchmark measurements.

Deprecated packages

The following packages are deprecated and no longer supported:

storage contains a deprecated version of the https://perfdata.golang.org/ benchmark result storage system. These packages have moved to https://golang.org/x/build.

analysis contains a deprecated version of the https://perf.golang.org/ benchmark result analysis system. These packages have moved to https://golang.org/x/build.

Report Issues / Send Patches

This repository uses Gerrit for code changes. To learn how to submit changes to this repository, see https://golang.org/doc/contribute.html.

The main issue tracker for the perf repository is located at https://github.com/golang/go/issues. Prefix your issue with “x/perf:” in the subject line, so it is easy to find.