Benchmark a WebSocket server's message throughput ⌛

Andrew Healey

Last update: Nov 17, 2022

Related tags

Overview

📻 WebSocket Benchmarker ⌚

Message throughput is how fast a WebSocket server can parse and respond to a message. Some people consider this to be a good reference of a framework/library/server's performance. This tool measures the message throughput under load by mocking concurrent clients.

2019.01.26

Now with 100% more bleeding edge ⚡ asyncio goodness.

Installation

Python 3.6.5+.

pip install -r requirements.txt

Usage

This program expects the host to be an echo server and measures the time between sending a message and recieving the same message back from the host. It performs this for a number of client connections simultaneously and is designed to produce repeatable results.

python bench.py will launch the benchmark and print statistics to stdout. If the log file path is to a non-file then one will be created otherwise results will be appended to the existing file.

The raw results are in CSV format with each line representing a client's roundtrip times.

E.g., 0.1, 0.1, 0.1 for one client performing three roundtrips.

Arg	Description	Default
`--h`	Host address of WebSocket server	`localhost:3000`
`--n`	Number of clients to create	`1000`
`--c`	Number of concurrent clients	`64`
`--r`	Roundtrips per client	`5`
`--s`	Message size in characters	`30`
`--l`	Path to create or append to a log file	`./log.txt`

Tests

Full end-to-end testing via unittest.

python -m unittest
...
----------------------------------------------------------------------
Ran 3 tests in 8.371s

OK

License

Inspiration taken from the unmaintained JavaScript project websocket-benchmark.

You might also like...

Whatsapp Clone using django, django-channels and websocket

Comments

Add in-terminal line graph representing the benchmark result

In addition to the current statistics provided by bench.py, it would be useful to track the performance over time. E.g., maybe the roundtrip latency grows or shrinks rather than remaining static.

A terminal line chart or graph, printed at the end of a benchmark, would accomplish this.
help wanted good first issue hacktoberfest

opened by healeycodes 0