ProblemDetails.Serilog.AspNetCore.Middleware.Connector 6.0.1

ProblemDetails.Serilog.AspNetCore.Middleware.Connector overview

Facilitates use of serilog/serilog-aspnetcore alongside khellang/Middleware.

Serilog Diagnostic Context

Serilog provides a convenient Diagnostic Context capable of capturing an exception that occured at some point during a request. The RequestLoggingMiddleware installed by UseSerilogRequestLogging logs the exception captured in the context when there is no unhandled exception flying.

Problem Details

ProblemDetails catches exceptions and translates them to http responses generally compliant with RFC7807.

Connector Internals

Exception Capturing Middleware

This package provides exception capturing middleware that can be registered using a call to the UseSerilogRequestLoggingCaptureException extension method. This very simple middleware writes any exceptions encountered to Serilog's Diagnostic Context, without catching them.

When using UseSerilogRequestLoggingAndProblemDetails, described below, this middleware does not need to be registered explicitly.

Serilog alongside Problem Details

This package provides a UseSerilogRequestLoggingAndProblemDetails extension method that can be used in place of Serilog's UseSerilogRequestLogging and Hellang's UseProblemDetails. It also registers the exception capturing middleware provided by this package, via a call to UseSerilogRequestLoggingCaptureException. The middleware registration order is:

1. UseSerilogRequestLogging
2. UseProblemDetails
3. UseSerilogRequestLoggingCaptureException

The resulting behavior is that exceptions thrown from requests (ex. from MVC controller action methods) are writen to the diagnostic context, then caught by Problem Details, then logged by Serilog.

Problem Details configuration

This package provides a AddProblemDetailsAlongsideSerilog extension method that can be used in place of Hellang's AddProblemDetails. It calls Hellang's AddProblemDetails, but with options defaulted to request that Problem Details doesn't consider as "unhandled", and therefore doesn't log, any exceptions. The options used look like this:

options.ShouldLogUnhandledException = (httpContext, exception, problemDetails) => false;

Connector Usage

1. When configuring the application's request pipeline, Call UseSerilogRequestLoggingAndProblemDetails instead of UseSerilogRequestLogging and UseProblemDetails.
2. When configuring the application's services, Call AddProblemDetailsAlongsideSerilog instead of AddProblemDetails.