diff --git a/DebugProbe.AspNetCore/DebugProbe.AspNetCore.csproj b/DebugProbe.AspNetCore/DebugProbe.AspNetCore.csproj index ab6fc9f..8640dbc 100644 --- a/DebugProbe.AspNetCore/DebugProbe.AspNetCore.csproj +++ b/DebugProbe.AspNetCore/DebugProbe.AspNetCore.csproj @@ -4,18 +4,23 @@ net8.0 enable enable + latest - icon.png DebugProbe.AspNetCore 1.4.0-preview.2 Georgi Hristov - Debug and inspect HTTP requests and responses inside ASP.NET Core apps. Capture, analyze, and compare API calls with a built-in UI. - aspnetcore;debugging;http;middleware;api;diagnostics + + Debug HTTP requests and responses directly inside ASP.NET Core applications with a built-in tracing and comparison UI. + + aspnetcore;debugging;http;middleware;api;diagnostics;tracing;observability + + icon.png README.md https://github.com/georgidhristov/DebugProbe.AspNetCore git + https://debugprobe.dev Apache-2.0 @@ -23,8 +28,10 @@ true true + true snupkg + true @@ -34,11 +41,7 @@ - - - - - + @@ -50,10 +53,10 @@ - - all - runtime; build; native; contentfiles; analyzers; buildtransitive - + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + \ No newline at end of file diff --git a/DebugProbe.AspNetCore/README.md b/DebugProbe.AspNetCore/README.md index 8650aa5..dcd83ba 100644 --- a/DebugProbe.AspNetCore/README.md +++ b/DebugProbe.AspNetCore/README.md @@ -1,17 +1,18 @@ -# DebugProbe.AspNetCore +# DebugProbe.AspNetCore **Debug HTTP traffic directly from inside your ASP.NET Core pipeline.** -[![DebugProbe](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/debugprobe_icon_white_rounded_180px.png)](https://debugprobe.dev) +[![DebugProbe](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/Logos/debugprobe_icon_white_rounded_180px.png)](https://debugprobe.dev) Live Demo: https://debugprobe.dev -## Why DebugProbe? +## Why Use DebugProbe? -- Debug real requests from inside your app -- No proxy setup or traffic interception -- See exactly what your API sends and receives -- Compare environments in seconds +- Debug HTTP traffic directly inside your ASP.NET Core pipeline +- No proxies, browser extensions, or external tools +- Inspect requests and responses in real time +- Compare API responses across environments instantly +- Built for fast backend debugging with minimal setup ## Features @@ -22,19 +23,24 @@ Live Demo: https://debugprobe.dev - Compare responses across environments - JSON pretty formatting - Ignore noisy endpoints with `IgnorePaths` +- Configurable body capture size limits +- Safe compare mode with localhost protection +- Automatic masking of sensitive headers - Zero external proxies or setup ## Screenshots ### Requests -![Requests](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/requests.png) +![Requests](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_index_page_requests.png) ### Details -![Details](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/details_v1.4.0-preview.1.png) +![Details_overview](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe-details-overview.png) + +![Details_request_response](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe-details-request-response.png) ### Compare -![Compare](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/compare_v1.4.0-preview.1.png) +![Compare](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_compare_page.png) --- @@ -59,6 +65,10 @@ builder.Services.AddDebugProbe(options => { options.MaxEntries = 10; + options.MaxBodyCaptureSizeKb = 256; + + options.AllowLocalCompareTargets = false; + options.IgnorePaths = [ "/health", @@ -71,12 +81,12 @@ app.UseDebugProbe(); ``` ## Open The Debug UI + Run your application, then open: http://localhost:{port}/debug -![DebugProbe Short Demo](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/debugprobe_demo_live_debugging.gif) - +![DebugProbe Short Demo](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/Demos/debugprobe_demo_live_debugging.gif) ## Compare Responses @@ -86,6 +96,22 @@ Use the UI to compare responses across environments: - Enter **Trace ID** - Instantly see differences +## Security Defaults + +DebugProbe automatically masks sensitive headers: + +- Authorization +- Cookie +- Set-Cookie + +Localhost compare targets are blocked by default for safer environment comparisons. + +You can enable them manually: + +```csharp +options.AllowLocalCompareTargets = true; +``` + ## ⚠️ Production Usage This tool is intended for development. @@ -96,7 +122,6 @@ If used in production: - Restrict access - Filter sensitive data - ## License -Apache License 2.0 +Apache License 2.0 \ No newline at end of file diff --git a/DebugProbe.AspNetCore/icon.png b/DebugProbe.AspNetCore/icon.png index 1cb60cc..3347dfc 100644 Binary files a/DebugProbe.AspNetCore/icon.png and b/DebugProbe.AspNetCore/icon.png differ diff --git a/README.md b/README.md index 6c1906f..dcd83ba 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,17 @@ **Debug HTTP traffic directly from inside your ASP.NET Core pipeline.** -[![DebugProbe](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/debugprobe_icon_white_rounded_180px.png)](https://debugprobe.dev) +[![DebugProbe](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/Logos/debugprobe_icon_white_rounded_180px.png)](https://debugprobe.dev) Live Demo: https://debugprobe.dev -## Why DebugProbe? +## Why Use DebugProbe? -- Debug real requests from inside your app -- No proxy setup or traffic interception -- See exactly what your API sends and receives -- Compare environments in seconds +- Debug HTTP traffic directly inside your ASP.NET Core pipeline +- No proxies, browser extensions, or external tools +- Inspect requests and responses in real time +- Compare API responses across environments instantly +- Built for fast backend debugging with minimal setup ## Features @@ -22,19 +23,24 @@ Live Demo: https://debugprobe.dev - Compare responses across environments - JSON pretty formatting - Ignore noisy endpoints with `IgnorePaths` +- Configurable body capture size limits +- Safe compare mode with localhost protection +- Automatic masking of sensitive headers - Zero external proxies or setup ## Screenshots ### Requests -![Requests](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/requests.png) +![Requests](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_index_page_requests.png) ### Details -![Details](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/details_v1.4.0-preview.1.png) +![Details_overview](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe-details-overview.png) + +![Details_request_response](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe-details-request-response.png) ### Compare -![Compare](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/compare_v1.4.0-preview.1.png) +![Compare](https://raw.githubusercontent.com/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_compare_page.png) --- @@ -59,6 +65,10 @@ builder.Services.AddDebugProbe(options => { options.MaxEntries = 10; + options.MaxBodyCaptureSizeKb = 256; + + options.AllowLocalCompareTargets = false; + options.IgnorePaths = [ "/health", @@ -71,12 +81,12 @@ app.UseDebugProbe(); ``` ## Open The Debug UI + Run your application, then open: http://localhost:{port}/debug -![DebugProbe Short Demo](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/debugprobe_demo_live_debugging.gif) - +![DebugProbe Short Demo](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/Demos/debugprobe_demo_live_debugging.gif) ## Compare Responses @@ -86,6 +96,22 @@ Use the UI to compare responses across environments: - Enter **Trace ID** - Instantly see differences +## Security Defaults + +DebugProbe automatically masks sensitive headers: + +- Authorization +- Cookie +- Set-Cookie + +Localhost compare targets are blocked by default for safer environment comparisons. + +You can enable them manually: + +```csharp +options.AllowLocalCompareTargets = true; +``` + ## ⚠️ Production Usage This tool is intended for development. @@ -96,7 +122,6 @@ If used in production: - Restrict access - Filter sensitive data - ## License -Apache License 2.0 +Apache License 2.0 \ No newline at end of file