Skip to content

Latest commit

 

History

History
101 lines (88 loc) · 4.61 KB

README.md

File metadata and controls

101 lines (88 loc) · 4.61 KB
Raw

Go Report Card

A simpler, more meaningful benchmarking app modeled after go-wrk and wrk. This project is designed to stress test web apps in ways similar to organic internet traffic.

The primary addition go2wrk features is multi-route targeting. Users rarely only hit a single route of a web app while browsing, and many apps have to simultaneously handle diverse requests all competing for the same system resources. Therefore, gauging server and application performance on repeated queries to a single route in isolation is only serving a delusion. Unfortunately, this is the limited functionality of most benchmarking tools today. go2wrk benchmarks how your app and hardware perform in the presence of different usage patterns, and allows you to identify critical problems in cache and garbage collection.

go2wrk sends requests according to a given probability distribution. The simplest choice is a fair-share model where each route will be hit the same number of times on average.

TODO

    • Update Readme
    • Look into bootstrapping
        • make it async with a bool flag if done
        • make sure it actually is working
        • make it a flag
        • bootstrap on each route individually
    • Add graph making code to repo in clean way
    • Compare to Autocannon
    • Build/explore node apps to test on
    • look into other performance stats other than GC
        • Cache (in some way other than perf)
        • ...
    • TLS
        • Actually get the tls stuff working -- get those certs?
        • Add to readme the steps needed for that

Comparison

connections wrk autocannon http-perf wrk2 go-wrk go2wrk
10 1.84
2.19
2.01		 2.05
1.96
2.03		 12.56
16.94
16.63		 1.91
2.07
1.93		 9.69
14.77
10.31		 1.88
1.85
1.95
100 20.94
21.49
21.04		 23.97
23.53
23.28		 81.69
86.67
113.60		 2.07
5.71
2.09		 106.07
95.22
100.28		 19.27
20.54
22.07
500 49.29
53.59
52.15		 115.14
120.82
121.19		 562.23
387.40
437.81		 23.63
21.71
22.61		 error 110.78
112.77
114.11
1000 52.30
53.44
51.12		 257.73
256.22
254.06		 908
899
786		 23.85
26.16
24.79		 error 237.17
222.63
213.96

Building and Usage

go get github.com/kpister/go2wrk
cd go2wrk
go build        // alternatively use go install if you have set your $GOPATH

You now should have an executable which you can run

./go2wrk [flags]        // with empty args, the program defaults to routes.json

The design philosophy we follow is that any configuration pertaining to the multiple routes should be configured from within the json file, while the app-wide features should be flags.

A full list of flags:

  -h	for usage
  -f string
        The file name for the route descriptions. A json file (default: "routes.json")
  -o string
        The output directory for the graph data (default: current directory)
  -c int
    	the max numbers of connections used
  -s int
    	the numbers of samples to bootstrap on
  -t float
        the amount of time you want to test for (in seconds)
  -cert string
    	A PEM eoncoded certificate file. (default: "someCertFile")
  -i	TLS checks are disabled (default: true)
  -k	if keep-alives are disabled (default: true)
  -key string
    	A PEM encoded private key file. (default: "someKeyFile")
  -CA string
    	A PEM eoncoded CA's certificate file. (default: "someCertCAFile")

A normal routes.json file will look something like the following:

{
    "Routes": 
    [
        {
            "Url": "https://route.com/a",
            "Headers": ""                           //optional
            "Method": "Get"                         //optional
            "RequestBody": ""                       //optional
            "MandatoryDependencies":[               //optional
                // More urls
            ]
        },
        {
            "Url": "https://route.com/b"
        }
    ],
    "TestTime": 10.0,
    "Connections": 30,
    "Samples":1000,
    "Latency":1000,
    "Frequency":4
}

Tags

go, plsyssec