[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:
--------------------------+---------------------------------

Comment (by karsten):

 Replying to [comment:15 iwakeh]:
 > I don't see my fixup commits in your branch (which is a little
 confusing) and some of the changes you made were in there.

 Ah, the reason is that I already made very similar changes when trying out
 your earlier branches, so I manually applied changes from your most recent
 commits rather than rebasing my remaining changes on your fixup commit. I
 figured it's not that much of an issue, because these will be squashed
 very soon anyway, but I didn't mean to confuse you.

 > But, the changes look ok; except that I prefer to explicitly set the
 fallback value 'null' instead of relying on the default in `getProperty`,
 because this states that the decision was made consciously and not by
 accident -- some way to document in code.

 Makes sense, changed.

 > Regarding the changelog of metrics-lib:  This needs to be clearer, like
 "the Git revision supplied by the calling software" or similar.  It should
 make clear that this is a revision of the software __using__ the API and
 that metrics-lib doesn't interfere with it.  metrics-lib creates the
 files, but the git-revision supplied is not metrics-lib.

 Changed to:

 {{{
    - Add new optional "build_revision" field to index.json with the
      Git revision supplied by the calling software.
 }}}

 > The same for CollecTor, maybe:
 > //Git revision of the CollecTor instance's software used to create this
 file, which will be omitted if unknown.//

 Changed to:

 {{{
    - Add new optional "build_revision" field to index.json with the
      Git revision of the CollecTor instance's software used to create
      this file, which will be omitted if unknown.
 }}}

 (I pushed both changes as fixup commits to my existing task-21414
 branches.)

 > (Wondering if the metrics-lib revision should be appended to the one
 given by CollecTor as it does have some influence on the files, i.e.,
 `"build_revision":"abcdfe7-zyxabc5"`? It would be easy, but of course we
 would have to discuss and explain what happens when there is only one of
 these available)

 Let's start with the CollecTor's Git revision, and if we figure out that
 we also need to provide more details about the metrics-lib version or
 maybe even other dependent libraries, let's add that. In theory, library
 versions are determined by the Git revision, unless we use dev versions,
 which we probably shouldn't do.

 Speaking of! :) Should we put out metrics-lib version 2.2.0 today? I could
 provide a pre-release tarball in ~2 hours.

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