SanitizedHttpLogger 0.0.1-preview-04
See the version list below for details.
dotnet add package SanitizedHttpLogger --version 0.0.1-preview-04
NuGet\Install-Package SanitizedHttpLogger -Version 0.0.1-preview-04
<PackageReference Include="SanitizedHttpLogger" Version="0.0.1-preview-04" />
<PackageVersion Include="SanitizedHttpLogger" Version="0.0.1-preview-04" />
<PackageReference Include="SanitizedHttpLogger" />
paket add SanitizedHttpLogger --version 0.0.1-preview-04
#r "nuget: SanitizedHttpLogger, 0.0.1-preview-04"
#addin nuget:?package=SanitizedHttpLogger&version=0.0.1-preview-04&prerelease
#tool nuget:?package=SanitizedHttpLogger&version=0.0.1-preview-04&prerelease
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:
- Reduces the number of log statements on
HttpClient
requests from 4 to 1 - Logs only 1 aggregated log statement:
{Method} {Uri} - {StatusCode} {StatusCodeLiteral} in {Time}ms
- Makes sure that sensitive information like api-keys or tokens in the request-Uri can be sanitized using configurable Regex patterns
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: GET https://my.api.com/v1/status?apikey=xxx - 200 in 186.4883ms
Install
$ dotnet add package SanitizedHttpLogger
Example Usage
Via SanitizedHttpLoggerOptions
// 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.
services.UseSanitizedHttpLogger(o => o.RequestUriReplacements.Add("(?i)apikey=[^&]*", "apikey=xxx"));
Via Configuration
{
"SanitizedHttpLogger": {
"RequestUriReplacements": [
{
"Pattern": "(?i)apikey=[^&]*",
"Replacement": "apikey=xxx"
}
]
}
}
services.Configure<SanitizedHttpLoggerOptions>(Configuration);
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- JetBrains.Annotations (>= 2023.3.0)
- Microsoft.Extensions.Http (>= 3.1.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 3.1.0)
- Stef.Validation.Options (>= 0.1.1)
-
net6.0
- JetBrains.Annotations (>= 2023.3.0)
- Microsoft.Extensions.Http (>= 6.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 6.0.0)
- Stef.Validation.Options (>= 0.1.1)
-
net7.0
- JetBrains.Annotations (>= 2023.3.0)
- Microsoft.Extensions.Http (>= 7.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 7.0.0)
- Stef.Validation.Options (>= 0.1.1)
-
net8.0
- JetBrains.Annotations (>= 2023.3.0)
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 8.0.0)
- Stef.Validation.Options (>= 0.1.1)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on SanitizedHttpLogger:
Package | Downloads |
---|---|
RestEase.Authentication.Azure
Add AzureAd Authentication for RestEase: the easy-to-use typesafe REST API client library. |
|
Freecurrency-API
This unofficial (RestEase based) client enables working with freecurrencyapi (https://freecurrencyapi.com) |
|
Google-GenAI.SDK
This unofficial (RestEase based) client enables working with the Google Gemini REST Interface (https://ai.google.dev/gemini-api/docs) |
GitHub repositories
This package is not used by any popular GitHub repositories.
See ReleaseNotes.md