Skip to content

Commit 832b05a

Browse files
authored
Adjust Uri redaction breaking change docs (#43795)
* document that fragment is also being redacted * better wording maybe
1 parent 6878d72 commit 832b05a

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

docs/core/compatibility/networking/9.0/query-redaction-events.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.date: 11/5/2024
55
ai-usage: ai-assisted
66
---
77

8-
# URI query redaction in HttpClient EventSource events
8+
# URI query and fragment redaction in HttpClient EventSource events
99

10-
In .NET 9, the default behavior of <xref:System.Diagnostics.Tracing.EventSource> events emitted by <xref:System.Net.Http.HttpClient> and <xref:System.Net.Http.SocketsHttpHandler> (`EventSource` name: `System.Net.Http`) has been modified to scrub query strings. This change enhances privacy by preventing the logging of potentially sensitive information contained in query strings. If necessary, you can override this behavior.
10+
In .NET 9, the default behavior of <xref:System.Diagnostics.Tracing.EventSource> events emitted by <xref:System.Net.Http.HttpClient> and <xref:System.Net.Http.SocketsHttpHandler> (`EventSource` name: `System.Net.Http`) has been modified to scrub the query and the fragment part of the Uri. This change enhances privacy by preventing the logging of potentially sensitive information contained in query strings while keeping the performance costs of the redaction minimal. If necessary, you can override this behavior.
1111

1212
## Version introduced
1313

@@ -19,15 +19,15 @@ Previously, events emitted by `HttpClient` and `SocketsHttpHandler` included que
1919

2020
## New behavior
2121

22-
With the change in [dotnet/runtime#104741](https://github.com/dotnet/runtime/pull/104741), query strings are replaced by a `*` character in `HttpClient` and `SocketsHttpHandler` events, by default. This change affects specific events and parameters such as `pathAndQuery` in `RequestStart` and `redirectUri` in `Redirect`.
22+
With the change in [dotnet/runtime#104741](https://github.com/dotnet/runtime/pull/104741), the query and the fragment part by a `*` character in `HttpClient` and `SocketsHttpHandler` events, by default. This change affects specific events and parameters such as `pathAndQuery` in `RequestStart` and `redirectUri` in `Redirect`.
2323

2424
## Type of breaking change
2525

2626
This change is a [behavioral change](../../categories.md#behavioral-change).
2727

2828
## Reason for change
2929

30-
The primary reason for this change was to enhance privacy by reducing the risk of sensitive information being logged inadvertently. Query strings often contain sensitive data, and redacting them from logs by default helps protect this information.
30+
The primary reason for this change was to enhance privacy by reducing the risk of sensitive information being logged inadvertently. Query strings often contain sensitive data, and redacting them from logs by default helps protect this information. To keep the implementation simple and efficient, the fragment part is also being scrubbed together with the query.
3131

3232
## Recommended action
3333

docs/core/compatibility/networking/9.0/query-redaction-logs.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ ms.date: 11/5/2024
55
ai-usage: ai-assisted
66
---
77

8-
# URI query redaction in IHttpClientFactory logs
8+
# URI query and fragment redaction in IHttpClientFactory logs
99

10-
In .NET 9, the default implementation of <xref:System.Net.Http.IHttpClientFactory> has been modified to scrub query strings when logging URI information. This change enhances privacy by preventing the logging of potentially sensitive information contained in query strings. For scenarios where logging query strings is necessary and deemed safe, you can override this behavior.
10+
In .NET 9, the default implementation of <xref:System.Net.Http.IHttpClientFactory> has been modified to scrub query strings when logging URI information. This change enhances privacy by preventing the logging of potentially sensitive information contained in query strings while keeping the performance costs of the redaction minimal. For scenarios where logging query strings is necessary and deemed safe, you can override this behavior.
1111

1212
## Version introduced
1313

@@ -19,15 +19,15 @@ Previously, the default implementation of `IHttpClientFactory` logging included
1919

2020
## New behavior
2121

22-
The messages passed to <xref:Microsoft.Extensions.Logging.ILogger> now have query strings replaced by a `*` character.
22+
The messages passed to <xref:Microsoft.Extensions.Logging.ILogger> now have the query and the fragment part replaced by a `*` character.
2323

2424
## Type of breaking change
2525

2626
This change is a [behavioral change](../../categories.md#behavioral-change).
2727

2828
## Reason for change
2929

30-
The primary reason for this change is to enhance privacy by reducing the risk of sensitive information being logged inadvertently. Query strings often contain sensitive data and excluding them from logs by default helps protect this information.
30+
The primary reason for this change is to enhance privacy by reducing the risk of sensitive information being logged inadvertently. Query strings often contain sensitive data and excluding them from logs by default helps protect this information. The fragment part is being scrubbed to keep the implementation simple and efficient.
3131

3232
## Recommended action
3333

0 commit comments

Comments
 (0)