Go
Clone or download

README.md

Pewpew Travis Go Report Card Coveralls branch GoDoc

Pewpew is a flexible command line HTTP stress tester. Unlike other stress testers, it can hit multiple targets with multiple configurations, simulating real world load and bypassing caches.

Disclaimer: Pewpew is designed as a tool to help those developing web services and websites. Please use responsibly.

Demo

Features

  • Regular expression defined targets
  • Multiple simultaneous targets
  • No runtime dependencies, single binary file
  • Statistics on timing, data transferred, status codes, and more
  • Export raw data as TSV and/or JSON for analysis, graphs, etc.
  • HTTP2 support
  • IPV6 support
  • Tons of command line and/or config file options (arbitrary headers, cookies, User-Agent, timeouts, ignore SSL certs, HTTP authentication, Keep-Alive, DNS prefetch, and more)

Status

Pewpew is under active development. Since Pewpew is pre-1.0, minor version changes may be breaking. Tagged releases should be stable. Versioning follows SemVer.

Installing

Pre-compiled binaries for Windows, Mac, Linux, and BSD are available on Releases.

If you want to get the latest or build from source: install Go 1.8+, go get github.com/bengadbois/pewpew, and install dependencies with dep.

Examples

pewpew stress -n 50 www.example.com

Make 50 requests to http://www.example.com

pewpew stress -X POST --body '{"hello": "world"}' -n 100 -c 5 -t 2.5s -H "Accept-Encoding:gzip, Content-Type:application/json" https://www.example.com:443/path localhost 127.0.0.1/api

Make request to each of the three targets https://www.example.com:443/path, http://localhost, http://127.0.0.1/api

  • 100 requests total requests per target (300 total)
  • 5 concurrent requests per target (15 simultaneous)
  • POST with body {"hello": "world"}
  • Two headers: Accept-Encoding:gzip and Content-Type:application/json
  • Each request times out after 2.5 seconds

For the full list of command line options, run pewpew help or pewpew help stress

Using Regular Expression Targets

Pewpew supports using regular expressions (Perl syntax) to nondeterministically generate targets.

pewpew stress -r "localhost/pages/[0-9]{1,3}"

This example will generate target URLs such as:

http://localhost/pages/309
http://localhost/pages/390
http://localhost/pages/008
http://localhost/pages/8
http://localhost/pages/39
http://localhost/pages/104
http://localhost/pages/642
http://localhost/pages/479
http://localhost/pages/82
http://localhost/pages/3
pewpew stress -r "localhost/pages/[0-9]+\?cache=(true|false)(\&referrer=[0-9]{3})?"

This example will generate target URLs such as:

http://localhost/pages/278613?cache=false
http://localhost/pages/736?cache=false
http://localhost/pages/255?cache=false
http://localhost/pages/25042766?cache=false
http://localhost/pages/61?cache=true
http://localhost/pages/4561?cache=true&referrer=966
http://localhost/pages/7?cache=false&referrer=048
http://localhost/pages/01?cache=true
http://localhost/pages/767911706?cache=false&referrer=642
http://localhost/pages/68780?cache=true

Note: dots in IP addresses must be escaped, such as pewpew stress -r "http://127\.0\.0\.1:8080/api/user/[0-9]{1,3}"

Using Config Files

Pewpew supports complex configurations more easily managed with a config file. You can define one or more targets each with their own settings.

By default, Pewpew looks for a config file in the current directory and named pewpew.json or pewpew.toml. If found, Pewpew can be run like:

pewpew stress

There are examples config files in examples/.

Available global settings:

  • Count (default 10)
  • Concurrency (default 1)
  • NoHTTP2 (default false)
  • EnforceSSL (default false)
  • Quiet (default false)
  • Verbose (default false)
  • DNSPrefetch (default defer to Target)
  • Timeout (default defer to Target)
  • Method (default defer to Target)
  • Body (default defer to Target)
  • BodyFilename (default defer to Target)
  • Headers (default defer to Target)
  • Cookies (default defer to Target)
  • UserAgent (default defer to Target)
  • BasicAuth (default defer to Target)
  • Compress (default defer to Target)
  • KeepAlive (default defer to Target)
  • FollowRedirects (default defer to Target)

Available individual target settings:

  • URL (default "http://localhost")
  • RegexURL (default false)
  • DNSPrefetch (default false)
  • Timeout (default 10s)
  • Method (default GET)
  • Body (default empty)
  • BodyFilename (default none)
  • Headers (default none)
  • Cookies (default none)
  • UserAgent (default "pewpew")
  • BasicAuth (default none)
  • Compress (default false)
  • KeepAlive (default false)
  • FollowRedirects (default true)

Pewpew allows combining config file and command line settings, to maximize flexibility.

Individual target settings in the config file override any other setting, then command line flags (applied to all targets) override others, then global settings in the config file override the Pewpew's defaults.

If target URL(s) are specified on the command line, they override all targets in the config file.

Using as a Go library

package main

import (
    "fmt"
    "os"

    pewpew "github.com/bengadbois/pewpew/lib"
)

func main() {
    stressCfg := pewpew.StressConfig{
        //global settings
        Count:       1,
        Concurrency: 1,
        Verbose:     false,
        //setup one target
        Targets: []pewpew.Target{{
            URL:     "https://127.0.0.1:443/home",
            Timeout: "2s",
            Method:  "GET",
            Body:    `{"field": "data", "work": true}`,
        }},
    }

    //begin stress test
    output := os.Stdout //can be any io.Writer, such as a file
    stats, err := pewpew.RunStress(stressCfg, output)
    if err != nil {
        fmt.Println("pewpew stress failed:  %s", err.Error())
    }

    //do whatever you want with the raw stats
    fmt.Printf("%+v", stats)
}

Full package documentation at godoc.org

Hints

If you receive a lot of "socket: too many open files" errors while running many concurrent requests, try increasing your ulimit.