Installation

The easiest way to install pymqttbench is use pip:

pip install pymqttbench

Alternatively you can clone the repo with:

git clone https://github.com/mtreinish/pymqttbench.git

then install it using pip:

pip install ./pymqttbench

Alternatively you can run:

cd pymqttbench && python setup.py install

however using pip is recommended.

Usage

After installing pymqttbench you simply run it with the:

pymqttbench --hostname $BROKER_HOST

command. The hostname parameter is required to tell pymqttbench the hostname of the broker. This is the only required field, but there are several other options exposed for how to connect to the broker. --port is used to specify the port if you’re not connecting on the standard port, 1883. --username and --password are used to specify user authentication if needed. Similiarly --cacert can be used to specify a trusted CA certificate to verify the TLS connection on the broker. There is also the --topic parameter which is used to specify a topic to use for the benchmark, by default pybench is used. Note that all of these settings are used for both the publishers and subscribers.

Outside of mqtt connection options there is also the --brief flag which is used to print a colon separated list of benchmark results instead of the default human readable formatted output. The format for this output is:

Subscriber Count:Publisher Count:Subscriber Mean Duration:Subscriber Duration Std. Deviation:Subscriber Avg. Throughput:Subscriber Total Throughput:Publisher Mean Duration:Publisher Duration Std. Deviation:Publisher Avg. Throughput:Publisher Total Throughput