[metrics-bugs] #21414 [Metrics]: Should metrics web sites (metrics.tp.o, collector.tp.o, onionoo.tp.o) display currently running software version?

Tor Bug Tracker & Wiki blackhole at torproject.org
Wed Mar 1 17:01:02 UTC 2017


#21414: Should metrics web sites (metrics.tp.o, collector.tp.o, onionoo.tp.o)
display currently running software version?
-------------------------+------------------------------
 Reporter:  iwakeh       |          Owner:  metrics-team
     Type:  enhancement  |         Status:  new
 Priority:  Low          |      Milestone:
Component:  Metrics      |        Version:
 Severity:  Normal       |     Resolution:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
 Reviewer:               |        Sponsor:
-------------------------+------------------------------

Comment (by iwakeh):

 Replying to [comment:4 karsten]:
 > So, if we go ahead with #21551 and merge CollecTor and Onionoo sites
 into the Metrics website, we'll have to adapt this ticket a bit.  In that
 case it would still make sense for CollecTor and Onionoo to reveal the
 version they're running, just not on an HTML page:

 That's true.

 >
 >  - CollecTor could include an `"implementation_version"` field in its
 `/index/index.json*` files.  That field could contain the same value that
 we're including as `Implementation-Version` in the build file, e.g.,
 `"1.1.2-ef96cf8"` for the latest release.

 Good place; and the json could even be used to include it into a web page
 (I assume), if necessary or maybe the non-standard collector operators
 might make use of it, too.

 >
 >  - Onionoo could likewise include an `"implementation_version"` in the
 header of all its responses.  It already contains the protocol
 `"version"`, like `"4.0"`, but including something like `"1.2.0-4717532"`
 might turn out to be really helpful for debugging.  We should be careful
 with modifying the required `"version"` field though.

 Right, 'version' should not be changed as it is a machine detectable
 protocol field.  Adding 'implementation_version' is fine. Maybe make it
 optional to prevent people from relying on it instead of 'version'?

 >
 >  - Metrics would not include a version number if we move forward with
 #21551, because we would continue with not putting out releases for it.
 But it might still make sense to put the Git commit (short, 7 characters)
 in the page footer.  After all, the graphs will remain part of Metrics,
 and knowing which exact version is deployed might make debugging easier.
 But that's really something that the average user wouldn't care about, so
 we should make it tiny.  Or we could even put it as comment into the page
 sources, except that we'd be the only ones knowing where to find it.
 Though maybe that's okay?

 It might easy to add the version to the graphs' png meta data?

 >
 >  - The new service discussed in #21551 for providing .csv files should
 include an implementation version, too.  Maybe it'll contain a machine-
 readable index file of some sort, too.
 >
 > The mirror topic depends a lot of #21551.  We should probably move
 forward with that discussion first.

 That's right. Just added things I didn't want to forget in the mean time.

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


More information about the metrics-bugs mailing list