go-benchmarks

Go to file

Josh Bleecher Snyder 2ca648f910 benchmarks: add codereview.cfg See golang.org/cl/4131 for context. Change-Id: I89210beb0f5fbc87adeed5280ebc4cba13299097 Reviewed-on: https://go-review.googlesource.com/7752 Reviewed-by: David Crawshaw <crawshaw@golang.org>		2015-03-18 17:04:32 +00:00
bench	benchmarks: add documentation	2014-12-17 06:30:05 +00:00
build	benchmarks: add documentation	2014-12-17 06:30:05 +00:00
driver	driver: add -trace to record execution trace	2015-03-11 21:22:14 +00:00
garbage	benchmarks: add documentation	2014-12-17 06:30:05 +00:00
http	benchmarks: add documentation	2014-12-17 06:30:05 +00:00
json	benchmarks: add documentation	2014-12-17 06:30:05 +00:00
.gitignore	convert .hgignore to .gitignore.	2014-12-08 18:08:11 +11:00
AUTHORS	go.empty: prototype for new subrepository	2012-01-25 14:45:13 -05:00
CONTRIBUTING.md	doc: add CONTRIBUTING.md	2015-02-18 23:41:36 +00:00
CONTRIBUTORS	go.empty: prototype for new subrepository	2012-01-25 14:45:13 -05:00
LICENSE	LICENSE: add	2012-03-17 15:20:58 +11:00
PATENTS	go.empty: add PATENTS file to the subrepo.	2012-04-16 11:24:04 +10:00
README	benchmarks: add documentation	2014-12-17 06:30:05 +00:00
codereview.cfg	benchmarks: add codereview.cfg	2015-03-18 17:04:32 +00:00

README

This subrepository holds benchmarks used by the Go performance dashboard:
http://build.golang.org/perf

All benchmarks are compiled into a single binary, to build it execute:

	go install golang.org/x/benchmarks/bench

When you run the binary without any flags, it prints comma-separated list of
available benchmarks:

	./bench
	build,garbage,http,json

To run a benchmark execute:

	./bench -bench=json

The binary has a number of flags to control benchmark duration, etc.
Run 'bench -help' to get the full list of flags.

When the benchmarking finishes, the binary prints results:

	GOPERF-METRIC:allocated=7872994
	GOPERF-METRIC:allocs=105483
	GOPERF-METRIC:cputime=196757680
	GOPERF-METRIC:gc-pause-one=5762425
	GOPERF-METRIC:gc-pause-total=2650715
	GOPERF-METRIC:rss=63655936
	GOPERF-METRIC:sys-gc=3407366
	GOPERF-METRIC:sys-heap=53575680
	GOPERF-METRIC:sys-other=5253938
	GOPERF-METRIC:sys-stack=229376
	GOPERF-METRIC:sys-total=62466360
	GOPERF-METRIC:time=206958902
	GOPERF-FILE:cpuprof=/tmp/19.prof.txt
	GOPERF-FILE:memprof=/tmp/20.prof.txt

Description of metrics is available at:
https://golang.org/wiki/PerfDashboard

A typical usage of the benchmarking binary from dashboard builder is:

	./builder -filelock=builderlock -build=false -bench -benchtime=5s \
		-benchnum=5 -benchmem=1024 -benchcpu=1,2,4,8,16 \
		-benchaffinity=85,85,85,21845 windows-amd64-perf

To submit changes to this repository, see http://golang.org/doc/contribute.html.