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
Что это за программа?wrk — это современный инструмент для тестирования производительности HTTP, который создаёт большую нагрузку на сервер с одной многоядерной машины и измеряет задержку и пропускную способность.
Это приложение с графическим интерфейсом или инструмент командной строки?Это инструмент командной строки; он запускается с флагами вроде -t, -c, -d для настройки потоков, соединений и длительности.
Как запустить тест производительности?Соберите программу и запустите что-то вроде 'wrk -t12 -c400 -d30s http://target', указав количество потоков, соединений и длительность теста.
Что нужно установить, чтобы собрать и использовать программу?Она написана на C и использует LuaJIT для необязательных скриптов; собирается из исходников командой make (установка через менеджер пакетов не упоминается).
Есть ли подводные камни при запуске больших тестов?На тестовой машине должно хватать свободных эфемерных портов с быстрым переиспользованием сокетов, а очередь listen (backlog) целевого сервера должна превышать число одновременных соединений, иначе результаты будут искажены.
Работает ли она только в Linux?Она использует масштабируемые системы уведомлений о событиях, такие как epoll (Linux) и kqueue (BSD/macOS), поэтому поддерживает обе платформы.
Можно ли настроить отправляемые запросы?Да, можно подключить скрипт на LuaJIT с помощью -s, чтобы настроить формирование запросов, обработку ответов и отчёты; это описано в SCRIPTING, примеры — в каталоге scripts/.
Замедляет ли скриптинг тест?Простые скрипты, которые только меняют метод, путь, заголовки или тело, не влияют на производительность, а логика для каждого запроса, например создание нового запроса каждый раз или использование response(), снижает достижимую нагрузку.
Можно ли добавить свои заголовки или задать таймаут?Да: -H добавляет HTTP-заголовок к каждому запросу, а --timeout помечает запрос как неудачный, если ответ не пришёл за указанное время; --latency выводит подробную статистику задержек.
Использует ли wrk какой-то открытый код?Да, он включает цикл событий ae из redis, HTTP-парсер из nginx/joyent/node.js и 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