DebugProbe.AspNetCore
2.0.0
dotnet add package DebugProbe.AspNetCore --version 2.0.0
NuGet\Install-Package DebugProbe.AspNetCore -Version 2.0.0
<PackageReference Include="DebugProbe.AspNetCore" Version="2.0.0" />
<PackageVersion Include="DebugProbe.AspNetCore" Version="2.0.0" />
<PackageReference Include="DebugProbe.AspNetCore" />
paket add DebugProbe.AspNetCore --version 2.0.0
#r "nuget: DebugProbe.AspNetCore, 2.0.0"
#:package DebugProbe.AspNetCore@2.0.0
#addin nuget:?package=DebugProbe.AspNetCore&version=2.0.0
#tool nuget:?package=DebugProbe.AspNetCore&version=2.0.0
DebugProbe.AspNetCore
DebugProbe.AspNetCore is a lightweight ASP.NET Core debugging tool for inspecting HTTP traffic directly inside your application.
It captures request and response data, exposes a local dashboard, and helps compare traces across environments so you can spot differences between local, staging, and other API runs.
Links
- Website: debugprobe.dev
- Documentation: debugprobe.dev/docs
- Roadmap: Roadmap.md
- Live demo: demo.debugprobe.dev/debug
- Demo API: demo.debugprobe.dev/swagger
- NuGet: DebugProbe.AspNetCore
Version Compatibility
| DebugProbe.AspNetCore | Target framework | Compatible application versions |
|---|---|---|
| 2.x (starting with 2.0.0) | net10.0 |
.NET 10 and later compatible .NET versions |
| 1.x targeting net8.0 (for example, 1.6.10) | net8.0 |
.NET 8, .NET 9, and later compatible .NET versions |
Version 2.0.0 requires .NET 10 and ASP.NET Core 10. Building this repository requires the .NET 10 SDK. Applications staying on .NET 8 or .NET 9 should use a compatible 1.x release, such as 1.6.10:
dotnet add package DebugProbe.AspNetCore --version 1.6.10
Compatibility does not extend Microsoft's support lifecycle for the application's .NET runtime. Version 2.0.0 also contains breaking configuration and API changes described below.
Install
dotnet add package DebugProbe.AspNetCore
Quick Start
using DebugProbe.AspNetCore.Extensions;
var builder = WebApplication.CreateBuilder(args);
builder.Services.AddDebugProbe();
var app = builder.Build();
app.UseDebugProbe();
app.MapGet("/hello", () => "Hello!");
app.Run();
Start your application and open:
http://localhost:{port}/debug
In Production, DebugProbe captures traces but does not register UI endpoints unless explicitly enabled. DebugProbe does not require authentication by default.
Optional Configuration
builder.Services.AddDebugProbe(options =>
{
options.MaxRequests = 10;
options.MaxBodySizeKb = 256;
options.AllowLocalCompareTargets = true;
options.AllowUiInProduction = false;
options.CaptureOutgoingRequests = true;
options.ExcludedPaths =
[
..options.ExcludedPaths,
"/api/auth/login",
"/api/auth/refresh"
];
options.RedactedHeaders =
[
..options.RedactedHeaders,
"X-Api-Key",
"X-Auth-Token"
];
options.RedactedQueryParameters =
[
"api_key",
"access_token"
];
options.RedactedJsonFields =
[
"password",
"refreshToken"
];
});
app.UseDebugProbe();
Configure options in AddDebugProbe; UseDebugProbe() only enables the middleware and endpoints.
Enabled = falsedisables capture and all DebugProbe endpoints.MaxBodySizeKb = 0disables all body capture. Headers and request metadata are still captured.CaptureRequestBodyandCaptureResponseBodyindependently control incoming and outgoing bodies (both default totrue).SlowRequestThreshold = TimeSpan.FromSeconds(1)controls slow badges;TimeSpan.Zerodisables them.ExcludedPathsreplaces the defaults. Use[..options.ExcludedPaths, "/other"]to extend them, or[]to capture all application paths.RoutePrefixdefaults to"/debug"and applies to the dashboard, assets, APIs, and compare page (/debug/compare).
Standard .NET options configuration is also supported:
using DebugProbe.AspNetCore.Options;
builder.Services.AddDebugProbe();
builder.Services.Configure<DebugProbeOptions>(builder.Configuration.GetSection("DebugProbe"));
Body capture uses the same rules for incoming and outgoing requests and responses:
- The size limit applies to original body bytes; oversized text keeps a prefix followed by
[truncated]. - Text uses the declared charset, with UTF-8 as the fallback; truncation does not leave a partial encoded character.
- Binary content is represented by
[Body not captured: non-text content]; empty or disabled bodies are empty strings. - If JSON field redaction is configured, truncated content is omitted because incomplete JSON cannot be reliably redacted.
- Captured JSON is redacted before storage and formatted for display. Application payloads remain intact.
Options are validated at startup. Configuration is fixed for the application's lifetime.
Migrating from 1.x to 2.0
- Upgrade the application to .NET 10 before installing version 2.0.0.
- Configure DebugProbe in
builder.Services.AddDebugProbe(...), beforebuilder.Build(); replaceapp.UseDebugProbe(options => ...)withapp.UseDebugProbe().
| Previous option | Replacement |
|---|---|
MaxEntries |
MaxRequests |
MaxBodyCaptureSizeKb |
MaxBodySizeKb |
IgnorePaths |
ExcludedPaths |
CaptureOutgoingHttpClientRequests |
CaptureOutgoingRequests |
SlowRequestThresholdMs = 1000 |
SlowRequestThreshold = TimeSpan.FromSeconds(1) |
TrendLookbackMinutes, AutoEnvironmentDiff, and RedactionText have been removed. Sensitive values use the fixed [REDACTED] marker; trace comparison remains available manually.
ExcludedPaths now contains editable defaults. Assigning an array replaces them; use [..options.ExcludedPaths, "/other"] to extend them. DebugProbe endpoints remain excluded automatically.
Additional API and behavior changes:
DebugEntryStore.Instancehas been removed; resolve the store through dependency injection when needed.OutgoingRequestsis a concurrent queue: useEnqueue(...)instead ofAdd(...).ExceptionGroupsreturns anIReadOnlyDictionarysnapshot instead of a mutable concurrent dictionary.- The compare page moved from
/compareto/debug/compare(or{RoutePrefix}/compare); update bookmarks and links. Remote trace comparison currently uses the same route prefix on both applications. - Oversized text now keeps a prefix with
[truncated]instead of[Body too large]. When JSON field redaction is configured, truncated content is omitted. - Captured outgoing JSON is stored without pretty-printing and formatted for display, matching incoming capture.
For endpoint authorization, see Security Defaults below.
Features
- Request inspection
- Response inspection
- Headers, query string, and body capture
- Error visibility
- Local debugging dashboard
- Trace comparison across runs or environments
- JSON formatting for captured payloads
- Configurable body capture limits
- Ignored path configuration for noisy or sensitive endpoints
- Configurable redaction for sensitive headers, query parameters, and JSON fields
- Optional ASP.NET Core authorization policy protection for DebugProbe endpoints
- Optional outgoing
HttpClientrequest tracing
Trace Compare
DebugProbe can compare a local trace with a trace captured by another DebugProbe-enabled application.
Typical workflow:
- Run both applications with DebugProbe enabled.
- Open the local dashboard at
/debug. - Open the trace you want to compare.
- Use the compare action and provide the remote application's base URL and trace ID.
Compare is useful when checking differences between local and remote environments, repeated runs, or two versions of the same API flow.
Dynamic values such as IDs, timestamps, tokens, and selected headers are normalized so the compare view focuses on meaningful request and response differences.
Security Defaults
DebugProbe UI endpoints are disabled by default in Production. Capture and trace storage continue to run, but the dashboard, trace viewer, compare UI, UI assets, and UI clear action are not registered unless explicitly enabled:
builder.Services.AddDebugProbe(options =>
{
options.AllowUiInProduction = true;
});
DebugProbe does not require authentication by default. If you expose DebugProbe outside local development, configure an ASP.NET Core authorization policy and require it for DebugProbe endpoints:
builder.Services.AddAuthorization(options =>
{
options.AddPolicy("DebugProbePolicy", policy =>
{
policy.RequireAuthenticatedUser();
policy.RequireRole("Admin");
});
});
builder.Services.AddDebugProbe(options =>
{
options.AuthorizationPolicy = "DebugProbePolicy";
});
app.UseAuthentication();
app.UseAuthorization();
app.UseDebugProbe();
DebugProbe masks common sensitive headers automatically:
AuthorizationCookieSet-Cookie
You can also configure application-specific values to redact before traces are stored:
builder.Services.AddDebugProbe(options =>
{
options.RedactedHeaders =
[
..options.RedactedHeaders,
"X-Api-Key",
"Client-Secret"
];
options.RedactedQueryParameters = ["token", "api_key", "access_token"];
options.RedactedJsonFields = ["password", "secret", "refreshToken"];
});
Intended Usage
DebugProbe is designed primarily for local development and controlled development environments.
If you use it outside local development, protect the dashboard with authentication, restrict network access, and avoid capturing sensitive endpoints or payloads.
Documentation
For full setup details, screenshots, dashboard behavior, configuration options, and live examples, see the documentation:
Contributing
Contributions are welcome. Please read CONTRIBUTING.md before opening an issue or pull request.
License
DebugProbe.AspNetCore is licensed under the Apache License 2.0.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. 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. |
-
net10.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 2.0.0 | 96 | 11/2/2026 |
| 1.6.10 | 200 | 7/19/2026 |
| 1.6.9 | 131 | 7/12/2026 |
| 1.6.8 | 127 | 7/9/2026 |
| 1.6.7 | 126 | 7/5/2026 |
| 1.6.6 | 127 | 6/29/2026 |
| 1.6.5 | 131 | 6/25/2026 |
| 1.6.4 | 132 | 6/13/2026 |
| 1.6.3 | 129 | 6/11/2026 |
| 1.6.2 | 135 | 6/7/2026 |
| 1.6.1 | 133 | 6/1/2026 |
| 1.6.0 | 134 | 5/29/2026 |
| 1.5.0 | 129 | 5/23/2026 |
| 1.5.0-preview.1 | 75 | 5/23/2026 |
| 1.4.1-preview.2 | 85 | 5/22/2026 |
| 1.4.1-preview.1 | 72 | 5/17/2026 |
| 1.4.0 | 128 | 5/16/2026 |
| 1.4.0-preview.2 | 74 | 5/16/2026 |
| 1.4.0-preview.1 | 80 | 5/12/2026 |
| 1.3.2 | 120 | 5/13/2026 |
- Targets .NET 10; applications on .NET 8 or 9 should stay on compatible 1.x releases.
- Breaking API changes: simplified options, configuration only in AddDebugProbe, and concurrent outgoing request storage.
- Fixed custom route prefixes, capture failure isolation, and concurrent storage operations.
- Removed the global storage instance and unified body capture limits, encoding, truncation, and redaction.