bro

bro is a load testing tool that enables you to run scenarios with both constant and variable rate traffic patterns.

During execution, it collects metrics such as RPS (requests per second), latency, and errors, and validates them against predefined thresholds.

The tool supports parallel scenario execution, making it easy to run benchmarks.

Installation

The tool is written in Go. You can compile the binary from the source code to run it on your local machine, or you can run it as a Docker container.

Building from source codes

Make sure you have Go installed and GOPATH is set up correctly.

Clone this repository and run make install:

git clone https://github.com/lameaux/bro.git
cd bro
make install

You will have bro binary installed in $GOPATH/bin, make sure it is present in your PATH.

bro -r 10 -t 2 -d 5s -u https://httpbin.org

Alternatively, you can use the binary from the ./bin directory:

./bin/bro -r 10 -t 2 -d 5s -u https://httpbin.org

Running in a Docker container

docker run --rm ghcr.io/lameaux/bro -r 10 -t 2 -d 5s -u https://httpbin.org

Usage

To run the app, you need to define a testing scenario — either by providing a YAML file or by specifying it directly through program arguments (flags).

See docs for more details on how to use the app.

YAML file

To run the test you need to provide a path to a YAML file with scenario configuration.

bro [flags] path/to/config.yaml

To run one of the examples:

bro -silent examples/ping/httpbin.yaml

Name: Ping httpbin
Path: examples/ping/httpbin.yaml
┌──────────────┬───────┬─────────┬────────┬─────────┬─────────┬──────────────┬──────────┬─────┬────────┐
│ SCENARIO     │ TOTAL │ SUCCESS │ FAILED │ TIMEOUT │ INVALID │ LATENCY @P99 │ DURATION │ RPS │ PASSED │
├──────────────┼───────┼─────────┼────────┼─────────┼─────────┼──────────────┼──────────┼─────┼────────┤
│ Check 200 OK │    50 │      50 │      0 │       0 │       0 │ 1083 ms      │   5.194s │  10 │ true   │
└──────────────┴───────┴─────────┴────────┴─────────┴─────────┴──────────────┴──────────┴─────┴────────┘
Total duration: 5.194s
OK

See docs and examples for more details on how to write scenarios.

Program arguments

You can run a test by providing scenario configuration using program arguments:

bro [flags] -r <rps> -t <threads> -d <duration> -u <url>

For example:

bro -silent -r 10 -t 2 -d 5s -u https://httpbin.org

Name: Calling https://httpbin.org
┌──────────┬───────┬─────────┬────────┬─────────┬─────────┬──────────────┬──────────┬─────┬────────┐
│ SCENARIO │ TOTAL │ SUCCESS │ FAILED │ TIMEOUT │ INVALID │ LATENCY @P99 │ DURATION │ RPS │ PASSED │
├──────────┼───────┼─────────┼────────┼─────────┼─────────┼──────────────┼──────────┼─────┼────────┤
│ flags    │    50 │      50 │      0 │       0 │       0 │ 914 ms       │   5.104s │  10 │ true   │
└──────────┴───────┴─────────┴────────┴─────────┴─────────┴──────────────┴──────────┴─────┴────────┘
Total duration: 5.104s
OK

See docs for more details on how to write scenarios.

Flags

There is a list of flags that you can use with bro:

Usage of bro:
  -brodAddr string
        address (host:port) of brod, e.g. brod:8080
  -d duration
        alias for duration
  -debug
        set log level to DEBUG
  -duration duration
        scenario duration, e.g. 5s
  -f string
        alias for format (default "txt")
  -format string
        format: txt or csv (default "txt")
  -group string
        test group identifier
  -logJson
        set log output format as JSON
  -m string
        alias for method
  -method string
        http method, e.g. POST
  -o string
        alias for output (default "stdout")
  -output string
        output: stdout, path/to/file (default "stdout")
  -r int
        alias for rps
  -rps int
        target RPS for scenario
  -silent
        set log level to ERROR
  -skipBanner
        do not show banner on start up
  -skipExitCode
        do not set exit code on test failure
  -t int
        alias for threads
  -threads int
        number of concurrent threads for scenario
  -timeout duration
        http request timeout duration, e.g. 5s
  -u    alias for url
  -url
        target URL for scenario

See docs for more details.

What's next?

• Try bro together with mox, a tool for stubbing external dependencies, to test your application in isolation.
• Check out NFT repo to see advanced scenarios for non-functional testing using bro & mox .