feat: Explicit bucket boundary advisory parameter #1703
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
The advisory parameter explicit_bucket_boundaries allows instrumentation authors to set bucket boundaries for histograms that differ from the default bucket set. Since this only applies to histograms, advice is not explicitly assigned in other instruments, however, shared methods will have an empty hash assigned as the default argument. Any key passed to advice will be accepted, but only the :explicit_bucket_boundaries symbol will have an effect.
…nto metrics-advisory-parameters
The API doesn't have the functionality tested
kaylareopelle
commented
Aug 28, 2024
| @@ -8,19 +8,22 @@ module OpenTelemetry | |||
| module Internal | |||
| # @api private | |||
| class ProxyInstrument | |||
| def initialize(kind, name, unit, desc, callable) | |||
| def initialize(kind, name, unit, desc, callable, advice = nil) | |||
There was a problem hiding this comment.
I'm not sure what the ideal default argument is. We expect advice to be a hash when it's present, but that might cause a lot of unnecessary object allocations. I'm leaning to nil for now, but open to discussion.
There was a problem hiding this comment.
Would a constant, empty, frozen hash be an option?
There was a problem hiding this comment.
Good idea! Updated in d2318b0
kaylareopelle
commented
Aug 28, 2024
| @@ -8,19 +8,22 @@ module OpenTelemetry | |||
| module Internal | |||
| # @api private | |||
| class ProxyInstrument | |||
| def initialize(kind, name, unit, desc, callable) | |||
| def initialize(kind, name, unit, desc, callable, advice = nil) | |||
There was a problem hiding this comment.
Also, advice is shorter than advisory_parameters, so that's why I chose that word. However, it's not the latest terminology used in the spec. I'm happy to change to advisory_parameters if that's preferred. Perhaps some documentation would clarify things.
must_equal(nil) will be removed in Minitest 6
…e/opentelemetry-ruby into metrics-advisory-parameters
Assign the advice instance variable in histograms only. Advice will default to nil in all cases.
kaylareopelle
requested review from
fbogsany,
mwear,
robertlaurin,
dazuma,
ericmustin,
arielvalentin,
ahayworth,
plantfansam and
robbkidd
as code owners
This reverts commit ed4ceca.
kaylareopelle
force-pushed
the
metrics-advisory-parameters
branch
from
a3467ce
to
bcb1caf
Compare
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.
The advisory parameter
:explicit_bucket_boundariesallows instrumentation authors to set bucket boundaries for histograms that differ from the default bucket set. Since this only applies to histograms, advice is not explicitly assigned in other instruments, so shared methods have an optional argument that defaults to nil.Any key passed to advice will be accepted, but only the
:explicit_bucket_boundariessymbol will have an effect.Advice is used by instrumentation for metrics configuration, similar to how views are used by users.
Relates to #1686