cassowary

by rogerwelin

rogerwelin / cassowary

:rocket: Modern cross-platform HTTP load-testing tool written in Go

445 Stars 11 Forks Last release: 5 months ago (v0.11.0) MIT License 161 Commits 14 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

cassowary

Go Report Card Build status Mentioned in Awesome Go Go version Current Release godoc Coverage License

English | 中文

Cassowary is a modern HTTP/S, intuitive & cross-platform load testing tool built in Go for developers, testers and sysadmins. Cassowary draws inspiration from awesome projects like k6, ab & httpstat.


Toc

Features

  • 2 Load Testing modes: one standard and one spread mode where URL Paths can be specified from a file (ideal if you want to hit several underlying microservices)
  • CI Friendly: Well-suited to be part of a CI pipeline step
  • Flexible metrics: Cloudwatch metrics, Prometheus metrics (pushing metrics to Prometheus PushGateway), JSON file
  • Configurable: Able to pass in arbitrary HTTP headers, able to configure the HTTP client
  • Supports GET, POST & PUT - POST and PUT data can be defined in a file
  • Cross Platform: One single pre-built binary for Linux, Mac OSX and Windows
  • Importable - Besides the CLI tool cassowary can be imported as a module in your Go app

Installation

Grab a pre-built binary from the GitHub Releases page. You can optionally put the cassowary binary in your

PATH
so you can run cassowary from any location. Alternative you can:

Homebrew on Mac OSX

You can install cassowary using the Homebrew package manager on Mac:

$ brew update && brew install cassowary

Nix/NixOS

Cassowary can be installed via the Nix package manager.

nix-env -iA cassowary

CentOS/RHEL (RPM)

If you want to roll out your own RPM you can use the spec file cassowary.spec to build an RPM package

Running Cassowary

Regular Load Test

Example running cassowary against www.example.com with 100 requests spread out over 10 concurrent users:

$ ./cassowary run -u http://www.example.com -c 10 -n 100

Starting Load Test with 100 requests using 10 concurrent users

100% |████████████████████████████████████████| [1s:0s] 1.256773616s

TCP Connect.....................: Avg/mean=101.90ms Median=102.00ms p(95)=105ms Server Processing...............: Avg/mean=100.18ms Median=100.50ms p(95)=103ms Content Transfer................: Avg/mean=0.01ms Median=0.00ms p(95)=0ms

Summary: Total Req.......................: 100 Failed Req......................: 0 DNS Lookup......................: 115.00ms Req/s...........................: 79.57

File Slurp Mode

Example running cassowary in file slurp mode where all URL paths are specified from an external file (which can also be fetched from http if specified). By default cassowary will, without the -n flag specified, make one request per path specified in the file. However with the -n flag you can also specify how many request you want cassowary to generate against those URL paths. Example:

$ ./cassowary run -u http://localhost:8000 -c 1 -f urlpath.txt

NOTE: from v0.10.0 and below file slurp mode had it's own command

$ ./cassowary run-file -u http://localhost:8000 -c 1 -f urlpath.txt

Starting Load Test with 5 requests using 1 concurrent users

[ omitted ]

$ ./cassowary run -u http://localhost:8000 -c 10 -n 100 -f urlpath.txt

Starting Load Test with 100 requests using 10 concurrent users

100% |████████████████████████████████████████| [0s:0s] 599.467161ms

TCP Connect.....................: Avg/mean=1.80ms Median=2.00ms p(95)=3ms Server Processing...............: Avg/mean=0.90ms Median=0.00ms p(95)=3ms Content Transfer................: Avg/mean=0.00ms Median=0.00ms p(95)=0ms

Summary: Total Req.......................: 3925 Failed Req......................: 0 DNS Lookup......................: 2.00ms Req/s...........................: 6547.48

Exporting Metrics to File

Example exporting cassowary json metrics to a file:

$ ./cassowary run --json-metrics --json-metrics-file=metrics.json -u http://localhost:8000 -c 125 -n 100000

Starting Load Test with 100000 requests using 125 concurrent users

100% |████████████████████████████████████████| [0s:0s] 984.9862ms

TCP Connect.....................: Avg/mean=-0.18ms Median=0.00ms p(95)=1ms Server Processing...............: Avg/mean=0.16ms Median=0.00ms p(95)=1ms Content Transfer................: Avg/mean=0.01ms Median=0.00ms p(95)=0ms

Summary: Total Req.......................: 100000 Failed Req......................: 0 DNS Lookup......................: 2.00ms Req/s...........................: 101524.27

If

json-metrics-file
flag is missing then the default filename is
out.json
.

Exporting Metrics to Prometheus

Example exporting cassowary metrics to Prometheus by supplying an Prometheus PushGatway URL:

$ ./cassowary run -u http://localhost:8000 -c 125 -n 100000 -p http://pushgatway:9091

Starting Load Test with 100000 requests using 125 concurrent users

[ omitted for brevity ]

Exporting Metrics to Cloudwatch

Cassowary can export metrics to AWS Cloudwatch just by adding the --cloudwatch flag without a value. Take note that you will need to tell Cassoway which AWS Region you want to use. The easiest way is using an environment variable as shown below:

$ export AWS_REGION=eu-north-1 && ./cassowary run -u http://localhost:8000 -c 125 -n 100000 --cloudwatch

Starting Load Test with 100000 requests using 125 concurrent users

[ omitted for brevity ]

Load Test with POST Data

Example hitting a POST endpoint where POST json data is defined in a file:

$ ./cassowary run -u http://localhost:8000/add-user -c 10 -n 1000 --postfile user.json

Starting Load Test with 1000 requests using 10 concurrent users

[ omitted for brevity ]

Load Test with PATCH Data

Example hitting a PATCH endpoint where PATCH json data is defined in a file:

$ ./cassowary run -u http://localhost:8000/add-user -c 5 -n 200 --patchfile user.json

Starting Load Test with 200 requests using 5 concurrent users

[ omitted for brevity ]

Specifying a Duration for the Load Test

Example specifying a duration for your load test, in the command below we specify that we want send 100 requests over a duration of 30 seconds:

$ ./cassowary run -u http://localhost:8000 -n 100 -d 30

Starting Load Test with 100 requests using 1 concurrent users

[ omitted for brevity ]

Adding HTTP Headers

Example adding an HTTP header when running cassowary

$ ./cassowary run -u http://localhost:8000 -c 10 -n 1000 -H 'Host: www.example.com'

Starting Load Test with 1000 requests using 10 concurrent users

[ omitted for brevity ]

Disabling HTTP keep-alive

Example disabling http keep-alive (by default keep-alive are enabled):

$ ./cassowary run -u http://localhost:8000 -c 10 -n 1000 --disable-keep-alive

Starting Load Test with 1000 requests using 10 concurrent users

[ omitted for brevity ]

Specifying ca certificate

Example specifying ca certificate

$ ./cassowary run -u http://localhost:8000 -c 10 -n 1000 --ca /path/to/ca.pem

Starting Load Test with 1000 requests using 10 concurrent users

[ omitted for brevity ]

x509 Authentication

Example specifying client authentication for mTLS

$ ./cassowary run -u https://localhost:8443 -c 10 -n 1000 --cert /path/to/client.pem --key /path/to/client-key.pem --ca /path/to/ca.pem

Starting Load Test with 1000 requests using 10 concurrent users

[ omitted for brevity ]

Importing cassowary as a module/library

Cassowary can be imported and used as a module in your Go app. Start by fetching the dependency by using go mod:

$ go mod init test && go get github.com/rogerwelin/cassowary/pkg/client

And below show a simple example on how to trigger a load test from your code and printing the results:

package main

import ( "encoding/json" "fmt"

"github.com/rogerwelin/cassowary/pkg/client"

)

func main() { cass := &client.Cassowary{ BaseURL: "http://www.example.com", ConcurrencyLevel: 1, Requests: 10, DisableTerminalOutput: true, } metrics, err := cass.Coordinate() if err != nil { panic(err) }

    // print results
fmt.Printf("%+v\n", metrics)

    // or print as json
jsonMetrics, err := json.Marshal(metrics)
if err != nil {
    panic(err)
}

fmt.Println(string(jsonMetrics))

}

More library examples can be found here

Versioning

Cassowary follows semantic versioning. The public library (pkg/client) may break backwards compatibility until it hits a stable v1.0.0 release.

Contributing

Contributions are welcome! To request a feature create a new issue with the label

feature-request
. Find a bug? Please add an issue with the label
bugs
. Pull requests are also welcomed but please add an issue on the requested feature first (unless it's a simple bug fix or readme change)

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.