Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed Assets/Demos/debugprobe_demo_live_debugging.gif
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file removed Assets/Screenshots/debugprobe_compare_page.png
Binary file not shown.
Binary file not shown.
11 changes: 6 additions & 5 deletions DebugProbe.AspNetCore/DebugProbe.AspNetCore.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,18 @@
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<LangVersion>latest</LangVersion>

<GenerateDocumentationFile>true</GenerateDocumentationFile>

<PackageId>DebugProbe.AspNetCore</PackageId>
<Version>1.4.1-preview.1</Version>
<Version>1.4.1-preview.2</Version>

<Authors>Georgi Hristov</Authors>

<Description>Debug HTTP requests and responses directly inside ASP.NET Core applications with a built-in tracing and comparison UI.</Description>

<PackageTags>aspnetcore;debugging;http;middleware;api;diagnostics;tracing;observability</PackageTags>
<Description>Inspect and debug HTTP requests and responses directly inside ASP.NET Core applications.</Description>

<PackageTags>aspnetcore;debugging;http;middleware;diagnostics;tracing;observability;api-debugging;developer-tools</PackageTags>

<PackageIcon>icon.png</PackageIcon>
<PackageReadmeFile>README.md</PackageReadmeFile>

Expand Down
117 changes: 53 additions & 64 deletions DebugProbe.AspNetCore/README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,18 @@
# DebugProbe.AspNetCore
# DebugProbe.AspNetCore

**Debug HTTP traffic directly from inside your ASP.NET Core pipeline.**
Debug HTTP traffic directly inside your ASP.NET Core pipeline.

[![DebugProbe](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/Logos/debugprobe_icon_white_rounded_180px.png)](https://debugprobe.dev)
[DebugProbe Website](https://debugprobe.dev)

Live Demo: https://debugprobe.dev
---

## Why Use DebugProbe?
## Why DebugProbe?

- 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

- Capture HTTP requests and responses
- Inspect headers, query params, and body
- No proxies or external tools
- Built-in request tracing UI
- 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/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_index_page_requests.png)

### Details
![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/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_compare_page.png)
- Minimal setup for ASP.NET Core applications

---

Expand All @@ -50,6 +22,8 @@ Live Demo: https://debugprobe.dev
dotnet add package DebugProbe.AspNetCore
```

---

## Quick Start

```csharp
Expand All @@ -58,7 +32,15 @@ builder.Services.AddDebugProbe();
app.UseDebugProbe();
```

## Customize DebugProbe
Open:

```txt
http://localhost:{port}/debug
```

---

## Optional Configuration

```csharp
builder.Services.AddDebugProbe(options =>
Expand All @@ -67,60 +49,67 @@ builder.Services.AddDebugProbe(options =>

options.MaxBodyCaptureSizeKb = 256;

options.AllowLocalCompareTargets = false;
options.AllowLocalCompareTargets = true;

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

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/Demos/debugprobe_demo_live_debugging.gif)
---

## Compare Responses
## Features

Use the UI to compare responses across environments:
- Request and response inspection
- Headers, query params, and body capture
- Response comparison across environments
- JSON formatting
- Configurable body capture limits
- Ignore noisy endpoints
- Sensitive header masking

- Enter **Base URL**
- Enter **Trace ID**
- Instantly see differences
---

## Security Defaults

DebugProbe automatically masks sensitive headers:
Sensitive headers are automatically masked:

- Authorization
- Cookie
- Set-Cookie

Localhost compare targets are blocked by default for safer environment comparisons.
Localhost compare targets are blocked by default.

You can enable them manually:

```csharp
options.AllowLocalCompareTargets = true;
```
---

## ⚠️ Production Usage
## Production Usage

This tool is intended for development.
DebugProbe is intended primarily for development environments.

If used in production:

- Add authentication
- Restrict access
- Filter sensitive data
- add authentication
- restrict access
- filter sensitive data

---

## Documentation & Demo

Visit the website for:
- latest screenshots
- demos
- guides
- updates

https://debugprobe.dev

---

## License

Expand Down
117 changes: 53 additions & 64 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,18 @@
# DebugProbe.AspNetCore
# DebugProbe.AspNetCore

**Debug HTTP traffic directly from inside your ASP.NET Core pipeline.**
Debug HTTP traffic directly inside your ASP.NET Core pipeline.

[![DebugProbe](https://raw.githubusercontent.com/georgidhristov/DebugProbe.AspNetCore/main/Assets/Logos/debugprobe_icon_white_rounded_180px.png)](https://debugprobe.dev)
[DebugProbe Website](https://debugprobe.dev)

Live Demo: https://debugprobe.dev
---

## Why Use DebugProbe?
## Why DebugProbe?

- 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

- Capture HTTP requests and responses
- Inspect headers, query params, and body
- No proxies or external tools
- Built-in request tracing UI
- 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/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_index_page_requests.png)

### Details
![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/DebugProbe/DebugProbe.AspNetCore/main/Assets/Screenshots/debugprobe_compare_page.png)
- Minimal setup for ASP.NET Core applications

---

Expand All @@ -50,6 +22,8 @@ Live Demo: https://debugprobe.dev
dotnet add package DebugProbe.AspNetCore
```

---

## Quick Start

```csharp
Expand All @@ -58,7 +32,15 @@ builder.Services.AddDebugProbe();
app.UseDebugProbe();
```

## Customize DebugProbe
Open:

```txt
http://localhost:{port}/debug
```

---

## Optional Configuration

```csharp
builder.Services.AddDebugProbe(options =>
Expand All @@ -67,60 +49,67 @@ builder.Services.AddDebugProbe(options =>

options.MaxBodyCaptureSizeKb = 256;

options.AllowLocalCompareTargets = false;
options.AllowLocalCompareTargets = true;

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

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/Demos/debugprobe_demo_live_debugging.gif)
---

## Compare Responses
## Features

Use the UI to compare responses across environments:
- Request and response inspection
- Headers, query params, and body capture
- Response comparison across environments
- JSON formatting
- Configurable body capture limits
- Ignore noisy endpoints
- Sensitive header masking

- Enter **Base URL**
- Enter **Trace ID**
- Instantly see differences
---

## Security Defaults

DebugProbe automatically masks sensitive headers:
Sensitive headers are automatically masked:

- Authorization
- Cookie
- Set-Cookie

Localhost compare targets are blocked by default for safer environment comparisons.
Localhost compare targets are blocked by default.

You can enable them manually:

```csharp
options.AllowLocalCompareTargets = true;
```
---

## ⚠️ Production Usage
## Production Usage

This tool is intended for development.
DebugProbe is intended primarily for development environments.

If used in production:

- Add authentication
- Restrict access
- Filter sensitive data
- add authentication
- restrict access
- filter sensitive data

---

## Documentation & Demo

Visit the website for:
- latest screenshots
- demos
- guides
- updates

https://debugprobe.dev

---

## License

Expand Down
Loading