Skip to content

[HttpClientFactory] Don't log header values by default#106271

Merged
CarnaViire merged 4 commits intodotnet:mainfrom
CarnaViire:hcf-header-values
Aug 13, 2024
Merged

[HttpClientFactory] Don't log header values by default#106271
CarnaViire merged 4 commits intodotnet:mainfrom
CarnaViire:hcf-header-values

Conversation

@CarnaViire
Copy link
Member

@CarnaViire CarnaViire commented Aug 12, 2024

Only affects the default case; if the sensitive headers were ever specified by RedactLoggedHeaders, the behavior is unchanged.

@CarnaViire CarnaViire requested review from a team and antonfirsov August 12, 2024 14:30
rokonec
rokonec approved these changes Aug 12, 2024
View reviewed changes
Copy link
Member

@rokonec rokonec left a comment

Choose a reason for hiding this comment

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

LGTM. Only concern is about performance, but I suppose in default we do not log header values so by default perf is not affected by redacting.

MihaZupan
MihaZupan approved these changes Aug 12, 2024
View reviewed changes
Copy link
Member

@MihaZupan MihaZupan left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Are we treating this as a breaking change?

@CarnaViire
Copy link
Member Author

CarnaViire commented Aug 12, 2024 •
edited
Loading

Only concern is about performance, but I suppose in default we do not log header values so by default perf is not affected by redacting.

@rokonec yeah, these are Trace level logs. And it doesn't matter much from perf perspective whether the value is redacted or not because nothing need to be parsed; FWIW it will be only faster with the redaction on, see HttpHeadersLogValue.ToString() 😄

Are we treating this as a breaking change?

@MihaZupan Yes, we should; there is some tag I need to apply here then, right?

@CarnaViire CarnaViire added breaking-change Issue or PR that represents a breaking API or functional change over a previous release. needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet labels Aug 12, 2024
@dotnet-policy-service
Copy link
Contributor

dotnet-policy-service bot commented Aug 12, 2024 •
edited by CarnaViire
Loading

Added needs-breaking-change-doc-created label because this PR has the breaking-change label.

When you commit this breaking change:

  1. Create and link to this PR and the issue a matching issue in the dotnet/docs repo using the breaking change documentation template, then remove this needs-breaking-change-doc-created label.
  2. Ask a committer to mail the .NET Breaking Change Notification DL.

Tagging @dotnet/compat for awareness of the breaking change.

@build-analysis build-analysis bot mentioned this pull request Aug 12, 2024
Closed
@CarnaViire CarnaViire mentioned this pull request Aug 13, 2024
Closed
@CarnaViire
Copy link
Member Author

CarnaViire commented Aug 13, 2024

/ba-g DeadLetter Helix crash on an unrelated test run (System.Runtime.Tests on ios-arm64)

@CarnaViire CarnaViire merged commit 47af310 into dotnet:main Aug 13, 2024
@CarnaViire CarnaViire mentioned this pull request Aug 13, 2024
Closed
3 tasks
@CarnaViire CarnaViire removed the needs-breaking-change-doc-created Breaking changes need an issue opened with https://github.com/dotnet/docs/issues/new?template=dotnet label Aug 13, 2024
@karelz karelz added this to the 9.0.0 milestone Sep 3, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Oct 4, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@rokonec rokonec rokonec approved these changes

@MihaZupan MihaZupan MihaZupan approved these changes

+1 more reviewer

@antonfirsov antonfirsov antonfirsov approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@CarnaViire CarnaViire

Labels

area-Extensions-HttpClientFactory breaking-change Issue or PR that represents a breaking API or functional change over a previous release.

Projects

None yet

Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

5 participants

@CarnaViire @antonfirsov @rokonec @MihaZupan @karelz