[Telemetry] Expand field sanitization to codedError.data #14161
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
jonthysell
requested changes
Dec 5, 2024
microsoft-github-policy-service
bot
added
the
Needs: Author Feedback
microsoft-github-policy-service
bot
removed
the
Needs: Author Feedback
jonthysell
reviewed
Dec 20, 2024
jonthysell
reviewed
Dec 20, 2024
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
Expand sanitization checks in telemetry, in this case error telemetry instances (and more specifically, all the string fields in
codedError.data).Type of Change
Bug fix.
Why
In telemetry error instances, certain fields may potentially contain file paths. This requires sanitization checks - they already exist for other telemetry fields.
Resolves #14158
What
In
Telemetry.trackException(), take thecodedErrorstruct (i.e., a struct that contains error information), check each field in the struct if it's a string. If it is, perform sanitization; this will replace any filepaths with[path].Screenshots
N/A
Testing
Added a unit test to verify a codedError.data struct containing:
fieldWithPath - sanitization will modify remove a filepath with
[path].fieldWithNoPath - a string that won't be modified.
fieldWithNoString - non-string, won't be modified.
Changelog
Yes
Add a brief summary of the change to use in the release notes for the next release.
Microsoft Reviewers: Open in CodeFlow