[metrics-bugs] #24036 [Metrics]: Create a unified package naming scheme for all metrics code bases

[Tor Bug Tracker & Wiki]

#24036: Create a unified package naming scheme for all metrics code bases
-------------------------+------------------------------
 Reporter:  karsten      |          Owner:  metrics-team
     Type:  enhancement  |         Status:  needs_review
 Priority:  Medium       |      Milestone:
Component:  Metrics      |        Version:
 Severity:  Normal       |     Resolution:
 Keywords:               |  Actual Points:
Parent ID:               |         Points:
 Reviewer:               |        Sponsor:
-------------------------+------------------------------
Changes (by karsten):

 * status:  new => needs_review


Comment:

 Looks like we mostly agree about the changes above. Time to summarize and
 outline some next steps to move forward. Each of the following could
 become its own ticket:

  1. Rename CollecTor packages
    - Rename root package `org.torproject.collector` to
 `org.torproject.metrics.collector` to make it part of the Tor Metrics name
 space.
    - Further rename `index` package to `indexer` to reflect that this is
 the scheduled task for creating index files, not the classes for
 generating or parsing those index files.
  2. Rename ExoneraTor packages
    - Rename root package `org.torproject.exonerator` to
 `org.torproject.metrics.exonerator` to make it part of the Tor Metrics
 name space.
    - Reconsider moving some classes to metrics-lib for re-use from
 metrics-web, but not before the Jetty switch and possibly related changes
 are over.
  3. Rename metrics-lib packages
    - Rename root package `org.torproject.descriptor` to
 `org.torproject.metrics.descriptor` to make it part of the Tor Metrics
 name space.
    - `org.torproject.descriptor.index` becomes
 `org.torproject.metrics.index` (without `descriptor`), because it contains
 functionality that is supposed to be internally shared with other code
 bases that is unrelated to descriptor parsing.
  4. Create new metrics-lib package with generally useful classes and
 functions
    - At some point in the future we may add a new package
 `org.torproject.metrics.util` with generally useful classes and functions,
 including fingerprint calculations and commonly used regular expressions.
  5. Rename metrics-web packages
    - Rename root package `org.torproject.metrics` to
 `org.torproject.metrics.stats` to make it part of the Tor Metrics name
 space.
    - `ernie.cron` becomes `org.torproject.metrics.stats.servers` to get
 rid of the legacy name and to reflect that it's all about servers and
 bandwidth (provided by servers).
    - `org.torproject.metrics.web` and subpackages remain unchanged.
    - `org.torproject.metrics.web.research`, containing just a single
 class, is merged into `org.torproject.metrics.web`.
  6. Rename Onionoo packages
    - Rename root package `org.torproject.onionoo` to
 `org.torproject.metrics.onionoo` to make it part of the Tor Metrics name
 space.
  7. Make Onionoo's document classes available as part of metrics-lib
    - At some point in the future we may want to move parts of
 `org.torproject.onionoo.docs` to metrics-lib, so that metrics-bot and
 other clients can re-use that code. More specifically, we should only move
 the externally provided JSON objects, not the internally used status
 objects.
  8. Rename metrics-bot packages
    - Rename root package `org.torproject.metricsbot` to
 `org.torproject.metrics.bot` (every dot counts!) to make it part of the
 Tor Metrics name space.

 What did I miss? Should I move forward with creating these tickets and
 preparing patches?

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