This repository has been archived by the owner on Sep 26, 2019. It is now read-only.
Make MetricCategories more flexible #1550
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… specific categories.
…hings up so plugins can register their own metric categories in the future.
mbaxter
reviewed
Jun 17, 2019
| public boolean isPantheonSpecific() { | ||
| return pantheonSpecific; | ||
| } | ||
| boolean isApplicationSpecific(); |
There was a problem hiding this comment.
Instead of having a boolean here + the applicationPrefix configured on the MetricsSystem, what about just storing an Optional<String> applicationPrefix on MetricsCategory?
There was a problem hiding this comment.
I was skeptical at first but have come around. This does simplify things and given an application would typically have one enum for its categories it actually works out pretty nicely.
shemnon
approved these changes
Jun 18, 2019
|
Agreed, I'll split it up into a couple of separate PRs to make things clearly - it took a bit of playing to work out what the final destination needed to look like. |
shemnon
approved these changes
Jun 19, 2019
| @@ -650,6 +653,11 @@ public void parse( | |||
| commandLine.registerConverter(Wei.class, (arg) -> Wei.of(Long.parseUnsignedLong(arg))); | |||
| commandLine.registerConverter(PositiveNumber.class, PositiveNumber::fromString); | |||
|
|
|||
| final MetricCategoryConverter metricCategoryConverter = new MetricCategoryConverter(); | |||
| metricCategoryConverter.addCategories(PantheonMetricCategory.class); | |||
| metricCategoryConverter.addCategories(StandardMetricCategory.class); | |||
There was a problem hiding this comment.
I may want to expose this via the plugin APIs, but we should wait until some plugin wants it.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR description
Artemis have expressed interest in using our metrics library since they'll need to export to Prometheus but don't necessarily want to be tied to it and want to avoid the very static-heavy approach the Prometheus client library normally uses.
Currently there are a few Pantheon specific details that have leaked into the metrics library - the hardcoded
pantheon_prefix andMetricCategoriesbeing an enum full of categories specifically for Pantheon.Having
MetricCategoriesas an enum also prevents future plugins from adding their own categories if we add a metrics service to our plugin APIs.So there are four major changes in this PR (once we've agreed on the final design we're heading towards I can break it up into smaller PRs to simplify reviews):
MetricCategoryan interface instead of an enum. This required getting rid of most usages ofEnumSetin favour of a plainSet. There are now two enums which implementMetricCategory,StandardMetricCategory(JVM and PROCESS) which should stay in the metrics package andPantheonMetricCategorywhich needs to find a home outside of the metric package since it's Pantheon specific (not sure where yet).PantheonCommandbuilds up a map of allowed metric category names to their instances. Currently that's just aHashMapwhich all the values fromStandardMetricCategoryandPantheonMetricCategoryare added into. A plugin API could be exposed to allow plugins to register their own categories in the future.util. This was only used in production code to check the network port was valid so I just inlined it. The tests still have a dependency on it for one method but that won't affect other projects trying to import the metrics library.Open questions/ugly bits:
PantheonMetricCategoryactually live. It needs to be available to most of Pantheon. May need to just create a:metrics:pantheonmodule specifically for it, although its slightly tempting to shove it intoutil...PantheonCommandto register the metric categories doesn't feel particularly clean. Might be able to extract a class to clean it up.MetricSystemdoesn't actually check that theMetricCategorysupplied when creating a counter/gauge/etc was actually registered back inPantheonCommand, although if it wasn't it will just never be enabled.