[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:  CollecTor 1.4.0
Component:  Metrics       |        Version:
 Severity:  Normal        |     Resolution:
 Keywords:  metrics-2017  |  Actual Points:
Parent ID:                |         Points:
 Reviewer:                |        Sponsor:
--------------------------+---------------------------------
Changes (by iwakeh):

 * status:  needs_revision => needs_review


Comment:

 Replying to [comment:12 karsten]:
 > Thanks for starting this!
 >
 > The metrics-base patch looks good, merged.
 >
 > However, I'd want us to make one change: we should just leave out the
 "build_revision" field from index.json if no revision is available. The
 "not-available" string only makes the protocol a bit more complex, because
 we need to explain what it means, but it doesn't add any information. And
 we need to check for null anyway, because that field does not exist until
 now. I'm happy to make that change.
 >
 > But there's another issue that I don't know how to fix: when I apply the
 patches for 2 and 3 and start a test CollecTor instance, it includes the
 revision of ''metrics-lib'' rather than its own revision. Not sure why,
 possibly because there are two `build.properties` files now, one from
 metrics-lib and one from CollecTor. Hmm, do you have a fix for that?
 >


 Thanks for checking thoroughly.  The wrong revision is a good catch!
 There are now fixup commits on all three branches:
 * [https://gitweb.torproject.org/user/iwakeh/metrics-
 base.git/commit/?h=task-21414&id=356f9f9f74e37f68a3ca22770e1bc6f0171847fd
 metrics-base] now creates a properties file with the product name and
 writes a property that also contains the product name.  Thus, making sure
 everything is unique.

 * [https://gitweb.torproject.org/user/iwakeh/metrics-
 lib.git/commit/?h=task-21414 metrics-lib] now omits unavailable revisions
 (cf. test data) in index.json files.

 *
 [https://gitweb.torproject.org/user/iwakeh/collector.git/commit/?h=task-21414
 collector] has to adapt to the new naming and hand 'null' to IndexNode
 when it cannot determine the revision.

 With the product dependent build revision properties file name we even
 know which metrics-lib version was used for creating the jar, i.e., it
 contains the file metrics-lib.buildrevision.properties.

 Please review again, I think all points above should be resolved.

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