wsperf is a WebSocket load testing probe that can be used for load testing and performance benchmarking of WebSocket servers:

• comes as a command line tool that builds on WebSocket , a high-performance C /ASIO based WebSocket library.
• designed to work stand-alone or being controlled from wstest, which comes as part of the Autobahn WebSocket testsuite.

The first test mode implemented is WebSocket Handshaking.

In this mode, wsperf will:

1. open a TCP connection to a testee
2. perform a WebSocket opening handshake
3. perform a WebSocket closing handshake
4. close the TCP connection

It can do so in parallel and using multiple threads. You can fine control exactly how it operates (see usage section below).

It will create a detailed log file (JSON format) with high-precision timestamps for all states a connection goes through (and also of course if the connection was successful at all).

The generated log file can then be post-processed with wstest to obtain statistics like in the following:

Aggregate results (WebSocket Opening Closing Handshake)

          Duration:      13.4 s
             Total:    200000
           Success:    200000
              Fail:         0
            Fail %:      0.00
    Handshakes/sec:     14883

     Min:       2.0 ms
      SD:      10.7 ms
     Avg:      67.6 ms
  Median:      67.3 ms
  q90   :      81.2 ms
  q95   :      85.2 ms
  q99   :      93.2 ms
  q99.9 :     104.9 ms
  q99.99:     108.3 ms
     Max:     109.2 ms


Analyze done.

wsperf is currently developed and tested on Unix like systems (I use Ubuntu 12.04 LTS x64).

You will need a decent C compiler, currently at least GCC 4.6 or clang X.X.

The only dependencies of wsperf are:

• Boost
• WebSocket

Don't waste time on your distro's packaged Boost - likely too old. Build from the source, Luke;)

Also see the Boost Getting Started.

Get Boost from here.

cd ~/build
tar xvjf ../tarballs/boost_1_55_0b1.tar.bz2
cd boost_1_55_0b1
./bootstrap.sh --prefix=$HOME/boost_1_55_0b1
./b2 -j 4 install

This will take a little time.

WebSocket is a header-only library. So all you need is:

cd ~/scm
git clone [email protected]:zaphoyd/websocketpp.git

wsperf is built using SCons, a Python based build tool.

So if you have Python installed, all you need is:

easy_install scons

To build wsperf, you will need to have 2 environment variables set:

• BOOST_ROOT pointing to a Boost installation
• WSPP_ROOT pointing to a WebSocket source distribution

Like add the following to your .bashrc:

export BOOST_ROOT=${HOME}/boost_1_55_0b1
export WSPP_ROOT=${HOME}/scm/websocketpp

Now get the source and build

cd ~/scm
git clone [email protected]:zaphoyd/wsperf.git
cd wsperf
scons

When successful, this should produce a wsperf executable (optimized, statically linked and unstripped).

To cleanup

scons -uc

Basic usage of wsperf:

wsperf <wsuri> <threads> <connections> <low_watermark> <high_watermark> <result_file>

like e.g.

wsperf ws://127.0.0.1:9500 4 200000 1000 2000 results.json

The wsuri the the WebSocket address of the testee.

The threads parameter controls the number of background worker threads to be spawned.

It can also be 0 in which case the load is processed on the main thread. Note that ASIO will nevertheless create a background thread of asynchronous name resolution. So you see 2 threads for wsperf even if run with threads==0.

The connections is the total number of WebSocket connections that are opened to the testee - not concurrently, but in total. Also note that wsperf will currently not retry a failing connection.

The result_file is the name of the log file to produce.

The low_watermark and high_watermark control how many parallel connections will be in flight as follows:

wsperf will open new TCP connections to the testee and perform WebSocket opening handshakes on those as fast as it can up till the high_watermark connections is reached. That is connections which have not yet again been closed.

When that happens, it will stop trying to connect more. After some time, more WebSocket connections will get closed again (by performing a closing handshakes), and the outstanding number reaches the low_watermark, wsperf will start again connecting as fast as it can.

So the watermarks limit the number of WebSocket connections that haven't yet reached the "open" state .. hence are still in flight.

Writeme.