base on Ohayou(おはよう), HTTP load generator, inspired by rakyll/hey with tui animation. # oha (おはよう) [](https://github.com/hatoo/oha/actions?query=workflow%3ACI) [](https://crates.io/crates/oha) [](https://archlinux.org/packages/extra/x86_64/oha/) [](https://formulae.brew.sh/formula/oha) [](https://ko-fi.com/hatoo) oha is a tiny program that sends some load to a web application and show realtime tui inspired by [rakyll/hey](https://github.com/rakyll/hey). This program is written in Rust and powered by [tokio](https://github.com/tokio-rs/tokio) and beautiful tui by [ratatui](https://github.com/ratatui-org/ratatui).  # Installation This program is built on stable Rust, with both `make` and `cmake` prerequisites to install via cargo. cargo install oha You can optionally build oha against [native-tls](https://github.com/sfackler/rust-native-tls) instead of [rustls](https://github.com/rustls/rustls). cargo install --no-default-features --features native-tls oha You can enable VSOCK support by enabling `vsock` feature. cargo install --features vsock oha You can enable experimental HTTP3 support by enabling the `http3` feature. This uses the [H3](https://github.com/hyperium/h3/r) library by the developers of Hyper. It will remain experimental as long as H3 is experimental. It currently depends on using `rustls` for TLS. ## Download pre-built binary You can download pre-built binary from [Release page](https://github.com/hatoo/oha/releases) for each version and from [Publish workflow](https://github.com/hatoo/oha/actions/workflows/release.yml) and [Publish PGO workflow](https://github.com/hatoo/oha/actions/workflows/release-pgo.yml) for each commit. ## On Arch Linux pacman -S oha ## On macOS (Homebrew) brew install oha ## On Windows (winget) winget install hatoo.oha ## On Debian ([Azlux's repository](http://packages.azlux.fr/)) 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.list sudo wget -O /usr/share/keyrings/azlux-archive-keyring.gpg https://azlux.fr/repo.gpg apt update apt install oha ## X-CMD (Linux, macOS, Windows WSL/GitBash) You can install with [x-cmd](https://www.x-cmd.com). ```sh x env use oha ``` ## Containerized ### Official Docker image [ghcr.io/hatoo/oha](https://github.com/hatoo/oha/pkgs/container/oha) ### Build image locally You can also build and create a container image including oha ```sh docker build -t hatoo/oha:latest . ``` Then you can use oha directly through the container ```sh docker run --rm -it --network=host hatoo/oha:latest https://example.com:3000 ``` ## Profile-Guided Optimization (PGO) You can build `oha` with PGO by using the following commands: ```sh bun run pgo.js ``` And the binary will be available at `target/[target-triple]/pgo/oha`. **Note**: Please keep in mind that in order to run the aforementioned command, you need to have installed `cargo-pgo` cargo package. You can install it via `cargo install cargo-pgo`. # Platform - Linux - Tested on Ubuntu 18.04 gnome-terminal - Windows 10 - Tested on Windows Powershell - MacOS - Tested on iTerm2 # Usage `-q` option works different from [rakyll/hey](https://github.com/rakyll/hey). It's set overall query per second instead of for each workers. ```sh 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. Accepts plain numbers or suffixes: k = 1,000, m = 1,000,000 (e.g. 10k, 1m). [default: 200] -c <N_CONNECTIONS> Number of connections to run concurrently. You may should increase limit to number of open files for larger `-c`. [default: 50] -p <N_HTTP2_PARALLEL> Number of parallel requests to send on HTTP/2. `oha` will run c * p concurrent workers in total. [default: 1] -z <DURATION> Duration of application to send requests. 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 limit for all, 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 requests for 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 disabled for each query e.g. http://127.0.0.1/[a-z][a-z][0-9]. Currently dynamic scheme, host and port with keep-alive do not work well. See https://docs.rs/rand_regex/latest/rand_regex/struct.Regex.html for details of syntax. --urls-from-file Read the URLs to query from a file --max-repeat <MAX_REPEAT> A parameter for 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 --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. --connect-timeout <CONNECT_TIMEOUT> Timeout for establishing a new connection. Default to 5s. [default: 5s] -A <ACCEPT_HEADER> HTTP Accept Header. -d <BODY_STRING> HTTP request body. -D <BODY_PATH> HTTP request body from file. -Z <BODY_PATH_LINES> HTTP request body from file line by line. -F, --form <FORM> Specify HTTP multipart POST data (curl compatible). Examples: -F 'name=value' -F 'file=@path/to/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, 3 --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 supported for 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 --no-color Disable the color scheme. [env: NO_COLOR=] --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. --output-format <OUTPUT_FORMAT> Output format [default: text] [possible values: text, json, csv, quiet] -u, --time-unit <TIME_UNIT> Time unit to be used. If not specified, the time unit is determined automatically. This option affects only text format. [possible values: ns, us, ms, s, m, h] -h, --help Print help -V, --version Print version ``` # Performance `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. # Output By default `oha` outputs a text summary of the results. `oha` prints JSON summary output when `--output-format json` option is set. The schema of JSON output is defined in [schema.json](./schema.json). When `--output-format csv` is used result of each request is printed as a line of comma separated values. # Tips ## Stress test in more realistic condition `oha` uses default options inherited from [rakyll/hey](https://github.com/rakyll/hey) but you may need to change options to stress test in more realistic condition. I suggest to run `oha` with following options. ```sh 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 using [Keep-Alive](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Keep-Alive). You may want to run without `Keep-Alive`. - --latency-correction You can avoid `Coordinated Omission Problem` by using `--latency-correction`. ## Burst feature You can use `--burst-delay` along with `--burst-rate` option to introduce delay between a defined number of requests. ```sh 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* ## Dynamic url feature You can use `--rand-regex-url` option to generate random url for each connection. ```sh oha --rand-regex-url http://127.0.0.1/[a-z][a-z][0-9] ``` Each Urls are generated by [rand_regex](https://github.com/kennytm/rand_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.g http://127.0.0.1/[a-z]* with `--max-repeat 4` will generate url like http://127.0.0.1/[a-z]{0,4} Currently dynamic scheme, host and port with keep-alive are not works well. ## URLs from file feature 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/bar http://domain.tld/assets/vendors-node_modules_highlight_js_lib_index_js-node_modules_tanstack_react-query_build_modern-3fdf40-591fb51c8a6e.js http://domain.tld/images/test.png http://domain.tld/foo/bar?q=test http://domain.tld/foo ``` Such 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. # Contribution 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. ", Assign "at most 3 tags" to the expected json: {"id":"11641","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"