[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):

 Ok thank you for that (was indeed missing that day). This was very
 interesting to debug, and it is not a bug in my script unfortunately:

 I downloaded the op-ab hosted tgen and torctl log for 01-13 and recreated
 the json analysis file from them. It turns out the analysis file on op-ab
 is different than the one recreated from the same logs on my computer. I
 believe something has happened and onionperf has been cut short in the
 middle of the analysis for that particular day (my file is 16MB, op-ab's
 is 7.7MB). When I recreate any of the other json files from their
 respective logs (have tried for ~10 other days), the contents and sizes
 match up.

 The good news is, if you run the python script on the json file produced
 from the logs, all the missing errors are found.

 However, this is concerning. I have asked irl to examine op-ab for any
 clues as to what could have happened at midnight that day. As a first
 step, am thinking to write a script that rebuilds the analysis from the
 logs and validates the existing results. What do you think?

 To recreate my steps:

 {{{
   wget https://op-ab.onionperf.torproject.net/tgen-
 client/log_archive/onionperf_2019-01-13_23%3A59%3A59.tgen.log
   wget https://op-ab.onionperf.torproject.net/tor-
 client/log_archive/onionperf_2019-01-13_23%3A59%3A59.torctl.log
   onionperf analyze --tgen onionperf_2019-01-13_23:59:59.tgen.log --torctl
 onionperf_2019-01-13_23:59:59.torctl.log
   unxz onionperf.analysis.json.xz
   wget https://op-
 ab.onionperf.torproject.net/2019-01-13.onionperf.analysis.json.xz
   unxz 2019-01-13.onionperf.analysis.json.xz
   diff onionperf.analysis.json 2019-01-13.onionperf.analysis.json
 }}}

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