HttpClientBuilderExtensions.RedactLoggedHeaders Method

Definition

Overloads

RedactLoggedHeaders(IHttpClientBuilder, IEnumerable<String>)

Sets the collection of HTTP headers names for which values should be redacted before logging.

RedactLoggedHeaders(IHttpClientBuilder, Func<String,Boolean>)

Sets the Func<T,TResult> which determines whether to redact the HTTP header value given its corresponding header name before logging.

RedactLoggedHeaders(IHttpClientBuilder, IEnumerable<String>)

Source:
HttpClientBuilderExtensions.cs
Source:
HttpClientBuilderExtensions.cs
Source:
HttpClientBuilderExtensions.cs

Sets the collection of HTTP headers names for which values should be redacted before logging.

C#
public static Microsoft.Extensions.DependencyInjection.IHttpClientBuilder RedactLoggedHeaders(this Microsoft.Extensions.DependencyInjection.IHttpClientBuilder builder, System.Collections.Generic.IEnumerable<string> redactedLoggedHeaderNames);

Parameters

redactedLoggedHeaderNames
IEnumerable<String>

The collection of HTTP headers names for which values should be redacted before logging.

Returns

The IHttpClientBuilder.

Applies to

.NET 9 (package-provided) and other versions
Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)

RedactLoggedHeaders(IHttpClientBuilder, Func<String,Boolean>)

Source:
HttpClientBuilderExtensions.cs
Source:
HttpClientBuilderExtensions.cs
Source:
HttpClientBuilderExtensions.cs

Sets the Func<T,TResult> which determines whether to redact the HTTP header value given its corresponding header name before logging.

C#
public static Microsoft.Extensions.DependencyInjection.IHttpClientBuilder RedactLoggedHeaders(this Microsoft.Extensions.DependencyInjection.IHttpClientBuilder builder, Func<string,bool> shouldRedactHeaderValue);

Parameters

shouldRedactHeaderValue
Func<String,Boolean>

The Func<T,TResult> which determines whether to redact the HTTP header value given its corresponding header name before logging.

Returns

The IHttpClientBuilder.

Remarks

The provided shouldRedactHeaderValue predicate will be evaluated for each header name when logging. If the predicate returns true then the header value will be replaced with a marker value * in logs; otherwise the header value will be logged.

Applies to

.NET 9 (package-provided) and other versions
Product Versions
.NET 8 (package-provided), 9 (package-provided)
.NET Framework 4.7 (package-provided), 4.7.1 (package-provided), 4.7.2 (package-provided), 4.8 (package-provided)
.NET Standard 2.0 (package-provided)