fix(metrics): detect key collisions between dimensions, metrics, and metadata#5240
Open
Zelys-DFKH wants to merge 1 commit into
Open
fix(metrics): detect key collisions between dimensions, metrics, and metadata#5240Zelys-DFKH wants to merge 1 commit into
Zelys-DFKH wants to merge 1 commit into
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
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.



Summary
Changes
Closes #5208. In
serializeMetrics(), EMF output is assembled by spreading default dimensions, dimensions, dimension sets, metric values, and metadata in that order. When keys match across those layers, later values win silently. Two of those collisions break the EMF schema:What changed
Metrics.ts: Added a guard instoreMetric()that throws when the metric name matches any current dimension key (flat dimensions, default dimensions, or dimension sets), and a guard inaddMetadata()that throws when the metadata key matches any current metric name. Both error messages include the key name.dimensions.test.ts: Four new tests covering a regular dimension conflict, a default dimension conflict, a dimension-set conflict (viaaddDimensions), and the built-inservicedimension.metadata.test.ts: One new test covering a metadata-metric name conflict.Issue number: Closes #5208
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.