Skip to content

README.md

Latest commit

 

History

History
96 lines (64 loc) · 2.55 KB

README.md

File metadata and controls

96 lines (64 loc) · 2.55 KB

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 during API development without requiring a proxy, browser extension, or external SaaS service.

Links

Install

dotnet add package DebugProbe.AspNetCore

Quick Start

builder.Services.AddDebugProbe();

app.UseDebugProbe();

Start your application and open:

http://localhost:{port}/debug

Optional Configuration

builder.Services.AddDebugProbe(options =>
{
    options.MaxEntries = 10;

    options.MaxBodyCaptureSizeKb = 256;

    options.AllowLocalCompareTargets = true;

    options.IgnorePaths =
    [
        "/api/auth/login",
        "/api/auth/refresh"
    ];
});

app.UseDebugProbe();

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
  • Sensitive header masking
  • Outgoing HttpClient request tracing

Security Defaults

DebugProbe masks common sensitive headers automatically:

  • Authorization
  • Cookie
  • Set-Cookie

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:

https://debugprobe.dev/docs

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.