sdk/metrics: copy attributes dict to prevent post-recording mutation#5106
Conversation
|
THanks for this! Please sign the CLA. |
MikeGoldsmith
left a comment
MikeGoldsmith
left a comment
There was a problem hiding this comment.
Changes look good. I've left one suggestion to fix the changelog.
Also, please could you update the PR description to follow the PR template in .github/pull_request_template.md. It helps make sure all relevant details are included and makes reviewing PRs easier / most consistent.
|
@tejasae-afk EasyCLA can't verify ClaudeCode as a co-author on this commit (08c2390). You'll need to update it. |
|
This PR has been automatically marked as stale because it has not had any activity for 14 days. It will be closed if no further activity occurs within 14 days of this comment. |
|
@tejasae-afk we cannot accept contributions unless you sign the CLA, please sign it. |
08c2390 to
dea8513
Compare
|
/easycla |
…utation When a caller retains a reference to the attributes dict passed to counter.add() (or any instrument record/add call), mutating that dict after the call would silently corrupt the attributes stored on the aggregation and subsequently on exported data points. The fix copies the dict at the point where it is first stored as the canonical attributes for a new aggregation bucket, so downstream mutations by the caller have no effect. Fixes open-telemetry#4610
dea8513 to
24b14a6
Compare
MikeGoldsmith
moved this from Reviewed PRs that need fixes
to Approved PRs
in Python PR digest
|
Thanks for the PR! Just a heads-up: we no longer update Please add the appropriate changelog fragment for this change instead of editing |
github-project-automation
Bot
moved this from Ready for merge
to Done
in Python PR digest
5 participants
Description
When a caller retains a reference to the
attributesdict passed tocounter.add()(or any instrument'sadd/recordcall) and mutates it after the call, the mutation silently corrupts the attributes stored on the aggregation and therefore on exported data points.The root cause is in
_ViewInstrumentMatch.consume_measurement: when no attribute key filter is active, the code assigned the measurement's attributes dict directly:That dict is then passed to
_create_aggregation, which stores it asself._attributesin the_Aggregationbase class. Any subsequent mutation of the caller's dict changes what gets exported.The fix is a one-line copy:
A shallow copy is enough for all attribute value types (
str,bool,int,float, and their sequence variants) because those values are themselves immutable once stored.The filtered path (when
_view._attribute_keysis notNone) already builds a fresh dict via comprehension, so it is unaffected.Fixes #4610
Type of change
How Has This Been Tested?
A regression test is included that records a measurement, mutates the original dict, and verifies the exported data point still carries the original attributes.
opentelemetry-sdk/tests/metrics/Does This PR Require a Contrib Repo Change?
Checklist: