[metrics-bugs] #24036 [Metrics]: Create a unified package naming scheme for all metrics code bases
Tor Bug Tracker & Wiki
blackhole at torproject.org
Mon Oct 30 14:39:49 UTC 2017
#24036: Create a unified package naming scheme for all metrics code bases
-------------------------+------------------------------
Reporter: karsten | Owner: metrics-team
Type: enhancement | Status: new
Priority: Medium | Milestone:
Component: Metrics | Version:
Severity: Normal | Resolution:
Keywords: | Actual Points:
Parent ID: | Points:
Reviewer: | Sponsor:
-------------------------+------------------------------
Comment (by iwakeh):
Replying to [comment:2 irl]:
> metrics-bot looks like:
>
> ||='''Current code base''' ||='''Current package and classes, starting
with `org.torproject.`''' ||='''Suggested package, starting with
`org.torproject.metrics.`''' ||='''Suggested code base, only if
different''' ||
> || metricsbot || Core metrics-bot application || bot ||||
[snip]
> || metricsbot.tor || Tor network objects (relays, bridges, flags, etc.)
|| onionoo.docs || metrics-lib ||
[snip]
>
> Currently `metricsbot.tor` does contain some metrics-bot specific code
relating to generating microblog statuses, but this code should be moved
into `bot.microblog` instead and then we can use Onionoo documents from
metrics-lib.
metrics-lib won't know about Onionoo, because Onionoo is a client far up
the ladder using metrics-lib. Thus, metrics-bot will only internally be
able to use part of Onionoo's API. Actually, long ago I proposed to
provide an Onionoo Java API for reading Onionoo's JSon documents. That
would now make more sense with metrics-bot and prevent updating in two or
more places.
>
> It might also be desirable to move [https://people.torproject.org/~irl
/metrics-bot/org/torproject/metricsbot/microblog/MicroblogUtils.html
MicroblogUtils] to metrics-lib.
These are only two very small methods so far. Maybe, they could find a
home elsewhere or are offered somewhere anyway?
While taking a look at metrics-bot git repo I noticed that metrics-bot
doesn't comply yet to
[https://trac.torproject.org/projects/tor/wiki/org/teams/MetricsTeam/MetricsJavaStyleGuide
Metrics' project guidelines and java style rules] (like using metrics-base
etc.). Metrics-web and ExoneraTor still need to be migrated, but new
Metrics products should comply initially. New ticket?
--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/24036#comment:3>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
More information about the metrics-bugs
mailing list