Skip to content
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

Implement default sanitization for logs / tracing #682

Open
heaths opened this issue Mar 9, 2022 · 0 comments
Open

Implement default sanitization for logs / tracing #682

heaths opened this issue Mar 9, 2022 · 0 comments
Labels
design-discussion An area of design currently under discussion and open to team and community feedback. Docs
Milestone

Comments

@heaths
Copy link
Member

heaths commented Mar 9, 2022

Related to #344 and PR #681, we should sanitize all headers and body (or elide body, rather) by default like we do in other languages. We're pretty consistent across languages, with azure_core (or equivalent) specifying a few common opt-in headers to not sanitize, and individual libraries (and users) can add more.

The body is elided and one has to opt into logging it via diagnostic options. This is separate from just enabling tracing, since typically non-privileged processes can do that. We want developers to have control over whether secret/PII headers and bodies are logged.

See the following for general Azure SDK guidelines:

As just one example (since I know it best), here's a few classes for the .NET Azure SDKs that are relevant. What they do is fairly consistent across languages, including in individual SDKs where we try to all unify on what headers are not sanitized (or redacted) by default.

@heaths heaths added design-discussion An area of design currently under discussion and open to team and community feedback. guidelines labels Mar 9, 2022
@heaths heaths added Docs and removed guidelines labels Jan 30, 2024
@RickWinter RickWinter added this to the 2024-09 milestone Jul 1, 2024
@RickWinter RickWinter modified the milestones: 2024-09, 2024-10 Sep 25, 2024
@RickWinter RickWinter modified the milestones: 2024-10, 2024-11 Oct 24, 2024
@RickWinter RickWinter modified the milestones: 2024-11, 2025-02 Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design-discussion An area of design currently under discussion and open to team and community feedback. Docs
Projects
Status: No status
Development

No branches or pull requests

2 participants