[metrics-bugs] #21414 [Metrics]: Include currently running software versions in responses (collector.tp.o, onionoo.tp.o) and on the website (metrics.tp.o)

[Tor Bug Tracker & Wiki]

#21414: Include currently running software versions in responses (collector.tp.o,
onionoo.tp.o) and on the website (metrics.tp.o)
--------------------------+------------------------------
 Reporter:  iwakeh        |          Owner:  metrics-team
     Type:  enhancement   |         Status:  needs_review
 Priority:  Low           |      Milestone:
Component:  Metrics       |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:  metrics-2017  |  Actual Points:
Parent ID:                |         Points:
 Reviewer:                |        Sponsor:
--------------------------+------------------------------
Changes (by iwakeh):

 * status:  new => needs_review


Comment:

 Here is the example process for index.json files:

 1. The [https://gitweb.torproject.org/user/iwakeh/metrics-
 base.git/commit/?h=task-21414 patch for metrics-base] creates a
 build.properties file and adds it to the jar.  This will currently happen
 to all products using metrics-base, which is fine and even useful not have
 to look at the manifest to find out about the revision used.

 2. Index json is provided by metrics-lib.
 [https://gitweb.torproject.org/user/iwakeh/metrics-
 lib.git/commit?h=task-21414 This patch] adds the revision field to
 IndexNode and sets it to "not-available" in case there is a problem
 determining the revision, which is also helpful for testing.

 3. CollecTor's index module
 [https://gitweb.torproject.org/user/iwakeh/collector.git/commit?h=task-21414
 is patched] to read the properties file from its jar and add the revision
 to the IndexNode.

 Examples for the resulting index.json
 {{{
 {"index_created":"2016-08-22 10:48","build_revision":"not-
 available","path":"htt...
 }}}

 {{{
 {"index_created":"2016-08-22
 10:48","build_revision":"abcdef1","path":"htt...
 }}}

 (Once 1. is merged the Onionoo patch is very similar to the CollecTor
 patch and Onionoo doesn't need 2.
 The patches 1. and 2. have to be merged before 3., but their merge order
 doesn't matter.)

 Please review the above changes.

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