Share via

ExceptionHandlerOptions Class

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.Diagnostics.dll
Package:
Microsoft.AspNetCore.Diagnostics v1.0.0
Package:
Microsoft.AspNetCore.Diagnostics v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0-preview.7.25380.108
Package:
Microsoft.AspNetCore.Diagnostics v2.0.0
Package:
Microsoft.AspNetCore.Diagnostics v2.1.0
Package:
Microsoft.AspNetCore.Diagnostics v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
ExceptionHandlerOptions.cs
Source:
ExceptionHandlerOptions.cs
Source:
ExceptionHandlerOptions.cs

Options for configuring the ExceptionHandlerMiddleware.

public ref class ExceptionHandlerOptions
public class ExceptionHandlerOptions
type ExceptionHandlerOptions = class
Public Class ExceptionHandlerOptions
Inheritance
Object
ExceptionHandlerOptions

Constructors

ExceptionHandlerOptions()

Properties

AllowStatusCode404Response

This value controls whether the ExceptionHandlerMiddleware should consider a response with a 404 status code to be a valid result of executing the ExceptionHandler. The default value is false and the middleware will consider 404 status codes to be an error on the server and will therefore rethrow the original exception.
CreateScopeForErrors

Gets or sets whether the handler needs to create a separate IServiceProvider scope and replace it on RequestServices when re-executing the request to handle an error.
ExceptionHandler

The RequestDelegate that will handle the exception. If this is not explicitly provided, the subsequent middleware pipeline will be used by default.
ExceptionHandlingPath

The path to the exception handling endpoint. This path will be used when executing the ExceptionHandler.
StatusCodeSelector

Gets or sets a delegate used to map an exception to an HTTP status code.
SuppressDiagnosticsCallback

Gets or sets a callback that can return true to suppress diagnostics in ExceptionHandlerMiddleware.

If SuppressDiagnosticsCallback is null, the default behavior is to suppress diagnostics if the exception was handled by an IExceptionHandler service instance registered in the DI container. To always record diagnostics for handled exceptions, set a callback that returns false.

This callback is only run if the exception was handled by the middleware. Unhandled exceptions and exceptions thrown after the response has started are always logged.

Suppressed diagnostics include:

  • Logging UnhandledException to ILogger.
  • Writing the Microsoft.AspNetCore.Diagnostics.HandledException event to EventSource.
  • Adding the error.type tag to the http.server.request.duration metric.

Applies to