Skip to content

Send secret masking telemetry if opted in to it #5189

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

nguerrera
Copy link
Contributor

@nguerrera nguerrera commented Apr 29, 2025

Issue: We would like to have telemetry on secret masking.

Description:
If using the new OSS secret masker and an additional opt-in knob is turned on, then send telemetry about secrets that were masked.

An overall 'SecretMasker' event is sent with statistics such as total detections and elapsed time. Additional 'SecretMaskerDetections' events are sent mapping C3ID to pattern monikers. These are batched to keep event sizes capped and the total number of events are also capped.

This also includes an update to the Microsoft.Security.Utilities.Core dependency from v1.18 to v1.19. Release notes: https://github.com/microsoft/security-utilities/blob/release/v1.19.0/docs/ReleaseHistory.md

Risk Assessment (Low/Medium/High): Low. Behind opt-in flag.

Added unit tests (Y/N): Y

Additional Tests Performed: Ran agent locally with AZP_SEND_SECRET_MASKER_TELEMETRY=true set via environment variable and confirmed telemetry was reported.

@merlynomsft merlynomsft added the misc Miscellaneous Changes label Apr 30, 2025
@nguerrera nguerrera requested a review from merlynomsft May 13, 2025 19:54
merlynomsft
merlynomsft previously approved these changes May 13, 2025
@nguerrera nguerrera force-pushed the users/nguerrera/masking-telemetry-with-opt-in branch from 6a4d1b8 to ea196a1 Compare June 5, 2025 14:56
@nguerrera nguerrera changed the base branch from master to users/nguerrera/msuc-v1.18 June 5, 2025 14:57
@nguerrera

This comment was marked as outdated.

@nguerrera nguerrera force-pushed the users/nguerrera/masking-telemetry-with-opt-in branch from ea196a1 to 52b4e2d Compare June 6, 2025 19:30
If using the new OSS secret masker and an additional opt-in knob is turned on, then send telemetry about secrets that were masked.
@nguerrera nguerrera changed the base branch from users/nguerrera/msuc-v1.18 to master June 9, 2025 18:39
@nguerrera nguerrera dismissed merlynomsft’s stale review June 9, 2025 18:39

The base branch was changed.

@nguerrera nguerrera force-pushed the users/nguerrera/masking-telemetry-with-opt-in branch from 52b4e2d to 524bf17 Compare June 9, 2025 18:39
@nguerrera
Copy link
Contributor Author

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@nguerrera nguerrera changed the title **DRAFT**: Send secret masking telemetry if opted in to it. Send secret masking telemetry if opted in to it Jun 9, 2025
@nguerrera nguerrera marked this pull request as ready for review June 10, 2025 21:30
@nguerrera nguerrera requested review from a team as code owners June 10, 2025 21:30
Copy link
Member

@michaelcfanning michaelcfanning left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@nguerrera
Copy link
Contributor Author

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@nguerrera
Copy link
Contributor Author

/azp run

Copy link

Azure Pipelines successfully started running 1 pipeline(s).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
misc Miscellaneous Changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants