Class HttpExchangesEndpointOptions

Namespace

Steeltoe.Management.Endpoint.Actuators.HttpExchanges

Assembly

Steeltoe.Management.Endpoint.dll

public sealed class HttpExchangesEndpointOptions : EndpointOptions

Inheritance

object

EndpointOptions

HttpExchangesEndpointOptions

Inherited Members

EndpointOptions.Enabled

EndpointOptions.Id

EndpointOptions.Path

EndpointOptions.RequiredPermissions

EndpointOptions.AllowedVerbs

EndpointOptions.RequiresExactMatch()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Capacity

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

public int Capacity { get; set; }

Property Value

int

IncludePathInfo

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

public bool IncludePathInfo { get; set; }

Property Value

bool

IncludeQueryString

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

public bool IncludeQueryString { get; set; }

Property Value

bool

IncludeRemoteAddress

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

public bool IncludeRemoteAddress { get; set; }

Property Value

bool

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.

public bool IncludeRequestHeaders { get; set; }

Property Value

bool

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.

public bool IncludeResponseHeaders { get; set; }

Property Value

bool

IncludeSessionId

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

public bool IncludeSessionId { get; set; }

Property Value

bool

IncludeTimeTaken

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

public bool IncludeTimeTaken { get; set; }

Property Value

bool

IncludeUserPrincipal

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

public bool IncludeUserPrincipal { get; set; }

Property Value

bool

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.

public HashSet<string> RequestHeaders { get; }

Property Value

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

public HashSet<string> ResponseHeaders { get; }

Property Value

HashSet<string>

Reverse

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

public bool Reverse { get; set; }

Property Value

bool