Categorygithub.com/mohae/benchutil
repositorypackage
0.0.0-20170714194401-3392ed7c9b5a
Repository: https://github.com/mohae/benchutil.git
Documentation: pkg.go.dev

# README

benchutil

GoDocBuild Status

Helper library to generate formatted output from testing.BenchmarkResult data.

Supported formats:

  • text (default)
  • CSV
  • Markdown; results are formatted as a table

Benchmark results can be labeled by providing a name. Additional information for the benchmark can be added through the description and notes fields. Related benchmarks can be labeled by providing a group (grouping of groups is not done, the output is in the same order as they were added.)

Groups can be separated out to their own sections. For markdown output, these sections can be created as their own table, and, optionally, the table can use the group identifier as its label, which results in the group column being omitted from the table.