README
¶
Go benchmark analysis tools
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/benchfilter filters the contents of benchmark result files.
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.
Directories
¶
| Path | Synopsis |
|---|---|
|
Deprecated: Moved to golang.org/x/build/perf.
|
Deprecated: Moved to golang.org/x/build/perf. |
|
app
Package app implements the performance data analysis server.
|
Package app implements the performance data analysis server. |
|
appengine
This binary contains an App Engine app for perf.golang.org
|
This binary contains an App Engine app for perf.golang.org |
|
localperf
Localperf runs an HTTP server for benchmark analysis.
|
Localperf runs an HTTP server for benchmark analysis. |
|
Package benchfmt provides a high-performance reader and writer for the Go benchmark format.
|
Package benchfmt provides a high-performance reader and writer for the Go benchmark format. |
|
Package benchmath provides tools for computing statistics over distributions of benchmark measurements.
|
Package benchmath provides tools for computing statistics over distributions of benchmark measurements. |
|
Package benchproc provides tools for filtering, grouping, and sorting benchmark results.
|
Package benchproc provides tools for filtering, grouping, and sorting benchmark results. |
|
internal/parse
Package parse implements parsers for golang.org/x/perf/benchproc/syntax.
|
Package parse implements parsers for golang.org/x/perf/benchproc/syntax. |
|
syntax
Package syntax documents the syntax used by benchmark filter and projection expressions.
|
Package syntax documents the syntax used by benchmark filter and projection expressions. |
|
The benchseries package generates performance differentials and analysis tailored to the output of tools and benchmarks in golang.org/x/benchmarks.
|
The benchseries package generates performance differentials and analysis tailored to the output of tools and benchmarks in golang.org/x/benchmarks. |
|
Package benchstat is deprecated.
|
Package benchstat is deprecated. |
|
Package benchunit manipulates benchmark units and formats numbers in those units.
|
Package benchunit manipulates benchmark units and formats numbers in those units. |
|
cmd
|
|
|
benchfilter
benchfilter reads Go benchmark results from input files, filters them, and writes filtered benchmark results to stdout.
|
benchfilter reads Go benchmark results from input files, filters them, and writes filtered benchmark results to stdout. |
|
benchsave
Benchsave uploads benchmark results to a storage server.
|
Benchsave uploads benchmark results to a storage server. |
|
benchstat
Benchstat computes statistical summaries and A/B comparisons of Go benchmarks.
|
Benchstat computes statistical summaries and A/B comparisons of Go benchmarks. |
|
benchstat/internal/benchtab
Package benchtab presents benchmark results as comparison tables.
|
Package benchtab presents benchmark results as comparison tables. |
|
internal
|
|
|
basedir
Package basedir finds templates and static files associated with a binary.
|
Package basedir finds templates and static files associated with a binary. |
|
stats
Package stats implements several statistical distributions, hypothesis tests, and functions for descriptive statistics.
|
Package stats implements several statistical distributions, hypothesis tests, and functions for descriptive statistics. |
|
Package storage contains a client for the performance data storage server.
|
Package storage contains a client for the performance data storage server. |
|
app
Package app implements the performance data storage server.
|
Package app implements the performance data storage server. |
|
appengine
This binary contains an App Engine app for perfdata.golang.org
|
This binary contains an App Engine app for perfdata.golang.org |
|
benchfmt
Package benchfmt provides readers and writers for the Go benchmark format.
|
Package benchfmt provides readers and writers for the Go benchmark format. |
|
db
Package db provides the high-level database interface for the storage app.
|
Package db provides the high-level database interface for the storage app. |
|
db/sqlite3
Package sqlite3 provides the sqlite3 driver for x/perf/storage/db.
|
Package sqlite3 provides the sqlite3 driver for x/perf/storage/db. |
|
fs
Package fs provides a backend-agnostic filesystem layer for storing performance results.
|
Package fs provides a backend-agnostic filesystem layer for storing performance results. |
|
fs/gcs
Package gcs implements the fs.FS interface using Google Cloud Storage.
|
Package gcs implements the fs.FS interface using Google Cloud Storage. |
|
fs/local
Package local implements the fs.FS interface using local files.
|
Package local implements the fs.FS interface using local files. |
|
localperfdata
Localperfdata runs an HTTP server for benchmark storage.
|
Localperfdata runs an HTTP server for benchmark storage. |
|
query
Package query provides tools for parsing a query.
|
Package query provides tools for parsing a query. |