wrk README

The project's README from github.com/wg/wrk. As one markdown file: README.md.

wrk - a HTTP benchmarking tool

wrk is a modern HTTP benchmarking tool capable of generating significant load when run on a single multi-core CPU. It combines a multithreaded design with scalable event notification systems such as epoll and kqueue.

An optional LuaJIT script can perform HTTP request generation, response processing, and custom reporting. Details are available in SCRIPTING and several examples are located in scripts/.

Basic Usage

wrk -t12 -c400 -d30s http://127.0.0.1:8080/index.html

This runs a benchmark for 30 seconds, using 12 threads, and keeping 400 HTTP connections open.

Output:

Running 30s test @ http://127.0.0.1:8080/index.html
  12 threads and 400 connections
  Thread Stats   Avg      Stdev     Max   +/- Stdev
    Latency   635.91us    0.89ms  12.92ms   93.69%
    Req/Sec    56.20k     8.07k   62.00k    86.54%
  22464657 requests in 30.00s, 17.76GB read
Requests/sec: 748868.53
Transfer/sec:    606.33MB

Command Line Options

-c, --connections: total number of HTTP connections to keep open with
                   each thread handling N = connections/threads

-d, --duration:    duration of the test, e.g. 2s, 2m, 2h

-t, --threads:     total number of threads to use

-s, --script:      LuaJIT script, see SCRIPTING

-H, --header:      HTTP header to add to request, e.g. "User-Agent: wrk"

    --latency:     print detailed latency statistics

    --timeout:     record a timeout if a response is not received within
                   this amount of time.

Benchmarking Tips

The machine running wrk must have a sufficient number of ephemeral ports available and closed sockets should be recycled quickly. To handle the initial connection burst the server's listen(2) backlog should be greater than the number of concurrent connections being tested.

A user script that only changes the HTTP method, path, adds headers or a body, will have no performance impact. Per-request actions, particularly building a new HTTP request, and use of response() will necessarily reduce the amount of load that can be generated.

Acknowledgements

wrk contains code from a number of open source projects including the 'ae' event loop from redis, the nginx/joyent/node.js 'http-parser', and Mike Pall's LuaJIT. Please consult the NOTICE file for licensing details.

Cryptography Notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with symmetric algorithms. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.

wrk (wg/wrk)

Searching Database…

40.4K ·GitHub
Wrk
What is this?wrk is a modern HTTP benchmarking tool that generates significant load against a server using a single multi-core machine, measuring latency and throughput.
Is this a GUI app or a command-line tool?It is a command-line tool, invoked with flags like -t, -c, -d to configure threads, connections, and duration.
How do I run a benchmark with it?Build it and run something like 'wrk -t12 -c400 -d30s http://target', specifying threads, connections, and test duration.
What do I need installed to build and use it?It's written in C and uses LuaJIT for optional scripting; you build it from source with make (no package manager install mentioned).
Any gotchas when running big benchmarks?Your test machine needs enough free ephemeral ports with fast socket recycling, and the target server's listen backlog must exceed the number of concurrent connections, or results will be skewed.
Does it only run on Linux?It relies on scalable event notification systems like epoll (Linux) and kqueue (BSD/macOS), so it supports both platforms.
Can I customize the requests it sends?Yes, you can attach a LuaJIT script with -s to customize request generation, response processing, and reporting, as documented in SCRIPTING with examples in the scripts/ directory.
Does scripting slow down the benchmark?Simple scripts that just tweak the method, path, headers, or body have no performance impact, but per-request logic like building a new request each time or using response() will reduce achievable load.
Can I add custom headers or set a timeout?Yes, use -H to add an HTTP header to every request and --timeout to mark a request as failed if no response arrives within the given time; --latency prints detailed latency stats.
Does wrk use any existing open-source code?It incorporates the ae event loop from redis, the http-parser from nginx/joyent/node.js, and Mike Pall's LuaJIT.
What are similar projects?vegeta, hey, goreplay, locust, bazel, oha, lua-nginx-module, k6
Which topics is it in?load-testing, scalable, benchmarking, cpu, scripting, statistics, lua, http, c, testing, command-line, devops
Creator
wg
Size
37.8 MB
Stars
40.4K
Updated
CommitFeb 07
Age
14y
Commits · 90 Days