Skip to content

ferronweb/ferrbench

Repository files navigation

FerrBench

A more modern http framework benchmark utility, based on rewrk.

F:\ferrbench> ferrbench -h http://127.0.0.1:5000 -t 12 -c 60 -d 5s

Benchmarking 60 connections @ http://127.0.0.1:5000 for 5 seconds
  Latencies:
    Avg      Stdev    Min      Max    
    3.27ms   0.40ms   1.95ms   9.39ms
  Requests:
    Total:  91281  Req/Sec: 18227.81
  Transfer:
    Total: 1.13 MB Transfer Rate: 231.41 KB/Sec

With optional --pct flag

+ --------------- + --------------- +
|   Percentile    |   Avg Latency   |
+ --------------- + --------------- +
|      99.9%      |     6.88ms      |
|       99%       |     5.62ms      |
|       95%       |     4.62ms      |
|       90%       |     4.24ms      |
|       75%       |     3.78ms      |
|       50%       |     3.49ms      |
+ --------------- + --------------- +

Motivation

The motivation behind this project extends from developers tunnel visioning on benchmarks like techempower that use the benchmarking tool called wrk.

The issue is that wrk only handle some of the HTTP spec and is entirely biased towards frameworks and servers that can make heavy use of HTTP/1 Pipelining which is no longer enabled in most modern browsers or clients, this can give a very unfair and unreasonable set of stats when comparing frameworks as those at the top are simply better at using a process which is now not used greatly.

This is where FerrBench comes in, this benchmarker is built on top of hyper's client api and brings with it many advantages and more realistic methods of benchmarking.

Current features

  • Supports both HTTP/1 and HTTP/2.
  • Pipelining is disabled giving a more realistic idea on actual performance.
  • Cross-platform support.

To do list

  • Add a random artificial delay benchmark to simulate random latency with clients.
  • Arithmetic benchmark to simulate different loads across clients.
  • State checking, making the frameworks and servers use all of their API rather than a minimised set.
  • JSON deserialization and validation benchmarks and checking.
  • Truly concurrent HTTP/2 benchmark.

Usage

Usage is relatively simple, if you have a compiled binary simply run using the CLI.

Example

Here's an example to produce the following benchmark:

  • 256 connections (-c 256)
  • HTTP/2 only (--http2)
  • 12 threads (-t 12)
  • 15 seconds (-d 15s)
  • with percentile table (--pct)
  • on host http://127.0.0.1:5000 (-h http://127.0.0.1:5000)

CLI command:
ferrbench -c 256 -t 12 -d 15s -h http://127.0.0.1:5000 --http2 --pct

CLI Help

To bring up the help menu simply run ferrbench --help to produce this:

Benchmark HTTP/1 and HTTP/2 frameworks without pipelining bias.

Usage: ferrbench [OPTIONS] --host <host> --duration <duration>

Options:
      --help                       Print help
  -t, --threads <threads>          Set the amount of threads to use e.g. '-t 12' [default: 1]
  -c, --connections <connections>  Set the amount of concurrent e.g. '-c 512' [default: 1]
  -h, --host <host>                Set the host to bench e.g. '-h http://127.0.0.1:5050'
      --http2...                   Set the client to use http2 only. (default is http/1) e.g. '--http2'
  -d, --duration <duration>        Set the duration of the benchmark.
      --pct...                     Displays the percentile table after benchmarking.
      --json...                    Displays the results in a json format
  -r, --rounds <rounds>            Repeats the benchmarks n amount of times
  -m, --method <method>            Set request method e.g. '-m get'
  -H, --header <header>            Add header to request e.g. '-H "content-type: text/plain"'
  -b, --body <body>                Add body to request e.g. '-b "foo"'
  -V, --version                    Print version

Building from source

Building from source is incredibly simple, just make sure you have a stable version of Rust installed before you start.

With Cargo Install

    • Run cargo install ferrbench --git https://github.com/ferronweb/ferrbench.git

With Cargo Run

    • Clone the repo source code
    • Run cargo run --release -- <enter flags here>

With Cargo Build

    • Clone the repo source code
    • Run cargo build --release
    • Extract the binary from the release folder
    • Binary ready to use.

About

A modern HTTP benchmarking tool supporting HTTP/1 and HTTP/2 benchmarks, based on rewrk.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 9