benchseries: make this package public but mark it unstable

benchseries' API is currently unstable, so it lives in an internal
directory. However, after CL 395175, we're going to want x/build to
depend on it.

This change moves this package outside of the internal directory, but
also adds package documentation marking the API as experimental and
unstable.

For golang/go#48803.

Change-Id: I5811d8f27bfbaa4cdd0e116adccaad5d43c2bcff
Reviewed-on: https://go-review.googlesource.com/c/perf/+/395654
Trust: Michael Knyszek <mknyszek@google.com>
Run-TryBot: Michael Knyszek <mknyszek@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: David Chase <drchase@google.com>
6 files changed
tree: c4aa47cd9cd2588c5269926f2def7e4ba4de5cb5
  1. analysis/
  2. benchfmt/
  3. benchmath/
  4. benchproc/
  5. benchseries/
  6. benchstat/
  7. benchunit/
  8. cmd/
  9. internal/
  10. storage/
  11. AUTHORS
  12. CONTRIBUTING.md
  13. CONTRIBUTORS
  14. go.mod
  15. go.sum
  16. LICENSE
  17. PATENTS
  18. README.md
README.md

Go performance measurement, storage, and analysis tools

Go Reference

This subrepository holds the source for various packages and tools related to performance measurement, storage, and analysis.

cmd/benchstat contains a command-line tool that computes and compares statistics about benchmarks.

cmd/benchsave contains a command-line tool for publishing benchmark results.

storage contains the https://perfdata.golang.org/ benchmark result storage system.

analysis contains the https://perf.golang.org/ benchmark result analysis system.

Both storage and analysis can be run locally; the following commands will run the complete stack on your machine with an in-memory datastore.

go install golang.org/x/perf/storage/localperfdata@latest
go install golang.org/x/perf/analysis/localperf@latest
localperfdata -addr=:8081 -view_url_base=http://localhost:8080/search?q=upload: &
localperf -addr=:8080 -storage=http://localhost:8081

The storage system is designed to have a standardized API, and we encourage additional analysis tools to be written against the API. A client can be found in the storage package.

Download/Install

The easiest way to install is to run go install golang.org/x/perf/cmd/...@latest. You can also manually git clone the repository and run go install golang.org/x/perf/cmd/....

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.