bench2csv

README

go-bench2csv

A small CLI to parse the output of go test -bench and output to CSV.

It passes the go test output verbatim on STDERR and the CSV output to STDOUT.

Usage

$ go install github.com/maragudk/go-bench2csv/cmd/bench2csv@latest
$ go test -cpu 1,2,4,8 -bench . | bench2csv >benchmark.csv
goos: darwin
goarch: arm64
pkg: github.com/maragudk/go-bench2csv
BenchmarkProcess/in_parallel_just_for_fun           	    4314	    276820 ns/op
BenchmarkProcess/in_parallel_just_for_fun-2         	    8292	    145504 ns/op
BenchmarkProcess/in_parallel_just_for_fun-4         	   15826	     75832 ns/op
BenchmarkProcess/in_parallel_just_for_fun-8         	   19111	     73122 ns/op
PASS
ok  	github.com/maragudk/go-bench2csv	7.324s

Also works with go test -benchmem:

$ go test -cpu 1,2,4,8 -bench . -benchmem | bench2csv -mem >benchmark.csv
goos: darwin
goarch: arm64
pkg: github.com/maragudk/go-bench2csv
BenchmarkProcess/in_parallel_just_for_fun           	    4106	    292497 ns/op	   53892 B/op	     738 allocs/op
BenchmarkProcess/in_parallel_just_for_fun-2         	    7929	    151227 ns/op	   53897 B/op	     738 allocs/op
BenchmarkProcess/in_parallel_just_for_fun-4         	   15013	     79910 ns/op	   53909 B/op	     738 allocs/op
BenchmarkProcess/in_parallel_just_for_fun-8         	   18214	     66196 ns/op	   53941 B/op	     738 allocs/op
PASS
ok  	github.com/maragudk/go-bench2csv	7.402s

Made in 🇩🇰 by maragu, maker of online Go courses.

Documentation

Index

• Constants
• func Process(in io.Reader, csvOut, errOut io.Writer, format int) error

Constants

const (
	Name = 1 << iota
	Parallelism
	Operations
	Duration
	Frequency
	BytesPerOp
	AllocsPerOp
	Default = Name | Parallelism | Operations | Duration
	Memory  = BytesPerOp | AllocsPerOp
)

Functions

func Process

func Process(in io.Reader, csvOut, errOut io.Writer, format int) error

Process benchmark output from in, write CSV to csvOut, and pipe benchmark output to errOut.