- Notifications
You must be signed in to change notification settings - Fork0
Ohayou(おはよう), HTTP load generator, inspired by rakyll/hey with tui animation.
License
WallarooLabs/oha
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
oha is a tiny program that sends some load to a web application and show realtime tui inspired byrakyll/hey.
This program is written in Rust and powered bytokio and beautiful tui byratatui.
This program is built on stable Rust, with bothmake andcmake prerequisites to install via cargo.
cargo install ohaYou can optionally build oha againstnative-tls instead ofrustls.
cargo install --no-default-features --features rustls ohaYou can enable VSOCK support by enablingvsock feature.
cargo install --features vsock ohaYou can download pre-built binary fromRelease page for each version and fromPublish workflow andPublish PGO workflow for each commit.
pacman -S ohabrew install ohawinget install hatoo.ohaOn Debian (Azlux's repository)
echo "deb [signed-by=/usr/share/keyrings/azlux-archive-keyring.gpg] http://packages.azlux.fr/debian/ stable main" | sudo tee /etc/apt/sources.list.d/azlux.listsudo wget -O /usr/share/keyrings/azlux-archive-keyring.gpg https://azlux.fr/repo.gpgapt updateapt install ohaYou can install withx-cmd.
x env use oha
You can also build and create a container image including oha
docker build. -t example.com/hatoo/oha:latestThen you can use oha directly through the container
docker run -it example.com/hatoo/oha:latest https://example.com:3000
You can buildoha with PGO by using the following commands:
bun run pgo.js
And the binary will be available attarget/[target-triple]/pgo/oha.
- Linux - Tested on Ubuntu 18.04 gnome-terminal
- Windows 10 - Tested on Windows Powershell
- MacOS - Tested on iTerm2
-q option works different fromrakyll/hey. It's set overall query per second instead of for each workers.
Ohayou(おはよう), HTTP load generator, inspired by rakyll/hey with tui animation.Usage: oha [OPTIONS]<URL>Arguments:<URL> Target URL or file with multiple URLs.Options: -n<N_REQUESTS> Number of requests to run. [default: 200] -c<N_CONNECTIONS> Number of connections to run concurrently. You may should increase limit to number of open filesfor larger`-c`. [default: 50] -p<N_HTTP2_PARALLEL> Number of parallel requests to send on HTTP/2.`oha` will run c* p concurrent workersin total. [default: 1] -z<DURATION> Duration of application to send requests. If duration is specified, n is ignored. On HTTP/1, When the duration is reached, ongoing requests are aborted and counted as"aborted due to deadline" You can change this behavior with`-w` option. Currently, on HTTP/2, When the duration is reached, ongoing requests are waited.`-w` option is ignored. Examples: -z 10s -z 3m. -w, --wait-ongoing-requests-after-deadline When the duration is reached, ongoing requests are waited -q<QUERY_PER_SECOND> Rate limitforall,in queries per second (QPS) --burst-delay<BURST_DURATION> Introduce delay between a predefined number of requests. Note: If qps is specified, burst will be ignored --burst-rate<BURST_REQUESTS> Rates of requestsfor burst. Default is 1 Note: If qps is specified, burst will be ignored --rand-regex-url Generate URL by rand_regex crate but dot is disabledfor each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. Currently dynamic scheme, host and port with keep-alivedo not work well. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.htmlfor details of syntax. --urls-from-file Read the URLs to query from a file --max-repeat<MAX_REPEAT> A parameterfor the'--rand-regex-url'. The max_repeat parameter gives the maximum extra repeat counts the x*, x+ and x{n,} operators will become. [default: 4] --dump-urls<DUMP_URLS> Dump target Urls<DUMP_URLS>times to debug --rand-regex-url --latency-correction Correct latency to avoid coordinated omission problem. It's ignored if -q is not set. --no-tui No realtime tui -j, --json Print results as JSON --fps <FPS> Frame per second for tui. [default: 16] -m, --method <METHOD> HTTP method [default: GET] -H <HEADERS> Custom HTTP header. Examples: -H "foo: bar" --proxy-header <PROXY_HEADERS> Custom Proxy HTTP header. Examples: --proxy-header "foo: bar" -t <TIMEOUT> Timeout for each request. Default to infinite. -A <ACCEPT_HEADER> HTTP Accept Header. -d <BODY_STRING> HTTP request body. -D <BODY_PATH> HTTP request body from file. -T <CONTENT_TYPE> Content-Type. -a <BASIC_AUTH> Basic authentication (username:password), or AWS credentials (access_key:secret_key) --aws-session <AWS_SESSION> AWS session token --aws-sigv4 <AWS_SIGV4> AWS SigV4 signing params (format: aws:amz:region:service) -x <PROXY> HTTP proxy --proxy-http-version <PROXY_HTTP_VERSION> HTTP version to connect to proxy. Available values 0.9, 1.0, 1.1, 2. --proxy-http2 Use HTTP/2 to connect to proxy. Shorthand for --proxy-http-version=2 --http-version <HTTP_VERSION> HTTP version. Available values 0.9, 1.0, 1.1, 2. --http2 Use HTTP/2. Shorthand for --http-version=2 --host <HOST> HTTP Host header --disable-compression Disable compression. -r, --redirect <REDIRECT> Limit for number of Redirect. Set 0 for no redirection. Redirection isn't supportedfor HTTP/2. [default: 10] --disable-keepalive Disable keep-alive, prevents re-use of TCP connections between different HTTP requests. This isn't supported for HTTP/2. --no-pre-lookup *Not* perform a DNS lookup at beginning to cache it --ipv6 Lookup only ipv6. --ipv4 Lookup only ipv4. --cacert <CACERT> (TLS) Use the specified certificate file to verify the peer. Native certificate store is used even if this argument is specified. --cert <CERT> (TLS) Use the specified client certificate file. --key must be also specified --key <KEY> (TLS) Use the specified client key file. --cert must be also specified --insecure Accept invalid certs. --connect-to <CONNECT_TO> Override DNS resolution and default port numbers with strings like'example.org:443:localhost:8443' Note: if used several times for the same host:port:target_host:target_port, a random choice is made --disable-color Disable the color scheme. --unix-socket <UNIX_SOCKET> Connect to a unix socket instead of the domain in the URL. Only for non-HTTPS URLs. --stats-success-breakdown Include a response status code successful or not successful breakdown for the time histogram and distribution statistics --db-url <DB_URL> Write succeeded requests to sqlite database url E.G test.db --debug Perform a single request and dump the request and response -o, --output <OUTPUT> Output file to write the results to. If not specified, results are written to stdout. -h, --help Print help -V, --version Print version
oha uses faster implementation when--no-tui option is set and both-q and--burst-delay are not set because it can avoid overhead to gather data realtime.
oha prints JSON output when-j option is set.The schema of JSON output is defined inschema.json.
oha uses default options inherited fromrakyll/hey but you may need to change options to stress test in more realistic condition.
I suggest to runoha with following options.
oha<-z or -n> -c<number of concurrent connections> -q<query per seconds> --latency-correction --disable-keepalive<target-address>
--disable-keepalive
In real, user doesn't query same URL usingKeep-Alive. You may want to run without
Keep-Alive.--latency-correction
You can avoid
Coordinated Omission Problemby using--latency-correction.
You can use--burst-delay along with--burst-rate option to introduce delay between a defined number of requests.
oha -n 10 --burst-delay 2s --burst-rate 4
In this particular scenario, every 2 seconds, 4 requests will be processed, and after 6s the total of 10 requests will be processed.NOTE: If you don't set--burst-rate option, the amount is default to 1
You can use--rand-regex-url option to generate random url for each connection.
oha --rand-regex-url http://127.0.0.1/[a-z][a-z][0-9]
Each Urls are generated byrand_regex crate but regex's dot is disabled since it's not useful for this purpose and it's very inconvenient if url's dots are interpreted as regex's dot.
Optionally you can set--max-repeat option to limit max repeat count for each regex. e.ghttp://127.0.0.1/[a-z]* with--max-repeat 4 will generate url likehttp://127.0.0.1/[a-z]{0,4}
Currently dynamic scheme, host and port with keep-alive are not works well.
You can use--urls-from-file to read the target URLs from a file. Each line of this file needs to contain one valid URL as in the example below.
http://domain.tld/foo/barhttp://domain.tld/assets/vendors-node_modules_highlight_js_lib_index_js-node_modules_tanstack_react-query_build_modern-3fdf40-591fb51c8a6e.jshttp://domain.tld/images/test.pnghttp://domain.tld/foo/bar?q=testhttp://domain.tld/fooSuch a file can for example be created from an access log to generate a more realistic load distribution over the different pages of a server.
When this type of URL specification is used, every request goes to a random URL given in the file.
Feel free to help us!
Here are some areas which need improving.
- Write tests
- Improve tui design.
- Show more information?
- Improve speed
- I'm new to tokio. I think there are some space to optimize query scheduling.