github.com/jgbaldwinbrown/perf@v0.1.1/README.md (about)

     1  # Go benchmark analysis tools
     2  
     3  [![Go Reference](https://pkg.go.dev/badge/golang.org/x/perf.svg)](https://pkg.go.dev/golang.org/x/perf)
     4  
     5  This subrepository holds tools and packages for analyzing [Go
     6  benchmark results](https://golang.org/design/14313-benchmark-format),
     7  such as the output of [testing package
     8  benchmarks](https://pkg.go.dev/testing).
     9  
    10  ## Tools
    11  
    12  This subrepository contains command-line tools for analyzing benchmark
    13  result data.
    14  
    15  [cmd/benchstat](cmd/benchstat) computes statistical summaries and A/B
    16  comparisons of Go benchmarks.
    17  
    18  [cmd/benchsave](cmd/benchsave) publishes benchmark results to
    19  [perf.golang.org](https://perf.golang.org).
    20  
    21  To install all of these commands, run
    22  `go install golang.org/x/perf/cmd/...@latest`.
    23  You can also
    24  `git clone https://go.googlesource.com/perf` and run
    25  `go install ./cmd/...` in the checkout.
    26  
    27  ## Packages
    28  
    29  Underlying the above tools are several packages for working with
    30  benchmark data. These are designed to work together, but can also be
    31  used independently.
    32  
    33  [benchfmt](benchfmt) reads and writes the Go benchmark format.
    34  
    35  [benchunit](benchunit) manipulates benchmark units and formats numbers
    36  in those units.
    37  
    38  [benchproc](benchproc) provides tools for filtering, grouping, and
    39  sorting benchmark results.
    40  
    41  [benchmath](benchmath) provides tools for computing statistics over
    42  distributions of benchmark measurements.
    43  
    44  ## Deprecated packages
    45  
    46  The following packages are deprecated and no longer supported:
    47  
    48  [storage](storage) contains a deprecated version of the
    49  https://perfdata.golang.org/ benchmark result storage system. These
    50  packages have moved to https://golang.org/x/build.
    51  
    52  [analysis](analysis) contains a deprecated version of the
    53  https://perf.golang.org/ benchmark result analysis system. These
    54  packages have moved to https://golang.org/x/build.
    55  
    56  ## Report Issues / Send Patches
    57  
    58  This repository uses Gerrit for code changes. To learn how to submit changes to
    59  this repository, see https://golang.org/doc/contribute.html.
    60  
    61  The main issue tracker for the perf repository is located at
    62  https://github.com/golang/go/issues. Prefix your issue with "x/perf:" in the
    63  subject line, so it is easy to find.