commit 508d3bccedc56af6559bcb5e367172dffec73a05 Author: Ana Custura ana@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: