👁 Image
SanitizedHttpClientLogger 0.1.0

How does it work

It's not possible to configure the log pattern of the Microsoft.Extensions.Http based HttpClient loggers. It has to be replaced.

This package replaces the default loggers with a logger that:

1. Reduces the number of log statements on HttpClient requests from 4 to 2
2. Makes sure that sensitive information like api-keys or tokens in the request-Uri can be sanitized using configurable Regex patterns
3. Also removes and replaces sensitive information like api-keys or tokens in the request- and response-headers using configurable Regex patterns (Only when the log level is set to Trace)

Change in logging output

Before:

info: Start processing HTTP request GET https://my.api.com/v1/status?apikey=my-secret-key
info: Sending HTTP request GET https://my.api.com/v1/status?apikey=my-secret-key
info: Received HTTP response headers after 188.6041ms - 200
info: End processing HTTP request after 188.8026ms - 200

After:

info: Sending HTTP request GET https://my.api.com/v1/status?apikey=xxx
info: Received HTTP response GET https://my.api.com/v1/status?apikey=xxx - 200 in 186.4883ms

Install

$ dotnet add package SanitizedHttpClientLogger

Usage

Via Options

services
 .AddHttpClient<Worker>((_, o) =>
 {
 o.BaseAddress = new Uri("https://my.api.com/v1");
 })
 .ConfigureSanitizedLogging(o =>
 // This regex pattern will match any part of a string that starts with "apikey=" (in a case-insensitive manner)
 // followed by any number of characters that are not an ampersand. 
 o.UriReplacements.Add("(?i)apikey=[^&]*", "apikey=xxx")
 );

Via Configuration

{
 "SanitizedHttpLoggerOptions": {
 "UriReplacements": {
 "(?i)apikey=[^&]*": "apikey=xxx"
 },
 "HeadersReplacements": {
 "(?i)^X-Api-Key$": "xxx",
 "(?i)^X-Api-Key2$": "yyy",
 "(?i)^Authorization$": "zzz"
 }
 }
}

services
 .AddHttpClient<Worker>((_, o) =>
 {
 o.BaseAddress = new Uri("https://my.api.com/v1");
 })
 .ConfigureSanitizedLogging(configuration);

Sponsors

Entity Framework Extensions and Dapper Plus are major sponsors and proud to contribute to the development of SanitizedHttpClientLogger.

👁 Entity Framework Extensions

👁 Dapper Plus