Microsoft.AspNetCore.HttpLogging

Metadata that provides endpoint-specific settings for the HttpLogging middleware.

Initializes an instance of the class.

Specifies what fields to log for the endpoint.

Specifies what fields to log.

Indicates whether has been set.

Specifies the maximum number of bytes to be logged for the request body.

Thrown when set to a value less than 0. Thrown when getting if it hasn't been set to a value. Check first.

Indicates whether has been set.

Specifies the maximum number of bytes to be logged for the response body.

Thrown when set to a value less than 0. Thrown when getting if it hasn't been set to a value. Check first.

Flags used to control which parts of the request and response are logged.

No logging.

Flag for logging the HTTP Request Path, which includes both the and . For example: Path: /index PathBase: /app

Flag for logging the HTTP Request . For example: Query: ?index=1 RequestQuery contents can contain private information which may have regulatory concerns under GDPR and other laws. RequestQuery should not be logged unless logs are secure and access controlled and the privacy impact assessed.

Flag for logging the HTTP Request . For example: Protocol: HTTP/1.1

Flag for logging the HTTP Request . For example: Method: GET

Flag for logging the HTTP Request . For example: Scheme: https

Flag for logging the HTTP Response . For example: StatusCode: 200

Flag for logging the HTTP Request . Request Headers are logged as soon as the middleware is invoked. Headers are redacted by default with the character '[Redacted]' unless specified in the . For example: Connection: keep-alive My-Custom-Request-Header: [Redacted]

Flag for logging the HTTP Response . Response Headers are logged when the is written to or when is called. Headers are redacted by default with the character '[Redacted]' unless specified in the . For example: Content-Length: 16 My-Custom-Response-Header: [Redacted]

Flag for logging the HTTP Request . Request Trailers are currently not logged.

Flag for logging the HTTP Response . Response Trailers are currently not logged.

Flag for logging the HTTP Request . Logging the request body has performance implications, as it requires buffering the entire request body up to .

Flag for logging the HTTP Response . Logging the response body has performance implications, as it requires buffering the entire response body up to .

Flag for logging how long it took to process the request and response in milliseconds.

Flag for logging a collection of HTTP Request properties, including , , , and .

The HTTP Request is not included with this flag as it may contain private information. If desired, it should be explicitly specified with .

Flag for logging HTTP Request properties and headers. Includes and

The HTTP Request is not included with this flag as it may contain private information. If desired, it should be explicitly specified with .

Flag for logging HTTP Response properties and headers. Includes and .

Flag for logging the entire HTTP Request. Includes and . Logging the request body has performance implications, as it requires buffering the entire request body up to .

The HTTP Request is not included with this flag as it may contain private information. If desired, it should be explicitly specified with .

Flag for logging the entire HTTP Response. Includes and . Logging the response body has performance implications, as it requires buffering the entire response body up to .

Flag for logging both the HTTP Request and Response. Includes , , and . Logging the request and response body has performance implications, as it requires buffering the entire request and response body up to the and .

The HTTP Request is not included with this flag as it may contain private information. If desired, it should be explicitly specified with .

The context used for .

Settings will be pre-initialized with the relevant values from and updated with endpoint specific values from or . All settings can be modified per request. All settings will carry over from to except the which are cleared after logging the request.

The request context.

This property should not be set by user code except for testing purposes.

Gets or sets which parts of the request and response to log.

This is pre-populated with the value from , , or .

Gets or sets the maximum number of bytes of the request body to log.

This is pre-populated with the value from , , or .

Gets or sets the maximum number of bytes of the response body to log.

This is pre-populated with the value from , , or .

Gets a list of parameters that will be logged as part of the request or response. Values specified in will be added automatically after all interceptors run. All values are cleared after logging the request. All other relevant settings will carry over to the response.

If is enabled, the parameters will be logged as part of the combined log.

Adds data that will be logged as part of the request or response. See .

The parameter name. The parameter value.

Adds the given fields to what's currently enabled in .

Additional fields to enable.

Checks if any of the given fields are currently enabled in .

One or more field flags to check.

Removes the given fields from what's currently enabled in .

Fields to disable.

Disables the given fields if any are currently enabled in .

One or more field flags to disable if present. if any of the fields were previously enabled.

Middleware that logs HTTP requests and HTTP responses.

Invokes the .

HttpResponseLog.cs

Options for the .

Fields to log for the Request and Response. Defaults to logging request and response properties and headers.

Request header values that are allowed to be logged. If a request header is not present in the , 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.

Response header values that are allowed to be logged. If a response header is not present in the , the header name will be logged with a redacted value.

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.

Maximum request body size to log (in bytes). Defaults to 32 KB.

Maximum response body size to log (in bytes). Defaults to 32 KB.

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 .

Callbacks used to extend the HttpLogging middleware.

A callback to customize the logging of the request and response.

This is called when the request is first received and can be used to configure both request and response options. All settings will carry over to except the will be cleared after logging the request. may be changed per request to control the logging behavior. If no request fields are enabled, and the collection is empty, no request logging will occur. If is enabled then will carry over from the request to response and be logged together.

A callback to customize the logging of the response.

This is called when the first write to the response happens, or the response ends without a write, just before anything is sent to the client. Settings are carried over from (except the ) and response settings may still be modified. Changes to request settings will have no effect. If no response fields are enabled, and the collection is empty, no response logging will occur. If is enabled then will carry over from the request to response and be logged together. and can also be disabled in OnResponseAsync to prevent logging any buffered body data.

Retrieves the date and time currently set for this machine.

Options for HttpLogging to configure which encoding to use for each media type.

Adds a contentType to be used for logging as text.

If charset is not specified in the contentType, the encoding will default to UTF-8. The content type to add.

Adds a contentType to be used for logging as text.

The content type to add. The encoding to use.

Adds a to be used for logging as binary.

The MediaType to add.

Adds a content to be used for logging as text.

The content type to add.

Clears all MediaTypes.

The body was not read.

The body was partially read.

The body was completely read.

The body was read and truncated.

Options for the .

Gets or sets a strictly positive value representing the maximum log size in bytes or null for no limit. Once the log is full, no more messages will be appended. Defaults to 10MiB.

Gets or sets a strictly positive value representing the maximum retained file count. Defaults to 4. Must be between 1 and 10,000, inclusive.

Gets or sets a string representing the prefix of the file name used to store the logging information. The current date plus a file number (in the format {YYYYMMDD.X} will be appended to the given value. Defaults to w3clog-.

Gets or sets a string representing the directory where the log file will be written to. Defaults to ./logs/ relative to the app directory (ContentRoot). If a full path is given, that full path will be used. If a relative path is given, the full path will be that path relative to ContentRoot.

Gets or sets the period after which logs will be flushed to the store. Defaults to 1 second.

List of additional request header values to log. 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.

Fields to log. Defaults to logging request and response properties and headers, plus date/time info and server name.

Flags used to control which parts of the request and response are logged in W3C format.

No logging.

Flag for logging the date that the activity occurred.

Flag for logging the time that the activity occurred.

Flag for logging the IP address of the client that accessed the server.

Flag for logging the name of the authenticated user that accessed the server. UserName contents can contain private information which may have regulatory concerns under GDPR and other laws. UserName should not be logged unless logs are secure and access controlled and the privacy impact assessed.

Flag for logging the name of the server on which the log entry was generated.

Flag for logging the IP address of the server on which the log entry was generated.

Flag for logging the port number the client is connected to.

Flag for logging the action the client was trying to perform.

Flag for logging the resource accessed.

Flag for logging the query, if any, the client was trying to perform.

Flag for logging the HTTP response status code.

Flag for logging the duration of time, in milliseconds, that the action consumed.

Flag for logging the protocol (HTTP, FTP) version used by the client. For HTTP this will be either HTTP 1.0 or HTTP 1.1.

Flag for logging the content of the host header.

Flag for logging the requesting user agent.

Flag for logging the content of the cookie sent by the client, if any. Cookie contents can contain authentication tokens, or private information which may have regulatory concerns under GDPR and other laws. Cookies should not be logged unless logs are secure and access controlled and the privacy impact assessed.

Flag for logging the previous site visited by the user, which provided a link to the current site, if any.

Flag for logging properties that are part of the Includes , and .

Flag for logging properties that are part of the Includes , , and .

Flag for logging properties that are part of the Includes , , , , , , and .

Flag for logging all possible fields. Includes , , , , , , , , , , , , , , , , and .

Middleware that logs HTTP requests and HTTP responses.

Initializes .

Invokes the .

Extension methods for the HttpLogging middleware.

Adds a middleware that can log HTTP requests and responses.

The instance this method extends. The .

Adds a middleware that can log HTTP requests and responses for server logs in W3C format.

The instance this method extends. The .

HttpLogging middleware extension methods for .

Adds endpoint specific settings for the HttpLogging middleware.

The type of endpoint convention builder. The endpoint convention builder. The to apply to this endpoint. Sets the for this endpoint. A value of -1 means use the default setting in . Sets the for this endpoint. A value of -1 means use the default setting in . The original convention builder parameter. Thrown when or is less than 0.

Extension methods for the HttpLogging middleware.

Adds HTTP Logging services.

The for adding services. A delegate to configure the . The original service collection for chaining.

Registers the given type as a in the DI container.

A type that implements . The service collection. The original service collection for chaining.

Adds W3C Logging services.

The for adding services. A delegate to configure the . The original service collection for chaining.

Provides support for efficiently using Tasks to implement the APM (Begin/End) pattern.

Marshals the Task as an IAsyncResult, using the supplied callback and state to implement the APM pattern.

The Task to be marshaled. The callback to be invoked upon completion. The state to be stored in the IAsyncResult. An IAsyncResult to represent the task's asynchronous operation.

Processes an IAsyncResult returned by Begin.

The IAsyncResult to unwrap.

Processes an IAsyncResult returned by Begin.

The IAsyncResult to unwrap.

Provides a simple IAsyncResult that wraps a Task.

We could use the Task as the IAsyncResult if the Task's AsyncState is the same as the object state, but that's very rare, in particular in a situation where someone cares about allocation, and always using TaskAsyncResult simplifies things and enables additional optimizations.

The wrapped Task.

Callback to invoke when the wrapped task completes.

Initializes the IAsyncResult with the Task to wrap and the associated object state.

The Task to wrap. The new AsyncState value. Callback to invoke when the wrapped task completes.

Invokes the callback.

Gets a user-defined object that qualifies or contains information about an asynchronous operation.

Gets a value that indicates whether the asynchronous operation completed synchronously.

This is set lazily based on whether the has completed by the time this object is created.

Gets a value that indicates whether the asynchronous operation has completed.

Gets a that is used to wait for an asynchronous operation to complete.

The End represents the offset into AvailableMemory where the range of "active" bytes ends. At the point when the block is leased the End is guaranteed to be equal to Start. The value of Start may be assigned anywhere between 0 and Buffer.Length, and must be equal to or less than End.

Reference to the next block of data when the overall "active" bytes spans multiple blocks. At the point when the block is leased Next is guaranteed to be null. Start, End, and Next are used together in order to create a linked-list of discontiguous working memory. The "active" memory is grown when bytes are copied in, End is increased, and Next is assigned. The "active" memory is shrunk when bytes are consumed, Start is increased, and blocks are returned to the pool.

A simple struct we wrap reference types inside when storing in arrays to bypass the CLR's covariant checks when writing to arrays.

We use as a wrapper to avoid paying the cost of covariant checks whenever the underlying array that the class uses is written to. We've recognized this as a perf win in ETL traces for these stack frames: clr!JIT_Stelem_Ref clr!ArrayStoreCheck clr!ObjIsInstanceOf

Get a pinnable reference to the builder. Does not ensure there is a null char after This overload is pattern matched in the C# 7.3+ compiler so you can omit the explicit method call, and write eg "fixed (char* c = builder)"

Get a pinnable reference to the builder.

Ensures that the builder has a null char after

Returns the underlying storage of the builder.

Returns a span around the contents of the builder.

Ensures that the builder has a null char after

Resize the internal buffer either by doubling current buffer size or by adding to whichever is greater.

Number of chars requested beyond current position.