RequestLog (filter-service-metrics 1.12 1.12 API)

All Superinterfaces:

io.netty.util.AttributeMap

All Known Implementing Classes:

DefaultRequestLog
```
public interface RequestLog
extends io.netty.util.AttributeMap
```
A set of informational properties collected while processing a Request and its Response. The properties provided by this class are not always fully available. Check the availability of each property using isAvailable(RequestLogAvailability) or availabilities(). Attempting to access the properties that are not available yet will cause a RequestLogAvailabilityException. Use addListener(RequestLogListener, RequestLogAvailability) to get notified when the interested properties are available.

See Also:

RequestContext.log(), RequestLogAvailability, RequestLogListener

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addListener(RequestLogListener listener, Iterable<RequestLogAvailability> availabilities)` Adds the specified `RequestLogListener` so that it's notified when all of the specified `RequestLogAvailability`s are satisfied.
`void`	`addListener(RequestLogListener listener, RequestLogAvailability... availabilities)` Adds the specified `RequestLogListener` so that it's notified when all of the specified `RequestLogAvailability`s are satisfied.
`void`	`addListener(RequestLogListener listener, RequestLogAvailability availability)` Adds the specified `RequestLogListener` so that it's notified when the specified `RequestLogAvailability` is satisfied.
`Iterator<io.netty.util.Attribute<?>>`	`attrs()` Returns all `Attribute`s set in this log.
`default String`	`authority()` Returns the authority of the `Request`.
`Set<RequestLogAvailability>`	`availabilities()` Returns the set of satisfied `RequestLogAvailability`s.
`io.netty.channel.Channel`	`channel()` Returns the Netty `Channel` which handled the `Request`.
`List<RequestLog>`	`children()` Returns the list of child `RequestLog`s, ordered by the time it was added.
`RequestContext`	`context()` Returns the `RequestContext` associated with the `Request` being handled.
`default String`	`decodedPath()` Returns the absolute path part of the current `Request` URI, excluding the query part, decoded in UTF-8.
`default void`	`ensureAvailability(Iterable<RequestLogAvailability> properties)` Ensures that all of the specified `RequestLogAvailability`s are satisfied.
`default void`	`ensureAvailability(RequestLogAvailability... availabilities)` Ensures that all of the specified `RequestLogAvailability`s are satisfied.
`default void`	`ensureAvailability(RequestLogAvailability availability)` Ensures that the specified `RequestLogAvailability` is satisfied.
`default String`	`host()` Deprecated. Do not use this method. Get the remote or local address from `context()` or get the authority from `authority()`.
`default RequestId`	`id()` Returns the `RequestId`.
`default boolean`	`isAvailable(Iterable<RequestLogAvailability> availabilities)` Returns `true` if all of the specified `RequestLogAvailability`s are satisfied.
`default boolean`	`isAvailable(RequestLogAvailability... availabilities)` Returns `true` if all of the specified `RequestLogAvailability`s are satisfied.
`boolean`	`isAvailable(RequestLogAvailability availability)` Returns `true` if the specified `RequestLogAvailability` is satisfied.
`default HttpMethod`	`method()` Returns the method of the `Request`.
`default String`	`path()` Returns the absolute path part of the `Request` URI, excluding the query part, as defined in RFC3986.
`default String`	`query()` Returns the query part of the `Request` URI, without the leading `'?'`
`Object`	`rawRequestContent()` Returns the low-level content object of the `Request`, which is specific to the `SerializationFormat`.
`Object`	`rawResponseContent()` Returns the low-level content object of the `Response`, which is specific to the `SerializationFormat`.
`Throwable`	`requestCause()` Returns the cause of request processing failure.
`Object`	`requestContent()` Returns the high-level content object of the `Request`, which is specific to the `SerializationFormat`.
`String`	`requestContentPreview()` Returns the preview of response content of the `Request`.
`long`	`requestDurationNanos()` Returns the duration that was taken to consume or produce the request completely, in nanoseconds.
`long`	`requestEndTimeNanos()` Returns the time when the processing of the request finished, in nanoseconds.
`long`	`requestFirstBytesTransferredTimeNanos()` Returns the time when the first bytes of the request headers were transferred over the wire.
`RequestHeaders`	`requestHeaders()` Returns the `RequestHeaders`.
`long`	`requestLength()` Returns the length of the request content.
`long`	`requestStartTimeMicros()` Returns the time when the processing of the request started, in microseconds since the epoch.
`long`	`requestStartTimeMillis()` Returns the time when the processing of the request started, in milliseconds since the epoch.
`long`	`requestStartTimeNanos()` Returns the time when the processing of the request started, in nanoseconds.
`HttpHeaders`	`requestTrailers()` Returns the HTTP trailers of the `Request`.
`Throwable`	`responseCause()` Returns the cause of response processing failure.
`Object`	`responseContent()` Returns the high-level content object of the `Response`, which is specific to the `SerializationFormat`.
`String`	`responseContentPreview()` Returns the preview of response content of the `Response`.
`long`	`responseDurationNanos()` Returns the duration that was taken to consume or produce the response completely, in nanoseconds.
`long`	`responseEndTimeNanos()` Returns the time when the processing of the response finished, in nanoseconds.
`long`	`responseFirstBytesTransferredTimeNanos()` Returns the time when the first bytes of the response headers were transferred over the wire.
`ResponseHeaders`	`responseHeaders()` Returns the non-informational status `ResponseHeaders`.
`long`	`responseLength()` Returns the length of the response content.
`long`	`responseStartTimeMicros()` Returns the time when the processing of the response started, in microseconds since the epoch.
`long`	`responseStartTimeMillis()` Returns the time when the processing of the response started, in milliseconds since the epoch.
`long`	`responseStartTimeNanos()` Returns the time when the processing of the response started, in nanoseconds.
`HttpHeaders`	`responseTrailers()` Returns the HTTP trailers of the `Response`.
`Scheme`	`scheme()` Returns the `Scheme` of the `Request`.
`SerializationFormat`	`serializationFormat()` Returns the `SerializationFormat` of the `Request`.
`SessionProtocol`	`sessionProtocol()` Returns the `SessionProtocol` of the `Request`.
`SSLSession`	`sslSession()` Returns the `SSLSession` of the connection which handled the `Request`.
`default HttpStatus`	`status()` Returns the status of the `Response`.
`default int`	`statusCode()` Returns the status code of the `Response`.
`String`	`toStringRequestOnly()` Returns the string representation of the `Request`, with no sanitization of headers or content.
`String`	`toStringRequestOnly(Function<? super HttpHeaders,?> headersSanitizer, Function<Object,?> contentSanitizer)` Returns the string representation of the `Request`.
`String`	`toStringRequestOnly(Function<? super RequestHeaders,?> headersSanitizer, Function<Object,?> contentSanitizer, Function<? super HttpHeaders,?> trailersSanitizer)` Returns the string representation of the `Request`.
`String`	`toStringResponseOnly()` Returns the string representation of the `Response`, with no sanitization of headers or content.
`String`	`toStringResponseOnly(Function<? super HttpHeaders,?> headersSanitizer, Function<Object,?> contentSanitizer)` Returns the string representation of the `Response`.
`String`	`toStringResponseOnly(Function<? super ResponseHeaders,?> headersSanitizer, Function<Object,?> contentSanitizer, Function<? super HttpHeaders,?> trailersSanitizer)` Returns the string representation of the `Response`.
`long`	`totalDurationNanos()` Returns the amount of time taken since the `Request` processing started and until the `Response` processing ended.

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

- Method Detail
  - attrs
```
Iterator<io.netty.util.Attribute<?>> attrs()
```
    Returns all Attributes set in this log.
  - children
```
List<RequestLog> children()
```
    Returns the list of child RequestLogs, ordered by the time it was added.
  - availabilities
```
Set<RequestLogAvailability> availabilities()
```
    Returns the set of satisfied RequestLogAvailabilitys.
  - isAvailable
```
boolean isAvailable(RequestLogAvailability availability)
```
    Returns true if the specified RequestLogAvailability is satisfied.
  - isAvailable
```
default boolean isAvailable(RequestLogAvailability... availabilities)
```
    Returns true if all of the specified RequestLogAvailabilitys are satisfied.
  - isAvailable
```
default boolean isAvailable(Iterable<RequestLogAvailability> availabilities)
```
    Returns true if all of the specified RequestLogAvailabilitys are satisfied.
  - ensureAvailability
```
default void ensureAvailability(RequestLogAvailability availability)
```
    Ensures that the specified RequestLogAvailability is satisfied.
    
    Throws:
    
    RequestLogAvailabilityException - if not satisfied yet
  - ensureAvailability
```
default void ensureAvailability(RequestLogAvailability... availabilities)
```
    Ensures that all of the specified RequestLogAvailabilitys are satisfied.
    
    Throws:
    
    RequestLogAvailabilityException - if not satisfied yet
  - ensureAvailability
```
default void ensureAvailability(Iterable<RequestLogAvailability> properties)
```
    Ensures that all of the specified RequestLogAvailabilitys are satisfied.
    
    Throws:
    
    RequestLogAvailabilityException - if not satisfied yet
  - addListener
```
void addListener(RequestLogListener listener,
                 RequestLogAvailability availability)
```
    Adds the specified RequestLogListener so that it's notified when the specified RequestLogAvailability is satisfied.
  - addListener
```
void addListener(RequestLogListener listener,
                 RequestLogAvailability... availabilities)
```
    Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.
  - addListener
```
void addListener(RequestLogListener listener,
                 Iterable<RequestLogAvailability> availabilities)
```
    Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.
  - context
```
RequestContext context()
```
    Returns the RequestContext associated with the Request being handled. This method returns non-null regardless the current RequestLogAvailability.
  - id
```
default RequestId id()
```
    Returns the RequestId. This method is a shortcut to context().id().
  - method
```
default HttpMethod method()
```
    Returns the method of the Request. This method is a shortcut to context().method(). This method returns non-null regardless the current RequestLogAvailability.
  - path
```
default String path()
```
    Returns the absolute path part of the Request URI, excluding the query part, as defined in RFC3986. This method is a shortcut to context().path(). This method returns non-null regardless the current RequestLogAvailability.
  - decodedPath
```
default String decodedPath()
```
    Returns the absolute path part of the current Request URI, excluding the query part, decoded in UTF-8. This method is a shortcut to context().decodedPath(). This method returns non-null regardless the current RequestLogAvailability.
  - query
```
@Nullable
default String query()
```
    Returns the query part of the Request URI, without the leading '?', as defined in RFC3986. This method is a shortcut to context().query(). This property is available regardless the current RequestLogAvailability.
  - requestStartTimeMicros
```
long requestStartTimeMicros()
```
    Returns the time when the processing of the request started, in microseconds since the epoch.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestStartTimeMillis
```
long requestStartTimeMillis()
```
    Returns the time when the processing of the request started, in milliseconds since the epoch.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestStartTimeNanos
```
long requestStartTimeNanos()
```
    Returns the time when the processing of the request started, in nanoseconds. This value can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestFirstBytesTransferredTimeNanos
```
long requestFirstBytesTransferredTimeNanos()
```
    Returns the time when the first bytes of the request headers were transferred over the wire. For a client, this is the time the client sent the data, while for a server it is the time the server received them. This value can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time.
  - requestEndTimeNanos
```
long requestEndTimeNanos()
```
    Returns the time when the processing of the request finished, in nanoseconds. This value can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestDurationNanos
```
long requestDurationNanos()
```
    Returns the duration that was taken to consume or produce the request completely, in nanoseconds.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestLength
```
long requestLength()
```
    Returns the length of the request content.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestCause
```
@Nullable
Throwable requestCause()
```
    Returns the cause of request processing failure.
    
    Returns:
    
    the cause. null if the request was processed completely.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseStartTimeMicros
```
long responseStartTimeMicros()
```
    Returns the time when the processing of the response started, in microseconds since the epoch.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseStartTimeMillis
```
long responseStartTimeMillis()
```
    Returns the time when the processing of the response started, in milliseconds since the epoch.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseStartTimeNanos
```
long responseStartTimeNanos()
```
    Returns the time when the processing of the response started, in nanoseconds. This value can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseFirstBytesTransferredTimeNanos
```
long responseFirstBytesTransferredTimeNanos()
```
    Returns the time when the first bytes of the response headers were transferred over the wire. For a client, this is the time the client received the data, while for a server it is the time the server sent them. This value can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time.
  - responseEndTimeNanos
```
long responseEndTimeNanos()
```
    Returns the time when the processing of the response finished, in nanoseconds. This value can only be used to measure elapsed time and is not related to any other notion of system or wall-clock time.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseDurationNanos
```
long responseDurationNanos()
```
    Returns the duration that was taken to consume or produce the response completely, in nanoseconds.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseLength
```
long responseLength()
```
    Returns the length of the response content.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseCause
```
@Nullable
Throwable responseCause()
```
    Returns the cause of response processing failure.
    
    Returns:
    
    the cause. null if the response was processed completely.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - totalDurationNanos
```
long totalDurationNanos()
```
    Returns the amount of time taken since the Request processing started and until the Response processing ended. This property is available only when both RequestLogAvailability.REQUEST_START and RequestLogAvailability.RESPONSE_END are available.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - channel
```
@Nullable
io.netty.channel.Channel channel()
```
    Returns the Netty Channel which handled the Request.
    
    Returns:
    
    the Netty Channel. null if the Request has failed even before a connection is established.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - sslSession
```
@Nullable
SSLSession sslSession()
```
    Returns the SSLSession of the connection which handled the Request.
    
    Returns:
    
    the SSLSession, or null if the Request has failed even before a TLS connection is established.
  - sessionProtocol
```
SessionProtocol sessionProtocol()
```
    Returns the SessionProtocol of the Request.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - serializationFormat
```
SerializationFormat serializationFormat()
```
    Returns the SerializationFormat of the Request.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - scheme
```
Scheme scheme()
```
    Returns the Scheme of the Request.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - host
```
@Nullable
 @Deprecated
default String host()
```
    Deprecated. Do not use this method. Get the remote or local address from context() or get the authority from authority().
    
    Returns the host name of the Request.
    
    Returns:
    
    the host name. null if the Request has failed even before a connection is established.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - authority
```
default String authority()
```
    Returns the authority of the Request.
    
    Returns:
    
    the authority. "?" if the Request has failed even before its headers are properly constructed.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - status
```
default HttpStatus status()
```
    Returns the status of the Response.
    
    Returns:
    
    the HttpStatus. HttpStatus.UNKNOWN if the Response has failed even before receiving its first non-informational headers.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - statusCode
```
default int statusCode()
```
    Returns the status code of the Response.
    
    Returns:
    
    the integer value of the status(). 0 if the Response has failed even before receiving its first non-informational headers.
  - requestHeaders
```
RequestHeaders requestHeaders()
```
    Returns the RequestHeaders. If the Request was not received or sent at all, it will return a dummy RequestHeaders whose :authority and :path are set to "?", :scheme is set to "http" or "https", and :method is set to "UNKNOWN".
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestContent
```
@Nullable
Object requestContent()
```
    Returns the high-level content object of the Request, which is specific to the SerializationFormat.
    
    Returns:
    
    RpcRequest for RPC, or null for others
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestContentPreview
```
@Nullable
String requestContentPreview()
```
    Returns the preview of response content of the Request. Note that the content preview needs to be enabled when configuring a Server or a Client to use this functionality.
    
    Returns:
    
    the preview, or null if preview is not available or disabled.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet.
    
    See Also:
    
    ServerBuilder.contentPreview(int), ServerBuilder.requestContentPreviewerFactory(ContentPreviewerFactory), VirtualHostBuilder.contentPreview(int), VirtualHostBuilder.requestContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.requestContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.contentPreview(int)
  - rawRequestContent
```
@Nullable
Object rawRequestContent()
```
    Returns the low-level content object of the Request, which is specific to the SerializationFormat.
    
    Returns:
    
    ThriftCall for Thrift, or null for others
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - requestTrailers
```
HttpHeaders requestTrailers()
```
    Returns the HTTP trailers of the Request.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseHeaders
```
ResponseHeaders responseHeaders()
```
    Returns the non-informational status ResponseHeaders. If the Response was not received or sent at all, it will return a dummy ResponseHeaders whose :status is "0".
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseContent
```
@Nullable
Object responseContent()
```
    Returns the high-level content object of the Response, which is specific to the SerializationFormat.
    
    Returns:
    
    RpcResponse for RPC, or null for others
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - rawResponseContent
```
@Nullable
Object rawResponseContent()
```
    Returns the low-level content object of the Response, which is specific to the SerializationFormat.
    
    Returns:
    
    ThriftReply for Thrift, or null for others
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - responseContentPreview
```
@Nullable
String responseContentPreview()
```
    Returns the preview of response content of the Response. Note that the content preview needs to be enabled when configuring a Server or a Client to use this functionality.
    
    Returns:
    
    the preview, or null if preview is not available or disabled.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet.
    
    See Also:
    
    ServerBuilder.contentPreview(int), ServerBuilder.responseContentPreviewerFactory(ContentPreviewerFactory), VirtualHostBuilder.contentPreview(int), VirtualHostBuilder.responseContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.responseContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.contentPreview(int)
  - responseTrailers
```
HttpHeaders responseTrailers()
```
    Returns the HTTP trailers of the Response.
    
    Throws:
    
    RequestLogAvailabilityException - if this property is not available yet
  - toStringRequestOnly
```
String toStringRequestOnly()
```
    Returns the string representation of the Request, with no sanitization of headers or content.
  - toStringRequestOnly
```
String toStringRequestOnly(Function<? super HttpHeaders,?> headersSanitizer,
                           Function<Object,?> contentSanitizer)
```
    Returns the string representation of the Request. This method is a shortcut of:
```
 toStringRequestOnly(headersSanitizer, contentSanitizer, headersSanitizer);
 
```
    Parameters:
    
    headersSanitizer - a Function for sanitizing HTTP headers for logging. The result of the Function is what is actually logged as headers.
    
    contentSanitizer - a Function for sanitizing request content for logging. The result of the Function is what is actually logged as content.
  - toStringRequestOnly
```
String toStringRequestOnly(Function<? super RequestHeaders,?> headersSanitizer,
                           Function<Object,?> contentSanitizer,
                           Function<? super HttpHeaders,?> trailersSanitizer)
```
    Returns the string representation of the Request.
    
    Parameters:
    
    headersSanitizer - a Function for sanitizing HTTP headers for logging. The result of the Function is what is actually logged as headers.
    
    contentSanitizer - a Function for sanitizing request content for logging. The result of the Function is what is actually logged as content.
    
    trailersSanitizer - a Function for sanitizing HTTP trailers for logging. The result of the Function is what is actually logged as trailers.
  - toStringResponseOnly
```
String toStringResponseOnly()
```
    Returns the string representation of the Response, with no sanitization of headers or content.
  - toStringResponseOnly
```
String toStringResponseOnly(Function<? super HttpHeaders,?> headersSanitizer,
                            Function<Object,?> contentSanitizer)
```
    Returns the string representation of the Response. This method is a shortcut of:
```
 toStringResponseOnly(headersSanitizer, contentSanitizer, headersSanitizer);
 
```
    Parameters:
    
    headersSanitizer - a Function for sanitizing HTTP headers for logging. The result of the Function is what is actually logged as headers.
    
    contentSanitizer - a Function for sanitizing response content for logging. The result of the Function is what is actually logged as content.
  - toStringResponseOnly
```
String toStringResponseOnly(Function<? super ResponseHeaders,?> headersSanitizer,
                            Function<Object,?> contentSanitizer,
                            Function<? super HttpHeaders,?> trailersSanitizer)
```
    Returns the string representation of the Response.
    
    Parameters:
    
    headersSanitizer - a Function for sanitizing HTTP headers for logging. The result of the Function is what is actually logged as headers.
    
    contentSanitizer - a Function for sanitizing response content for logging. The result of the Function is what is actually logged as content.
    
    trailersSanitizer - a Function for sanitizing HTTP trailers for logging. The result of the Function is what is actually logged as trailers.

Interface RequestLog

Method Summary

Methods inherited from interface io.netty.util.AttributeMap

Method Detail

attrs

children

availabilities

isAvailable

isAvailable

isAvailable

ensureAvailability

ensureAvailability

ensureAvailability

addListener

addListener

addListener

context

id

method

path

decodedPath

query

requestStartTimeMicros

requestStartTimeMillis

requestStartTimeNanos

requestFirstBytesTransferredTimeNanos

requestEndTimeNanos

requestDurationNanos

requestLength

requestCause

responseStartTimeMicros

responseStartTimeMillis

responseStartTimeNanos

responseFirstBytesTransferredTimeNanos

responseEndTimeNanos

responseDurationNanos

responseLength

responseCause

totalDurationNanos

channel

sslSession

sessionProtocol

serializationFormat

scheme

host

authority

status

statusCode

requestHeaders

requestContent

requestContentPreview

rawRequestContent

requestTrailers

responseHeaders

responseContent

rawResponseContent

responseContentPreview

responseTrailers

toStringRequestOnly

toStringRequestOnly

toStringRequestOnly

toStringResponseOnly

toStringResponseOnly

toStringResponseOnly