HttpLoggingOptions Class

Definition

Namespace:

Microsoft.AspNetCore.HttpLogging

Assembly:

Microsoft.AspNetCore.HttpLogging.dll

Package:

Microsoft.AspNetCore.App.Ref v8.0.0

Source:

HttpLoggingOptions.cs

Options for the Microsoft.AspNetCore.HttpLogging.HttpLoggingMiddleware.

public sealed class HttpLoggingOptions

type HttpLoggingOptions = class

Public NotInheritable Class HttpLoggingOptions

Inheritance

Object

HttpLoggingOptions

Constructors

HttpLoggingOptions()

Properties

CombineLogs	Gets or sets if the middleware will combine the request, request body, response, response body, and duration logs into a single log entry. The default is false.
LoggingFields	Fields to log for the Request and Response. Defaults to logging request and response properties and headers.
MediaTypeOptions	Options for configuring encodings for a specific media type. If the request or response do not match the supported media type, the response body will not be logged.
RequestBodyLogLimit	Maximum request body size to log (in bytes). Defaults to 32 KB.
RequestHeaders	Request header values that are allowed to be logged. If a request header is not present in the RequestHeaders, the header name will be logged with a redacted value. Request headers can contain authentication tokens, or private information which may have regulatory concerns under GDPR and other laws. Arbitrary request headers should not be logged unless logs are secure and access controlled and the privacy impact assessed.
ResponseBodyLogLimit	Maximum response body size to log (in bytes). Defaults to 32 KB.
ResponseHeaders	Response header values that are allowed to be logged. If a response header is not present in the ResponseHeaders, the header name will be logged with a redacted value.