tor-commits July 2020

tor-commits@lists.torproject.org

17 participants
2100 discussions

[onionperf/develop] Rewrites/clarifies some text
by karsten＠torproject.org 02 Jul '20

02 Jul '20

commit 3c129c371a10a69a1789c1af4ac8495a0a783203 Author: Ana Custura <ana(a)netstat.org.uk> Date: Thu Jul 2 10:50:29 2020 +0100 Rewrites/clarifies some text --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7ffb900..1f58f0d 100644 --- a/README.md +++ b/README.md @@ -36,15 +36,15 @@ OnionPerf does not interfere with how Tor selects paths and builds circuits, oth ## Installation -OnionPerf has a couple dependencies in order to perform measurements or analyze and visualize measurement results. These dependencies include Tor, TGen (traffic generator), and a couple Python packages. +OnionPerf has several dependencies in order to perform measurements or analyze and visualize measurement results. These dependencies include Tor, TGen (traffic generator), and a few Python packages. The following description was written with a Debian system in mind but should be transferable to other Linux distributions and possibly even other operating systems. ### Tor -OnionPerf relies on the `tor` binary to start a Tor client on the client side and another one on the server side to host onion services. +OnionPerf relies on the `tor` binary to start a Tor client process on the client side and a server side process to host onion services. -The easiest way is to install the `tor` package, which puts the `tor` binary into the `PATH` where OnionPerf will find it. Optionally, systemd can be instructed to make sure that `tor` is never started as a service: +The easiest way to satisfy this dependency is to install the `tor` package, which puts the `tor` binary into the `PATH` where OnionPerf will find it. Optionally, systemd can be instructed to make sure that `tor` is never started as a service: ```shell sudo apt install tor @@ -88,7 +88,7 @@ The TGen binary will be contained in `~/tgen/build/tgen`, which is also the path OnionPerf is written in Python 3. The following instructions assume that a Python virtual environment is being used, even though installation is also possible without that. -The virtual environment is being created, activated, and tested using: +The virtual environment is created, activated, and tested using: ```shell sudo apt install python3-venv @@ -100,14 +100,14 @@ which python3 The last command should output something like `~/venv/bin/python3` as the path to the `python3` binary used in the virtual environment. -In the next step, the OnionPerf repository is being cloned and requirements are being installed: +The next step is to clone the OnionPerf repository and install its requirements: ```shell git clone https://git.torproject.org/onionperf.git pip3 install --no-cache -r onionperf/requirements.txt ``` -The next step after that is to install OnionPerf and print out the usage information to see if the installation was successful: +The final step is to install OnionPerf and print out the usage information to see if the installation was successful: ```shell cd onionperf/ @@ -122,7 +122,7 @@ The virtual environment is deactivated with the following command: deactivate ``` -However, in order to perform measurements or doing analyses, the virtual environment needs to be activated first. This will ensure all the paths are found. +However, in order to perform measurements or analyses, the virtual environment needs to be activated first. This will ensure all the paths are found. ## Measurement @@ -133,7 +133,7 @@ Ideally, OnionPerf is run detached from the terminal session using tmux, systemd ### Starting and stopping measurements -The most trivial configuration is to measure onion services only. In that case, OnionPerf is taking care of all configurations, and there are no firewall rules or port forwards to take care of. +The most trivial configuration is to measure onion services only. In that case, OnionPerf runs without needing any additional configuration. For direct measurements via exit nodes, firewall rules or port forwarding may be required to allow inbound connections to the TGen server. Starting these measurements is as simple as:

1 0

[onionperf/develop] Minor spelling, adds TOC
by karsten＠torproject.org 02 Jul '20

02 Jul '20

commit 508d3bccedc56af6559bcb5e367172dffec73a05 Author: Ana Custura <ana(a)netstat.org.uk> Date: Thu Jul 2 10:02:47 2020 +0100 Minor spelling, adds TOC --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9f0faf4..b66d6bc 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,30 @@ # OnionPerf - -[TOC] + * [Overview](#overview) + + [What does OnionPerf do?](#what-does-onionperf-do-) + + [What does OnionPerf *not* do?](#what-does-onionperf--not--do-) + * [Installation](#installation) + + [Tor](#tor) + + [TGen](#tgen) + + [OnionPerf](#onionperf-1) + * [Measurement](#measurement) + + [Starting and stopping measurements](#starting-and-stopping-measurements) + + [Output directories and files](#output-directories-and-files) + + [Changing Tor configurations](#changing-tor-configurations) + + [Changing the TGen traffic model](#changing-the-tgen-traffic-model) + + [Sharing measurement results](#sharing-measurement-results) + + [Troubleshooting](#troubleshooting) + * [Analysis](#analysis) + + [Analyzing measurement results](#analyzing-measurement-results) + + [Visualizing measurement results](#visualizing-measurement-results) + + [Interpreting the PDF output format](#interpreting-the-pdf-output-format) + + [Interpreting the CSV output format](#interpreting-the-csv-output-format) + * [Contributing](#contributing) ## Overview ### What does OnionPerf do? -OnionPerf measures performance of bulk file downloads over Tor. Together with its predecessor, Torperf, Onionperf has been used to measure long-term performance trends in the Tor network since 2009. It is also being used to perform short-term performance experiments to compare different Tor configurations or implementations. +OnionPerf measures performance of bulk file downloads over Tor. Together with its predecessor, Torperf, OnionPerf has been used to measure long-term performance trends in the Tor network since 2009. It is also being used to perform short-term performance experiments to compare different Tor configurations or implementations. OnionPerf uses multiple processes and threads to download random data through Tor while tracking the performance of those downloads. The data is served and fetched on localhost using two TGen (traffic generator) processes, and is transferred through Tor using Tor client processes and an ephemeral Tor onion service. Tor control information and TGen performance statistics are logged to disk and analyzed once per day to produce a JSON analysis file that can later be used to visualize changes in Tor client performance over time. @@ -180,7 +198,7 @@ For example, the hard-coded traffic model generated by OnionPerf and executed by ### Sharing measurement results -Measurement results can be further analyzed and visualized on the measuring host. But in many cases it's more conventient to do analysis and visualization on another host, also to compare measurements from different hosts to each other. +Measurement results can be further analyzed and visualized on the measuring host. But in many cases it's more convenient to do analysis and visualization on another host, also to compare measurements from different hosts to each other. There are at least two common ways of sharing measurement results:

1 0

[onionperf/develop] Rewrite a sentence, add a paragraph.
by karsten＠torproject.org 02 Jul '20

02 Jul '20

commit b677afc53c3885085c83c12b2b8f6967021f5033 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Thu Jul 2 16:19:08 2020 +0200 Rewrite a sentence, add a paragraph. --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1f58f0d..46abd01 100644 --- a/README.md +++ b/README.md @@ -42,7 +42,7 @@ The following description was written with a Debian system in mind but should be ### Tor -OnionPerf relies on the `tor` binary to start a Tor client process on the client side and a server side process to host onion services. +OnionPerf relies on the `tor` binary to start a Tor process on the client side to make client requests and another Tor process on the server side to host onion services. The easiest way to satisfy this dependency is to install the `tor` package, which puts the `tor` binary into the `PATH` where OnionPerf will find it. Optionally, systemd can be instructed to make sure that `tor` is never started as a service: @@ -288,6 +288,12 @@ The CSV output file contains the same data that is visualized in the PDF file. I - `time_to_first_byte` is the time in seconds (with microsecond precision) to download the first byte. - `time_to_last_byte` is the time in seconds (with microsecond precision) to download the last byte. +### Visualizations on Tor Metrics + +The analysis and visualization steps above can all be done by using the OnionPerf tool. In addition to that it's possible to visualize OnionPerf analysis files using other tools. + +For example, the [Tor Metrics website](https://metrics.torproject.org/torperf.html) contains various graphs based OnionPerf data. + ## Contributing The OnionPerf code is developed at https://gitlab.torproject.org/tpo/metrics/onionperf.

1 0

[onionperf/develop] Merge branch 'task-40001' into develop
by karsten＠torproject.org 02 Jul '20

02 Jul '20

commit 454c045013ea2b6f669819fe702a0f794cc59927 Merge: 83e4b52 e305128 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Thu Jul 2 21:02:01 2020 +0200 Merge branch 'task-40001' into develop README.md | 558 ++++++++++++++++--------------------------- onionperf/docs/Makefile | 20 -- onionperf/docs/conf.py | 166 ------------- onionperf/docs/index.rst | 21 -- onionperf/docs/onionperf.rst | 269 --------------------- 5 files changed, 208 insertions(+), 826 deletions(-)

1 0

[onionperf/develop] Bump version to 0.5.
by karsten＠torproject.org 02 Jul '20

02 Jul '20

commit adece5d55b8eb7eab03167f5bdd91330ba195b36 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Thu Jul 2 21:06:31 2020 +0200 Bump version to 0.5. --- setup.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/setup.py b/setup.py index f779267..d15157f 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ with open('requirements.txt') as f: install_requires = f.readlines() setup(name='OnionPerf', - version='0.3', + version='0.5', description='A utility to monitor, measure, analyze, and visualize the performance of Tor and Onion Services', author='Rob Jansen', url='https://github.com/robgjansen/onionperf/',

1 0

[onionperf/develop] Update table of contents.
by karsten＠torproject.org 02 Jul '20

02 Jul '20

commit e30512870f0cccfa29f54b778025fa4d71417a19 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Thu Jul 2 20:58:41 2020 +0200 Update table of contents. Updated using: https://ecotrust-canada.github.io/markdown-toc/ --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 46abd01..77384c6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,6 @@ # OnionPerf - * [Overview](#overview) + + * [Overview](#overview) + [What does OnionPerf do?](#what-does-onionperf-do-) + [What does OnionPerf *not* do?](#what-does-onionperf--not--do-) * [Installation](#installation) @@ -18,6 +19,7 @@ + [Visualizing measurement results](#visualizing-measurement-results) + [Interpreting the PDF output format](#interpreting-the-pdf-output-format) + [Interpreting the CSV output format](#interpreting-the-csv-output-format) + + [Visualizations on Tor Metrics](#visualizations-on-tor-metrics) * [Contributing](#contributing) ## Overview

1 0

[onionperf/master] Merge branch 'task-40001' into develop
by karsten＠torproject.org 02 Jul '20

02 Jul '20

1 0

[onionperf/master] Update table of contents.
by karsten＠torproject.org 02 Jul '20

02 Jul '20

1 0

[onionperf/master] Bump version to 0.5.
by karsten＠torproject.org 02 Jul '20

02 Jul '20

1 0

[onionperf/master] Remove outdated documentation line.
by karsten＠torproject.org 02 Jul '20

02 Jul '20

commit 3e1d149f514d65a8083dd8c044f7a73b52457d28 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Mon Jun 22 16:59:52 2020 +0200 Remove outdated documentation line. This really serves as test commit to try out whether mirroring to GitLab works as expected. --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index eee945f..35d3b7d 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,6 @@ can later be used to visualize changes in Tor client performance over time. For more information, see https://git.torproject.org/onionperf -For a dockerized setup, see https://github.com/hiromipaw/onionperf-docker - ## Table of contents * [Quick deployment instructions](#quick-deployment-instructions)

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits July 2020