215 lines
6.2 KiB
Markdown
215 lines
6.2 KiB
Markdown
# Vegeta [](http://travis-ci.org/tsenart/vegeta)
|
|
|
|
Vegeta is a versatile HTTP load testing tool built out of need to drill
|
|
HTTP services with a constant request rate.
|
|
It can be used both as a command line utility and a library.
|
|
|
|
|
|
|
|
## Install
|
|
### Pre-compiled executables
|
|
* [Mac OSX 64 bit](https://dl.dropboxusercontent.com/u/83217940/vegeta-darwin-amd64-de53887.tar.gz)
|
|
* [Mac OSX 32 bit](https://dl.dropboxusercontent.com/u/83217940/vegeta-darwin-386-de53887.tar.gz)
|
|
* [Linux 64 bit](https://dl.dropboxusercontent.com/u/83217940/vegeta-linux-amd64-de53887.tar.gz)
|
|
* [Linux 32 bit](https://dl.dropboxusercontent.com/u/83217940/vegeta-linux-386-de53887.tar.gz)
|
|
|
|
### Source
|
|
You need go installed and `GOBIN` in your `PATH`. Once that is done, run the
|
|
command:
|
|
```shell
|
|
$ go get github.com/tsenart/vegeta
|
|
$ go install github.com/tsenart/vegeta
|
|
```
|
|
|
|
## Usage examples
|
|
```shell
|
|
$ echo "GET http://localhost/" | vegeta attack -rate=100 -duration=5s | vegeta report
|
|
$ vegeta attack -targets=targets.txt > results.vr
|
|
$ vegeta report -input=results.vr -reporter=json > metrics.json
|
|
$ vegeta report -input=results.vr -reporter=plot:timings > plot.svg
|
|
```
|
|
|
|
## Usage manual
|
|
```shell
|
|
$ vegeta -h
|
|
Usage: vegeta [globals] <command> [options]
|
|
|
|
Commands:
|
|
attack Hit the targets
|
|
report Report the results
|
|
|
|
Globals:
|
|
-cpus=8 Number of CPUs to use
|
|
```
|
|
|
|
#### -cpus
|
|
Specifies the number of CPUs to be used internally.
|
|
It defaults to the amount of CPUs available in the system.
|
|
|
|
### attack
|
|
```shell
|
|
$ vegeta attack -h
|
|
Usage of attack:
|
|
-duration=10s: Duration of the test
|
|
-ordering="random": Attack ordering [sequential, random]
|
|
-output="stdout": Output file
|
|
-rate=50: Requests per second
|
|
-targets="stdin": Targets file
|
|
```
|
|
|
|
#### -duration
|
|
Specifies the amount of time to issue request to the targets.
|
|
The internal concurrency structure's setup has this value as a variable.
|
|
The actual run time of the test can be longer than specified due to the
|
|
responses delay.
|
|
|
|
#### -ordering
|
|
Specifies the ordering of target attack. The default is `random` and
|
|
it will randomly pick one of the targets per request without ever choosing
|
|
that target again.
|
|
The other option is `sequential` and it does what you would expect it to
|
|
do.
|
|
|
|
#### -output
|
|
Specifies the output file to which the binary results will be written
|
|
to. Made to be piped to the report command input. Defaults to stdout.
|
|
|
|
#### -rate
|
|
Specifies the requests per second rate to issue against
|
|
the targets. The actual request rate can vary slightly due to things like
|
|
garbage collection, but overall it should stay very close to the specified.
|
|
|
|
#### -targets
|
|
Specifies the attack targets in a line sepated file, defaulting to stdin.
|
|
The format should be as follows.
|
|
```
|
|
GET http://goku:9090/path/to/dragon?item=balls
|
|
GET http://user:password@goku:9090/path/to
|
|
HEAD http://goku:9090/path/to/success
|
|
...
|
|
```
|
|
|
|
### report
|
|
```
|
|
$ vegeta report -h
|
|
Usage of report:
|
|
-input="stdin": Input file
|
|
-output="stdout": Output file
|
|
-reporter="text": Reporter [text, json, plot:timings]
|
|
```
|
|
|
|
#### -input
|
|
Specifies the input file from which the attack command binary results
|
|
are saved. Defaults to stdin.
|
|
|
|
#### -output
|
|
Specifies the output file to which the report will be written to.
|
|
|
|
#### -reporter
|
|
Specifies the kind of report to be generated. It defaults to text.
|
|
|
|
##### text
|
|
```
|
|
Time(avg) Requests Success Bytes(rx/tx)
|
|
152.341ms 200 17.00% 251.00/0.00
|
|
|
|
Count: 49 30 39 48 34
|
|
Status: 500 404 409 503 200
|
|
|
|
Error Set:
|
|
Server Timeout
|
|
Page Not Found
|
|
```
|
|
##### json
|
|
```json
|
|
{
|
|
"total_requests": 50,
|
|
"total_timing": 34779791,
|
|
"mean_timing": 695595,
|
|
"total_bytes_in": 272850,
|
|
"mean_bytes_in": 5457,
|
|
"total_bytes_out": 0,
|
|
"mean_bytes_out": 0,
|
|
"total_success": 50,
|
|
"mean_success": 1,
|
|
"status_codes": {
|
|
"200": 50
|
|
},
|
|
"errors": []
|
|
}
|
|
```
|
|
##### plot:timings
|
|
|
|
|
|
|
|
## Usage (Library)
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
vegeta "github.com/tsenart/vegeta/lib"
|
|
"time"
|
|
"fmt"
|
|
)
|
|
|
|
func main() {
|
|
targets, _ := vegeta.NewTargets([]string{"GET http://localhost:9100/"})
|
|
rate := uint64(100) // per second
|
|
duration := 4 * time.Second
|
|
|
|
results := vegeta.Attack(targets, rate, duration)
|
|
|
|
totalTime := time.Duration(0)
|
|
for _, result := range results {
|
|
totalTime += result.Timing
|
|
}
|
|
meanTime := time.Duration(float64(totalTime) / float64(len(results)))
|
|
|
|
fmt.Printf("Average timing: %s", meanTime)
|
|
}
|
|
```
|
|
|
|
#### Limitations
|
|
There will be an upper bound of the supported `rate` which varies on the
|
|
machine being used.
|
|
You could be CPU bound (unlikely), memory bound (more likely) or
|
|
have system resource limits being reached which ought to be tuned for
|
|
the process execution. The important limits for us are file descriptors
|
|
and processes. On a UNIX system you can get and set the current
|
|
soft-limit values for a user.
|
|
```shell
|
|
$ ulimit -n # file descriptors
|
|
2560
|
|
$ ulimit -u # processes / threads
|
|
709
|
|
```
|
|
Just pass a new number as the argument to change it.
|
|
|
|
## TODO
|
|
* Add timeout options to the requests
|
|
* Cluster mode (to overcome single machine limits)
|
|
|
|
## Licence
|
|
```
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2013 Tomás Senart
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
this software and associated documentation files (the "Software"), to deal in
|
|
the Software without restriction, including without limitation the rights to
|
|
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
```
|