Add the appmetrics package #182
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
This package contains utilities that make it easier to construct and register metrics structs because you only have to specify the metric name and type in one place. It should hopefully help standardize how we configure metrics in various applications. One disadvantage is that it doesn't handle tagged metrics right now, since the metric names change based on the tag values. I'll have to think about how to implement this.
Define a functional guage by using the specific structs instead the plain gauge interface with a struct tag. Also, require a specific function field or method named after the metric field instead of allowing customization with tags.
I realized that the Tagged[M] interface could work after all because we can get the type parameter from the return type of the Tag() method. We have to implement our own interface check since different instantiations of the interface are different types, but this isn't too bad for a single method.
We need to get the field value each time because the initial value is always going to be nil.
bluekeyes
commented
Jun 26, 2023
| m.r = r | ||
|
|
||
| // Add the bare metric immediately so emitters can find it in the registry | ||
| r.GetOrRegister(m.name, m.newMetric) |
There was a problem hiding this comment.
Not sure if this is a good idea or not, but I've definitely tricked myself not being able to find an expected metric because it hadn't reported any values yet.
nvelat
approved these changes
Jun 28, 2023
asvoboda
approved these changes
Jun 29, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This package contains utilities that make it easier to construct and register metrics structs because you only have to specify the metric name and type in one place. It should hopefully help standardize how we configure metrics in various applications.
There's a bit of magic involved, so it's probably best to read the included docs and look at the examples to understand how this works. I'll also put together an example in a real internal application.
There were a few iterations on tagged and functional metrics, which you can see in the commit history, but I'm relatively happy with the final version shown here.