Skip to content
Snippets Groups Projects
Name Last commit Last update
README.md
relay_bw.py
requirements.txt

relay_bw

Minimal bandwidth measurer for a relay.

It works in a similar way to sbws, creating 2 hops circuits and downloading/uploading data, but it only measures the relay provided as an argument, not the whole Tor network.

It also doesn't perform aggregation nor scaling since that requires having bandwidth measurements for all the relays.

I doesn't generates any Bandwidth File.

It is intended to be used by operators that would like to check the bandwidth measurements that sbws calculates, which should be similar to the relay's bw_mean KeyValues in the published collector bandwidth files.

Installation

Download this repository:

git clone https://gitlab.torproject.org/juga/relay_bw
cd relay_bw

Install tor and virtualenv in your system and activate it.

In a Debian system:

sudo apt install tor virtualenv
virtualenv .venv
. .venv/bin/activate

Then install the required libreries:

pip install -r requirements.txt

Run it

python3 relay_bw.py -h

It'll print the help with the arguments you should pass to it.

Author: juga at torproject.org

Copyright (c) 2023, The Tor Project, Inc.

Released under the BSD-3-Clause, which applies to all the source code and binary files except otherwise stated.