Class HttpExchangesEndpointOptions

Inheritance

System.Object

EndpointOptions

HttpExchangesEndpointOptions

Inherited Members

EndpointOptions.Enabled

EndpointOptions.Id

EndpointOptions.Path

EndpointOptions.RequiredPermissions

EndpointOptions.AllowedVerbs

EndpointOptions.GetDefaultAllowedVerbs()

EndpointOptions.RequiresExactMatch()

Namespace: Steeltoe.Management.Endpoint.Actuators.HttpExchanges

Assembly: Steeltoe.Management.Endpoint.dll

Syntax

public sealed class HttpExchangesEndpointOptions : EndpointOptions

Properties

Capacity

Gets or sets a value indicating how many HTTP exchanges should be stored. Default value: 100.

Declaration

public int Capacity { get; set; }

Property Value

Type	Description
System.Int32

IncludePathInfo

Gets or sets a value indicating whether the path from the HTTP request URL should be returned. Default value: true.

Declaration

public bool IncludePathInfo { get; set; }

Property Value

Type	Description
System.Boolean

IncludeQueryString

Gets or sets a value indicating whether the query string parameters from the request URL should be returned. Default value: true.

Declaration

public bool IncludeQueryString { get; set; }

Property Value

Type	Description
System.Boolean

IncludeRemoteAddress

Gets or sets a value indicating whether the IP address of the request's sender should be returned. Default value: false.

Declaration

public bool IncludeRemoteAddress { get; set; }

Property Value

Type	Description
System.Boolean

IncludeRequestHeaders

Gets or sets a value indicating whether headers from the HTTP request should be returned. Default value: true.

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.

Declaration

public bool IncludeRequestHeaders { get; set; }

Property Value

Type	Description
System.Boolean

IncludeResponseHeaders

Gets or sets a value indicating whether headers from the HTTP response should be returned. Default value: true.

If a response header is not present in the ResponseHeaders, the header name will be logged with a redacted value.

Declaration

public bool IncludeResponseHeaders { get; set; }

Property Value

Type	Description
System.Boolean

IncludeSessionId

Gets or sets a value indicating whether the user's session ID should be returned. Default value: false.

Declaration

public bool IncludeSessionId { get; set; }

Property Value

Type	Description
System.Boolean

IncludeTimeTaken

Gets or sets a value indicating whether the time taken to process the request should be returned. Default value: true.

Declaration

public bool IncludeTimeTaken { get; set; }

Property Value

Type	Description
System.Boolean

IncludeUserPrincipal

Gets or sets a value indicating whether the username of the should be returned. Default value: false.

Declaration

public bool IncludeUserPrincipal { get; set; }

Property Value

Type	Description
System.Boolean

RequestHeaders

Gets 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.

Declaration

public HashSet<string> RequestHeaders { get; }

Property Value

Type	Description
HashSet<System.String>

ResponseHeaders

Gets 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.

Declaration

public HashSet<string> ResponseHeaders { get; }

Property Value

Type	Description
HashSet<System.String>

Reverse

Gets or sets a value indicating whether to return HTTP exchanges in reverse order (newest exchanges first). Default value: true.

Declaration

public bool Reverse { get; set; }

Property Value

Type	Description
System.Boolean