[tor-bugs] #33391 [Metrics/Onionperf]: Add new metadata fields and definitions

[Tor Bug Tracker & Wiki]

#33391: Add new metadata fields and definitions
-----------------------------------------+------------------------------
 Reporter:  acute                        |          Owner:  metrics-team
     Type:  enhancement                  |         Status:  new
 Priority:  Medium                       |      Milestone:
Component:  Metrics/Onionperf            |        Version:
 Severity:  Normal                       |     Resolution:
 Keywords:  metrics-team-roadmap-2020Q1  |  Actual Points:
Parent ID:  #33323                       |         Points:  1
 Reviewer:                               |        Sponsor:
-----------------------------------------+------------------------------

Comment (by acute):

 To do this, I'd like to propose we add a function to the analysis code to
 allow inclusion of metadata provided in a JSON file. This would be a
 dictionary holding metadata. Possible metadata could include fields to
 describe the experiment type (e.g., EXP_TYPE) or git commit hash of the
 code that is running (e.g., EXP_COMMIT) or anything that might be useful.
 The json file would be specified on the command line, as an optional
 argument:

 {{{onionperf measure ... --metadata <meta.json>}}}
 or
 {{{onionperf analyze ... --metadata <meta.json>}}}

 The key value pairs would be added to the resulting json and tpf outputs.

 This can help the our team tell the difference between experimental and
 non-experimental data, and also allows us and Mike to tell the different
 experimental data apart in the case of multiple experiments, to a good
 granularity. Thoughts?

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