[metrics-bugs] #29787 [Metrics/Onionperf]: Enumerate possible failure cases and include failure information in .tpf output

[Tor Bug Tracker & Wiki]

#29787: Enumerate possible failure cases and include failure information in .tpf
output
-------------------------------+------------------------------
 Reporter:  karsten            |          Owner:  metrics-team
     Type:  enhancement        |         Status:  new
 Priority:  Medium             |      Milestone:
Component:  Metrics/Onionperf  |        Version:
 Severity:  Normal             |     Resolution:
 Keywords:                     |  Actual Points:
Parent ID:                     |         Points:
 Reviewer:                     |        Sponsor:
-------------------------------+------------------------------

Comment (by acute):

 Replying to [comment:29 karsten]:
 > Replying to [comment:28 acute]:

 > Would you mind writing down a quick how-to for installing/running this
 on a vanilla Debian/Ubuntu host? Like, what packages are required, where
 do we get Stem from, do we need `python` or `python3`, is an installation
 required, etc.? It seems like a lot of things have changed, and the README
 isn't fully up-to-date anymore. Thanks!

 For a debian stable installation, the instructions in
 https://github.com/torproject/onionperf/ appear to work with the only
 change that tor needs to be built from source or installed from backports.
 Here is a step-by-step short version:

 {{{
 sudo apt install cmake make build-essential gcc libigraph0-dev
 libglib2.0-dev python-dev libxml2-dev python-lxml python-networkx python-
 scipy python-matplotlib python-numpy libevent-dev libssl-dev

 echo 'deb http://deb.debian.org/debian stretch-backports main' >>
 /etc/apt/sources.list
 apt update
 apt-get -t stretch-backports install python-stem tor


 git clone https://github.com/shadow/tgen.git
 cd tgen
 mkdir build
 cd build
 cmake .. -DCMAKE_INSTALL_PREFIX=/home/$USER/.local
 make
 ln -s ~/tgen/build/tgen /usr/bin/tgen

 git clone https://github.com/ana-cc/onionperf
 cd onionperf
 git checkout steins_gate
 sudo python setup.py build
 sudo python setup.py install
 }}}

 To call reprocessing, you need to point OP at the directories where the
 logs are, and then it does the rest. You can additionally tell it where to
 put the results. This will multiprocess the logs, expanding to the number
 of available cores. On my 4-core i5 it took about 45 minutes to process 3
 months' worth of data from op-ab.
 {{{
 onionperf reprocess --tgen-dir onionperf-data/tgen-client/ --torctl-dir
 onionperf-data/tor-client/ --prefix my-new-results/
 }}}

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/29787#comment:30>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online