Fix/copy measurement attributes #4627
Open
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
P4rk
force-pushed
the
fix/copy-measurement-attributes
branch
from
582958e to
b48902f
Compare
P4rk
force-pushed
the
fix/copy-measurement-attributes
branch
from
b48902f to
f945980
Compare
* Indent #TODO text so that it appears as a single TODO
Set the attributes on the measurement as a copy of the attributes passed in. This makes sure that they cannot be changed, by using a reference from outside the scope of the measurement instance.
P4rk
force-pushed
the
fix/copy-measurement-attributes
branch
from
6baf134 to
857165f
Compare
aabmass
reviewed
Jun 26, 2025
There was a problem hiding this comment.
Thanks again for the PR! The biggest possible impact I imagine is a performance regression, but it may be minimal for small attribute sets. Could you run the SDK benchmarks tox -e benchmark-opentelemetry-sdk on your machine before and after and see if there is any significant change? Admittedly we don't have great benchmark coverage here so feel free to add some new benchmark cases if you see fit
Comment on lines
+37
to
+39
| # one will come from napoleon extension and the other from autodoc extension. This | ||
| # will raise an sphinx error of duplicated object description | ||
| # See https://github.com/sphinx-doc/sphinx/issues/8664 |
Comment on lines
+49
to
+52
| super().__setattr__( | ||
| "attributes", | ||
| deepcopy(self.attributes), | ||
| ) |
There was a problem hiding this comment.
Is this to work around frozen=True?
|
|
||
| @pytest.fixture | ||
| def unix_time() -> int: | ||
| return time_ns() |
There was a problem hiding this comment.
Can you hardcode a timestamp here just for repeatability?
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.
Description
This change gets the Measurement dataclass to create its own copy of the attributes that are passed to it. This stops changes to the attributes from outside the scope of the measurement affecting it.
I had considered making the Measurement attributes immutable, but that has a larger impact on the rest of the codebase and does more than just fix #4610.
Fixes #4610
Type of change
How Has This Been Tested?
Two new test files were added: a unit test and an integration test.
opentelemetry-sdk/tests/metrics/integration_test/test_data_point_creation.py::test_measurement_collectionopentelemetry-sdk/tests/metrics/test_measurement.py::test_measurement_attribute_is_a_different_objectopentelemetry-sdk/tests/metrics/test_measurement.py::test_measurement_attribute_uneffected_by_changeThese are new files and pytest tests. There were a few
pytestorunittesttests in the project. Let me know if these tests would fit better in a different file, or asunittesttests.Does This PR Require a Contrib Repo Change?
Checklist: