feat(metrics): add advisory attributes parameter to metric instruments #5783
Conversation
This file contains hidden or 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
Add optional attributes parameter to MetricAdvice interface to support advisory attribute filtering for metric instruments. This parameter allows users to specify which attribute keys should be kept when recording metrics, acting as an allow-list filter. The parameter is marked as experimental and follows the OpenTelemetry specification for advisory parameters.
Implement advisory attributes filtering in ViewRegistry by creating a default view with AllowListProcessor when no matching views are found and the instrument has advisory attributes specified. This ensures that only the specified attribute keys are retained when recording metrics, reducing cardinality and improving performance.
Add comprehensive unit and integration tests for the advisory attributes parameter functionality: - Unit tests for ViewRegistry advisory attributes handling - Integration tests covering various scenarios including edge cases - Tests for attribute filtering behavior with and without views - Verification of experimental feature marking
Add documentation and example for the new advisory attributes parameter: - Update README with usage instructions and examples - Create standalone example demonstrating the feature - Include notes about experimental status and performance benefits - Provide clear guidance on when and how to use advisory attributes
pichlermarc
requested changes
Jul 8, 2025
| } | ||
|
|
||
| // Create a view that matches this specific instrument | ||
| return new View(viewOptions); |
There was a problem hiding this comment.
My guess is that creating a view always is what's eventually failing the tests. You might have to look into which part of the code calls findViews() to investigate what's wrong.
There was a problem hiding this comment.
Sure , I will look into all the issues and get back to you
There was a problem hiding this comment.
Hi @pichlermarc
I've addressed the aforementioned issues
Could you take a look
Thank you
There was a problem hiding this comment.
looks like it's still failing due to the issue I mentioned above, did you force-push over the change that addressed this? 🤔
Added the suggested change Co-authored-by: Marc Pichler <[email protected]>
- Add experimental `attributes` parameter to MetricAdvice interface - Implement attribute filtering via ViewRegistry default views - Only applies when no Views are configured for the instrument - Views take precedence over advisory attributes when present - Add comprehensive unit and integration tests - Update documentation and changelogs Closes open-telemetry#4365
pratstick
force-pushed
the
feature/advisory-attributes
branch
from
3e84236 to
b5eca96
Compare
pichlermarc
added
the
spec-feature
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.
Which problem is this PR solving?
This PR implements the "attributes" instrument advisory parameter for OpenTelemetry metrics as specified in the OpenTelemetry specification. The advisory parameter allows users to specify an allow-list of attribute keys that should be retained when recording metrics, helping to reduce cardinality and improve performance.
Fixes #4365
Short description of the changes
attributesparameter toMetricAdviceinterface in the APIViewRegistryusingAllowListProcessorThe implementation ensures that:
Type of change
How Has This Been Tested?
ViewRegistryadvisory attributes handlingThe tests cover:
Checklist: