Philiprehberger.HttpDebugHandler 0.2.6

Philiprehberger.HttpDebugHandler

DelegatingHandler that logs and times every outgoing HttpClient request.

Installation

dotnet add package Philiprehberger.HttpDebugHandler

Usage

using Philiprehberger.HttpDebugHandler;

// Default: writes to Console
var client = new HttpClient(new DebugHandler(new HttpClientHandler()));

// Custom callback
var handler = new DebugHandler(log =>
{
    Console.WriteLine($"{log.Method} {log.RequestUri} => {log.StatusCode} in {log.ElapsedMilliseconds} ms");
})
{
    InnerHandler = new HttpClientHandler()
};

var client = new HttpClient(handler);

var response = await client.GetAsync("https://example.com");
// Output: GET https://example.com/ => 200 in 142 ms

ASP.NET Core / IHttpClientFactory

builder.Services.AddTransient<DebugHandler>();
builder.Services.AddHttpClient("my-client")
    .AddHttpMessageHandler<DebugHandler>();

Body Capture

Enable request and/or response body logging:

var handler = new DebugHandler(log =>
{
    Console.WriteLine($"{log.Method} {log.RequestUri} => {log.StatusCode}");
    if (log.RequestBody is not null)
        Console.WriteLine($"  Request body: {log.RequestBody}");
    if (log.ResponseBody is not null)
        Console.WriteLine($"  Response body: {log.ResponseBody}");
})
{
    InnerHandler = new HttpClientHandler(),
    CaptureRequestBody = true,
    CaptureResponseBody = true,
    MaxBodyCaptureSize = 4096 // optional, default is 65536 (64 KB)
};

Header Logging

Capture request and response headers:

var handler = new DebugHandler(log =>
{
    if (log.RequestHeaders is not null)
        foreach (var h in log.RequestHeaders)
            Console.WriteLine($"  > {h.Key}: {h.Value}");

    if (log.ResponseHeaders is not null)
        foreach (var h in log.ResponseHeaders)
            Console.WriteLine($"  < {h.Key}: {h.Value}");
})
{
    InnerHandler = new HttpClientHandler(),
    CaptureHeaders = true
};

Slow Request Warning

Get notified when a request exceeds a time threshold:

var handler = new DebugHandler(log =>
{
    Console.WriteLine($"{log.Method} {log.RequestUri} => {log.StatusCode} in {log.ElapsedMilliseconds} ms");
})
{
    InnerHandler = new HttpClientHandler(),
    SlowRequestThreshold = TimeSpan.FromSeconds(2),
    OnSlowRequest = log =>
        Console.WriteLine($"SLOW REQUEST: {log.Method} {log.RequestUri} took {log.ElapsedMilliseconds} ms")
};

API

RequestLog

DebugHandler

Development

dotnet build src/Philiprehberger.HttpDebugHandler.csproj --configuration Release

License

MIT