https://github.com/golang/perf

[mirror] Performance measurement, storage, and analysis.
https://github.com/golang/perf

Last synced: 7 days ago
JSON representation

[mirror] Performance measurement, storage, and analysis.

• Host: GitHub
• URL: https://github.com/golang/perf
• Owner: golang
• License: bsd-3-clause
• Created: 2016-12-20T19:47:21.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-12-04T22:19:41.000Z (about 1 month ago)
• Last Synced: 2024-12-29T02:14:47.979Z (14 days ago)
• Language: Go
• Homepage:
• Size: 11.9 MB
• Stars: 382
• Watchers: 26
• Forks: 53
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• go-awesome - golang/perf - official quantitative performance analysis tool (Open source library / Code Analysis)
• my-awesome - golang/perf - 12 star:0.4k fork:0.1k [mirror] Performance measurement, storage, and analysis. (Go)

README

        
# Go benchmark analysis tools

[![Go Reference](https://pkg.go.dev/badge/golang.org/x/perf.svg)](https://pkg.go.dev/golang.org/x/perf)

This subrepository holds tools and packages for analyzing [Go

benchmark results](https://golang.org/design/14313-benchmark-format),

such as the output of [testing package

benchmarks](https://pkg.go.dev/testing).

## Tools

This subrepository contains command-line tools for analyzing benchmark

result data.

[cmd/benchstat](cmd/benchstat) computes statistical summaries and A/B

comparisons of Go benchmarks.

[cmd/benchfilter](cmd/benchfilter) filters the contents of benchmark

result files.

[cmd/benchsave](cmd/benchsave) publishes benchmark results to

[perf.golang.org](https://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](benchfmt) reads and writes the Go benchmark format.

[benchunit](benchunit) manipulates benchmark units and formats numbers

in those units.

[benchproc](benchproc) provides tools for filtering, grouping, and

sorting benchmark results.

[benchmath](benchmath) provides tools for computing statistics over

distributions of benchmark measurements.

## Deprecated packages

The following packages are deprecated and no longer supported:

[storage](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](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://go.dev/doc/contribute.

The git repository is https://go.googlesource.com/perf.

The main issue tracker for the perf repository is located at

https://go.dev/issues. Prefix your issue with "x/perf:" in the

subject line, so it is easy to find.