Clarify SDK behavior for Instrument Advisory Parameter #4389
+42
−5
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
cijothomas
commented
Jan 28, 2025
trask
reviewed
Jan 28, 2025
Co-authored-by: Trask Stalnaker <[email protected]>
dashpole
reviewed
Jan 28, 2025
lmolkova
approved these changes
Feb 4, 2025
carlosalberto
approved these changes
Feb 18, 2025
reyang
reviewed
Feb 18, 2025
jack-berg
reviewed
Feb 18, 2025
trask
reviewed
Feb 24, 2025
jack-berg
reviewed
Feb 25, 2025
Comment on lines
+977
to
+980
| Histogram](#explicit-bucket-histogram-aggregation) aggregation. If the user has | ||
| configured custom bucket boundaries via View(s), those boundaries take | ||
| precedence. If no View is configured, the advisory parameter should be used. If | ||
| neither is provided, the default bucket boundaries must be applied. |
There was a problem hiding this comment.
I find this language ambiguous. Per the conversation here, I believe that ExplicitBucketBoundaries should only apply if the default aggregation is used. If a view sets Explicit bucket histogram aggregation the ExplicitBucketBoundaries parameter should be ignored even if the view doesn't specify bucket boundaries.
Suggested change
| Histogram](#explicit-bucket-histogram-aggregation) aggregation. If the user has | |
| configured custom bucket boundaries via View(s), those boundaries take | |
| precedence. If no View is configured, the advisory parameter should be used. If | |
| neither is provided, the default bucket boundaries must be applied. | |
| Histogram](#explicit-bucket-histogram-aggregation) aggregation. If a matching View specifies Explicit bucket histogram aggregation, then the `ExplicitBucketBoundaries` advisory parameter is ignored. If no View matches, or if a matching view selects the default aggregation, the advisory parameter must be used. |
There was a problem hiding this comment.
Sounds good -- so, if the view is set, the advisory param is ignored as a hard rule -- if you configure explicit boundaries w/o boundaries, you'll get the specified default and not the advisory param.
jack-berg
reviewed
Feb 25, 2025
| produce a metric stream. | ||
|
|
||
| If the user has provided attribute keys via View(s), those keys take precedence. | ||
| If no View is configured, the advisory parameter should be used. If neither is |
There was a problem hiding this comment.
Suggested change
| If no View is configured, the advisory parameter should be used. If neither is | |
| If no View is configured, or if a matching view does not specify attribute keys, the advisory parameter should be used. If neither is |
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.
Also Fixes #4317
Changes
Mostly editorial, to specify SDK behavior for Advisory Parameters, explicitly calling out that SDK MUST give precedence to View config over InstrumentAdvisory. I believe this is already the intention, but was less specified. Though some wordings exist in the View spec about attribute-keys, no mention about Histogram buckets..
CHANGELOG.mdfile updated for non-trivial changesspec-compliance-matrix.mdupdated if necessary