Package com.linecorp.armeria.common.logging

Interface RequestLog

All Superinterfaces:

RequestLogAccess, RequestOnlyLog

public interface RequestLog
extends RequestOnlyLog

A set of informational properties collected while processing a Request and Response.

See Also:

• RequestLogAccess.isComplete()
• RequestLogAccess.whenComplete()
• RequestLogAccess.ensureComplete()

Method Summary

Modifier and Type	Method	Description
static RequestLogBuilder	builder(RequestContext ctx)	Returns a newly created RequestLogBuilder.
@Nullable Object	rawResponseContent()	Returns the low-level content object of the Response, which is specific to the SerializationFormat.
@Nullable Throwable	responseCause()	Returns the cause of response processing failure.
@Nullable Object	responseContent()	Returns the high-level content object of the Response, which is specific to the SerializationFormat.
@Nullable String	responseContentPreview()	Returns the preview of response content of the Response.
default 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.
@Nullable 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.
default HttpStatus	responseStatus()	Returns the HTTP response status of the responseHeaders().
HttpHeaders	responseTrailers()	Returns the HTTP trailers of the Response.
default String	toStringResponseOnly()	Deprecated. Use LogFormatter.formatResponse(RequestLog) instead.
default String	toStringResponseOnly(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> headersSanitizer, BiFunction<? super RequestContext,Object,? extends @Nullable Object> contentSanitizer)	Deprecated. Use LogFormatter.formatResponse(RequestLog) instead.
default String	toStringResponseOnly(BiFunction<? super RequestContext,? super ResponseHeaders,? extends @Nullable Object> headersSanitizer, BiFunction<? super RequestContext,Object,? extends @Nullable Object> contentSanitizer, BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> trailersSanitizer)	Deprecated. Use LogFormatter.formatResponse(RequestLog) instead.
default long	totalDurationNanos()	Returns the amount of time taken since the Request processing started and until the Response processing ended.

Methods inherited from interface com.linecorp.armeria.common.logging.RequestLogAccess

availabilityStamp, children, context, ensureAvailable, ensureAvailable, ensureAvailable, ensureComplete, ensureRequestComplete, getIfAvailable, getIfAvailable, isAvailable, isAvailable, isAvailable, isComplete, isRequestComplete, parent, partial, whenAvailable, whenAvailable, whenAvailable, whenComplete, whenRequestComplete

Methods inherited from interface com.linecorp.armeria.common.logging.RequestOnlyLog

authenticatedUser, channel, connectionTimings, fullName, name, rawRequestContent, requestCause, requestContent, requestContentPreview, requestDurationNanos, requestEndTimeNanos, requestFirstBytesTransferredTimeNanos, requestHeaders, requestLength, requestStartTimeMicros, requestStartTimeMillis, requestStartTimeNanos, requestTrailers, scheme, serializationFormat, serviceName, sessionProtocol, sslSession, toStringRequestOnly, toStringRequestOnly, toStringRequestOnly

Method Details

builder

static RequestLogBuilder builder(RequestContext ctx)

Returns a newly created RequestLogBuilder.

responseStartTimeMicros

long responseStartTimeMicros()

Returns the time when the processing of the response started, in microseconds since the epoch.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_START_TIME

responseStartTimeMillis

long responseStartTimeMillis()

Returns the time when the processing of the response started, in milliseconds since the epoch.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_START_TIME

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 the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_START_TIME

responseFirstBytesTransferredTimeNanos

@Nullable
@Nullable 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.

Returns:

the transfer time, or null if nothing was transferred.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_FIRST_BYTES_TRANSFERRED_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 the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_END_TIME

responseDurationNanos

default long responseDurationNanos()

Returns the duration that was taken to consume or produce the response completely, in nanoseconds.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_END_TIME

totalDurationNanos

default 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 RequestLogProperty.REQUEST_START_TIME and RequestLogProperty.RESPONSE_START_TIME are available.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_END_TIME

responseStatus

default HttpStatus responseStatus()

Returns the HTTP response status of the responseHeaders().

responseLength

long responseLength()

Returns the length of the response content.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_LENGTH

responseCause

@Nullable
@Nullable Throwable responseCause()

Returns the cause of response processing failure.

Returns:

the cause. null if the response was processed completely.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_CAUSE

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 the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_HEADERS

responseContent

@Nullable
@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 the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_CONTENT

rawResponseContent

@Nullable
@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 the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_CONTENT

responseContentPreview

@Nullable
@Nullable String responseContentPreview()

Returns the preview of response content of the Response. Note that a Service or a Client must be decorated with ContentPreviewingService or ContentPreviewingClient decorators respectively to enable the content preview.

Returns:

the preview, or null if preview is disabled.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_CONTENT_PREVIEW

responseTrailers

HttpHeaders responseTrailers()

Returns the HTTP trailers of the Response.

Throws:

RequestLogAvailabilityException - if the property is not available yet.

See Also:

• RequestLogProperty.RESPONSE_TRAILERS

toStringResponseOnly

@Deprecated
default String toStringResponseOnly()

Deprecated.

Use LogFormatter.formatResponse(RequestLog) instead.

Returns the string representation of the Response, with no sanitization of headers or content. This method is a shortcut for:

 toStringResponseOnly((ctx, headers) -> headers,
                      (ctx, content) -> content,
                      (ctx, trailers) -> trailers);
 

toStringResponseOnly

@Deprecated
default String toStringResponseOnly(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> headersSanitizer,
 BiFunction<? super RequestContext,Object,? extends @Nullable Object> contentSanitizer)

Deprecated.

Use LogFormatter.formatResponse(RequestLog) instead.

Returns the string representation of the Response. This method is a shortcut for:

 toStringResponseOnly(headersSanitizer, contentSanitizer, headersSanitizer);
 

Parameters:

headersSanitizer - a BiFunction for sanitizing HTTP headers for logging. The result of the BiFunction is what is actually logged as headers.

contentSanitizer - a BiFunction for sanitizing response content for logging. The result of the BiFunction is what is actually logged as content.

toStringResponseOnly

@Deprecated
default String toStringResponseOnly(BiFunction<? super RequestContext,? super ResponseHeaders,? extends @Nullable Object> headersSanitizer,
 BiFunction<? super RequestContext,Object,? extends @Nullable Object> contentSanitizer,
 BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> trailersSanitizer)

Deprecated.

Use LogFormatter.formatResponse(RequestLog) instead.

Returns the string representation of the Response.

Parameters:

headersSanitizer - a BiFunction for sanitizing HTTP headers for logging. The result of the BiFunction is what is actually logged as headers.

contentSanitizer - a BiFunction for sanitizing response content for logging. The result of the BiFunction is what is actually logged as content.

trailersSanitizer - a BiFunction for sanitizing HTTP trailers for logging. The result of the BiFunction is what is actually logged as trailers.