[metrics-bugs] #28615 [Metrics/Library]: Additional @type annotation

Tor Bug Tracker & Wiki blackhole at torproject.org
Fri Jan 18 20:44:57 UTC 2019


#28615: Additional @type annotation
-----------------------------+------------------------------
 Reporter:  atagar           |          Owner:  metrics-team
     Type:  enhancement      |         Status:  new
 Priority:  Medium           |      Milestone:
Component:  Metrics/Library  |        Version:
 Severity:  Normal           |     Resolution:
 Keywords:                   |  Actual Points:
Parent ID:                   |         Points:
 Reviewer:                   |        Sponsor:
-----------------------------+------------------------------
Changes (by atagar):

 * cc: teor, juga (added)


Comment:

 > What do you suggest as @type annotation for bandwidth files?

 Perfect question, and something I intentionally neglected to mention
 because I don't know for certain. The spec uses the terms 'bandwidth file'
 or 'bandwidth list', and in Stem I opted to call the class a
 BandwidthMetric. Adding juga and teor to this ticket to see if they have
 an opinion on which they want...

 {{{
 @type bandwidth 1.2
 @type bandwidth-file 1.2
 @type bandwidth-list 1.2
 @type bandwidth-metric 1.2
 }}}

 **juga, teor: any preference on which of the above you like best?**

 For what it's worth a couple other things worth noting...

 * juga mentioned adding these to CollecTor, so the addition of a @type
 annotation of it will probably be of particular interest to you soon as
 well.
 * Bandwidth files already have multiple versions. According to #29056
 these documents have versions 1.0, 1.1, and 1.2 (not to be confused with
 software versions, which are moot for this ticket and include torflow,
 sbws 0.1.0, sbws 1.0.0, and sbws 1.0.3).

 > @type detached-signature 1.0 seems plausible to me. Let's add it.

 Great!

 > Oh, and I wonder if @type network-status-entry-3 1.0 would be more
 consistent with the consensus and vote equivalents, what do you think?

 Sure, fine with me. I don't mind what the name is and '@type network-
 status-entry-3' sounds fine.

 > The unflavored or the microdesc-flavored entry?

 Good question, and one that previously caused quite a bit of confusion. My
 understanding is that the answer is **unflavored**...

 https://gitweb.torproject.org/stem.git/commit/?id=136537c
 https://trac.torproject.org/projects/tor/ticket/24110

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


More information about the metrics-bugs mailing list