Go每日一库之 vegeta — http压力测试工具库

今天给大家推荐的是一个对HTTP接口做压力测试的工具：vegeta。

项目地址：https://github.com/tsenart/vegeta

一、特点

• 命令行和Go第三方库都可以使用
• 命令行使用UNIX风格设计
• 可扩展多种压测报告形式
• 对于分布式测试也非常简单易用
• 易安装、易使用

二、安装

2.1 MacOS下安装

macos下使用brew即可安装，如下：

brew update && brew install vegeta

2.2 Arch Linux下安装

pacman -S vegeta

2.3 FreeBSD下安装

pkg install vegeta

2.4 自行编译

git clone https://github.com/tsenart/vegeta
cd vegeta
make vegeta
mv vegeta ~/bin # Or elsewhere, up to you.

三、使用教程

vegeta工具主要有4个子命令组成，分别是attack、encode、report、plot。

• attack子命令：该子命令主要设置和要压测的接口请求有关。比如要压测的接口地址、接口的body参数、接口的header头、并发的请求数量、压测的时间、压测的速率等等。
• encode子命令：该子命令主要是指定压测结果输出的位置以及输出的格式。比如以csv格式输出还是以json格式输出，输出到哪个文件。
• report子命令：该子命令主要是针对压测结果生成统计报告。
• plot子命令： 该子命令的功能主要是将测试结果以图表的形式进行展示。

3.1 指定压测的接口地址

在指定压测地址时有两种方式：通过标准的stdin和指定具体的文件。

• 通过stdin指定压测地址

echo "GET https://www.baidu.com" | vegeta attack -duration=5s

如上所示，通过管道的方式将要压测的接口地址输出给vegeta的attack命令。这里需要注意，在指定压测接口时，一定要指定请求的方法，同时请求方法必须都是大写。例如GET、POST。而Get或Post则是无效的方法。

• 通过targets参数指定文件

通过文件可以指定一个或多个要压测的url地址。指定格式如下：

GET https://foo.bar/a/b/c
Header-X: 123
Header-Y: 321

POST https://foo.bar/b/c/a
Header-X: 123
@/path/to/body/file

在文件中，通过空行来区分两个url的部分。每个url部分以方法名和url地址开头，后续可以跟着对应的Header头信息。在POST请求中，可以通过@指定具体的body体内容的文件。

3.2 指定body体内容

要指定body体，只能通过文件的方式来指定。vegeta attack有两种方式来指定body的文件名。第一种是刚才上面提到，在targets的文件中，可以通过“@”符号来指定对应的body体。第二种是通过命令行参数-body指定一个文件名：

vegeta attack -body 

3.3 指定接口返回内容为止

通过vegeta encode子命令来指定接口自身输出的内容（即接口的响应值）被保存的位置以及输出内容的格式（csv、json等） 这里主要有两个参数项：

• -output string：指定接口响应被存储的位置
• -to string：指定内容输出的格式。例如csv、json、gob。默认为json。

3.4 生成测试报告

vegeta的测试报告是通过report子命令来生成的。该命令的输入数据是encode子命令产生的输出。如下示例所示：

sh-3.2# echo "GET https://www.baidu.com" | vegeta attack -duration=5s | vegeta report
Requests      [total, rate, throughput]         250, 50.21, 49.11
Duration      [total, attack, wait]             5.09s, 4.979s, 111.653ms
Latencies     [min, mean, 50, 90, 95, 99, max]  18.132ms, 32.41ms, 21.998ms, 55.54ms, 106.41ms, 171.889ms, 276.545ms
Bytes In      [total, mean]                     56750, 227.00
Bytes Out     [total, mean]                     0, 0.00
Success       [ratio]                           100.00%
Status Codes  [code:count]                      200:250 

可以看到，在报表中输出的信息有：

• 请求相关的统计：请求总数、速率以及吞吐量。
• 持续时间：压测的总时长、实际发送请求的时长以及等待的时间。
• 响应延迟：最小、最大延迟。50分位、90分位、95分位响应延迟。
• 输入、输出的字节
• 响应成功率。
• 状态码统计。

通过-type参数可以按响应时间区间统计，如下：

sh-3.2# echo "GET https://www.baidu.com" | vegeta attack -duration=5s | vegeta report -type="hist[0,100ms,200ms,300ms]"
Bucket           #    %       Histogram
[0s,     100ms]  247  98.80%  ##########################################################################
[100ms,  200ms]  3    1.20%   
[200ms,  300ms]  0    0.00%   
[300ms,  +Inf]   0    0.00% 

按不同的响应时间的区间统计响应的结果量。

四、总结

vegeta是一个命令行的工具。一个压测工具最基本的功能就是输入url及参数、启动指定量的协程来进行压力测试，同时把响应结果保存下来，并以报表的形式进行统计输出。同时，该开源包也是大家学习使用golang进行命令行开发较好的参考。建议有兴趣的朋友可以阅读下源码。

推荐阅读

• Go 1.21中值得关注的几个变化