benchstat让你的benchmark更精准

benchmark 测试是实际项目中经常使用的性能测试方法，我们可以针对某个函数或者某个功能点增加 benchmark 测试， 以便在 CI 测试中监测其性能变化，当该函数或功能性能下降时能够及时发现。

此外，在日常开发活动中或者参与开源贡献时也有可能针对某个函数或功能点做一些性能优化，此时，如何把 benchmark 测试数据呈现出来便非常重要了，因为你很可能在优化前后执行多次 benchmark 测试，手工分析这些测试结果无疑是低效的。

本节结合笔者在 Golang 社区参与开源贡献时的经历，介绍一下由官方推荐的性能测试分析工具 benchstat，权当抛砖引玉之用。

认识数据
我们先看一个 benchmark 测试样本：

BenchmarkReadGoSum-4           2223        521556 ns/op

该样本包含一个测试名字 BenchmarkReadGoSum-4（其中 -4 表示测试环境为 4 个 cpu）、测试迭代次数（2223）和每次迭代的花费的时间（521556ns）。

尽管每个样本中的时间已经是多次迭代后的平均值，但为了更好的分析性能，往往需要多个样本。

使用 go test 的 -count=N 参数可以指定执行 benchmarkN 次，从而产生 N 个样本，比如产生 15 个样本：

BenchmarkReadGoSum-4           2223        521556 ns/op
BenchmarkReadGoSum-4           2347        516675 ns/op
BenchmarkReadGoSum-4           2340        538406 ns/op
BenchmarkReadGoSum-4           2130        548440 ns/op
BenchmarkReadGoSum-4           2391        514602 ns/op
BenchmarkReadGoSum-4           2394        527955 ns/op
BenchmarkReadGoSum-4           2313        536693 ns/op
BenchmarkReadGoSum-4           2330        538244 ns/op
BenchmarkReadGoSum-4           2360        516426 ns/op
BenchmarkReadGoSum-4           2407        541435 ns/op
BenchmarkReadGoSum-4           2154        544386 ns/op
BenchmarkReadGoSum-4           2362        540411 ns/op
BenchmarkReadGoSum-4           2305        581713 ns/op
BenchmarkReadGoSum-4           2204        519633 ns/op
BenchmarkReadGoSum-4           1867        602543 ns/op

手工分析多个样本将会是一项非常有挑战的工作，因为你可能需要跟据统计学规则抛弃一些异常的样本，剩下的样本再取平均值。

benchstat

benchstat 为 Golang 官方推荐的一款命令行工具，可以针对一组或多组样本进行分析，如果同时分析两组样本（比如优化前和优化后），还可以给出性能变化结果。

使用命令 go get golang.org/x/perf/cmd/benchstat 即可快捷安装，它将被安装到 $GOPATH/bin 目录中。通常我们会将该目录添加到 PATH 环境变量中。

使用时我们需要把 benchmark 测试样子输出到文件中，benchstat 会读取这些文件，命令格式如下：

benchstat [options] old.txt [new.txt] [more.txt ...]

分析一组样本

我们把上面的 15 个样本输出到名为 BenchmarkReadGoSum.before 的文件，然后使用 benchstat 分析：

# benchstat BenchmarkReadGoSum.before 
name         time/op
ReadGoSum-4  531µs ± 3%

输出结果包括一个耗时平均值（531µs）和样本离散值（3%）。

分析两组样本

同上，我们把性能优化后的结果输出到名为 BenchmarkReadGoSum.after 的文件，然后使用 benchstat 分析优化的效果：

# benchstat BenchmarkReadGoSum.before BenchmarkReadGoSum.after 
name         old time/op  new time/op  delta
ReadGoSum-4   531µs ± 3%   518µs ± 7%  -2.41%  (p=0.033 n=13+15)

当只有两组样本时，benchstat 还会额外计算出差值，比如本例中，平均花费时间下降了 2.41%。

另外，p=0.033 表示结果的可信程度，p 值越大可信程度越低，统计学中通常把 p=0.05 做为临界值，超过此值说明结果不可信，可能是样本过少等原因。

n=13+15 表示采用的样本数量，出于某些原因 (比如数据值反常，过大或过小)，benchstat 会舍弃某些样本，本例中优化前的数据中舍弃了两个样本，优化后的数据没有舍弃，所以 13+15，表示两组样本分别采用了 13 和 15 个样本。

本文由mdnice多平台发布