com.linecorp.armeria.common.logging

Class DefaultRequestLog

java.lang.Object

com.linecorp.armeria.common.logging.DefaultRequestLog

All Implemented Interfaces:

RequestLog, RequestLogBuilder, io.netty.util.AttributeMap

public class DefaultRequestLog
extends Object
implements RequestLog, RequestLogBuilder

Default RequestLog implementation.

Field Summary

Fields inherited from interface com.linecorp.armeria.common.logging.RequestLogBuilder

NOOP

Constructor Summary

Constructors

Constructor and Description
DefaultRequestLog(RequestContext ctx) Creates a new instance.
DefaultRequestLog(RequestContext ctx, ContentPreviewerFactory requestContentPreviewerFactory, ContentPreviewerFactory responseContentPreviewerFactory) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addChild(RequestLog child) Adds the specified RequestLog so that the logs are propagated from the child.
void	addListener(RequestLogListener listener, Iterable<RequestLogAvailability> availabilities) Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.
void	addListener(RequestLogListener listener, RequestLogAvailability... availabilities) Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.
void	addListener(RequestLogListener listener, RequestLogAvailability availability) Adds the specified RequestLogListener so that it's notified when the specified RequestLogAvailability is satisfied.
<T> io.netty.util.Attribute<T>	attr(io.netty.util.AttributeKey<T> key)
Iterator<io.netty.util.Attribute<?>>	attrs() Returns all Attributes set in this log.
Set<RequestLogAvailability>	availabilities() Returns the set of satisfied RequestLogAvailabilitys.
io.netty.channel.Channel	channel() Returns the Netty Channel which handled the Request.
List<RequestLog>	children() Returns the list of child RequestLogs, ordered by the time it was added.
RequestContext	context() Returns the RequestContext associated with the Request being handled.
void	deferRequestContent() Allows the RequestLogBuilder.requestContent(Object, Object) called after RequestLogBuilder.endRequest().
void	deferResponseContent() Allows the RequestLogBuilder.responseContent(Object, Object) called after RequestLogBuilder.endResponse().
void	endRequest() Finishes the collection of the Request information.
void	endRequest(long requestEndTimeNanos) Finishes the collection of the Request information.
void	endRequest(Throwable requestCause) Finishes the collection of the Request information.
void	endRequest(Throwable requestCause, long requestEndTimeNanos) Finishes the collection of the Request information.
void	endResponse() Finishes the collection of the Response information.
void	endResponse(long responseEndTimeNanos) Finishes the collection of the Response information.
void	endResponse(Throwable responseCause) Finishes the collection of the Response information.
void	endResponse(Throwable responseCause, long responseEndTimeNanos) Finishes the collection of the Response information.
void	endResponseWithLastChild() Fills the response-side logs from the last added child.
<T> boolean	hasAttr(io.netty.util.AttributeKey<T> key)
void	increaseRequestLength(HttpData data) Increases the RequestLog.requestLength() by data.length() and passes data to the previewer.
void	increaseRequestLength(long deltaBytes) Increases the RequestLog.requestLength() by deltaBytes.
void	increaseResponseLength(HttpData data) Increases the RequestLog.responseLength() by data.length() and passes data to the previewer.
void	increaseResponseLength(long deltaBytes) Increases the RequestLog.responseLength() by deltaBytes.
boolean	isAvailable(Iterable<RequestLogAvailability> availabilities) Returns true if all of the specified RequestLogAvailabilitys are satisfied.
boolean	isAvailable(RequestLogAvailability... availabilities) Returns true if all of the specified RequestLogAvailabilitys are satisfied.
boolean	isAvailable(RequestLogAvailability availability) Returns true if the specified RequestLogAvailability is satisfied.
boolean	isRequestContentDeferred() Returns true if RequestLogBuilder.deferRequestContent() was ever called.
boolean	isResponseContentDeferred() Returns true if RequestLogBuilder.deferResponseContent() was ever called.
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.
void	requestContent(Object requestContent, Object rawRequestContent) Sets the RequestLog.requestContent() and the RequestLog.rawRequestContent().
String	requestContentPreview() Returns the preview of response content of the Request.
void	requestContentPreview(String requestContentPreview) Sets the RequestLog.requestContentPreview().
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.
void	requestFirstBytesTransferred() Sets RequestLog.requestFirstBytesTransferredTimeNanos().
void	requestFirstBytesTransferred(long requestFirstBytesTransferredTimeNanos) Sets RequestLog.requestFirstBytesTransferredTimeNanos() with the specified timestamp.
long	requestFirstBytesTransferredTimeNanos() Returns the time when the first bytes of the request headers were transferred over the wire.
RequestHeaders	requestHeaders() Returns the RequestHeaders.
void	requestHeaders(RequestHeaders requestHeaders) Sets the RequestLog.requestHeaders().
long	requestLength() Returns the length of the request content.
void	requestLength(long requestLength) Sets the RequestLog.requestLength().
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.
void	requestTrailers(HttpHeaders requestTrailers) Sets the RequestLog.requestTrailers().
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.
void	responseContent(Object responseContent, Object rawResponseContent) Sets the RequestLog.responseContent() and the RequestLog.rawResponseContent().
String	responseContentPreview() Returns the preview of response content of the Response.
void	responseContentPreview(String responseContentPreview) Sets the RequestLog.responseContentPreview().
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.
void	responseFirstBytesTransferred() Sets RequestLog.responseFirstBytesTransferredTimeNanos().
void	responseFirstBytesTransferred(long responseFirstBytesTransferredTimeNanos) Sets RequestLog.responseFirstBytesTransferredTimeNanos() with the specified timestamp.
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.
void	responseHeaders(ResponseHeaders responseHeaders) Sets the RequestLog.responseHeaders().
long	responseLength() Returns the length of the response content.
void	responseLength(long responseLength) Sets the RequestLog.responseLength().
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.
void	responseTrailers(HttpHeaders responseTrailers) Sets the RequestLog.responseTrailers().
Scheme	scheme() Returns the Scheme of the Request.
SerializationFormat	serializationFormat() Returns the SerializationFormat of the Request.
void	serializationFormat(SerializationFormat serializationFormat) Sets the SerializationFormat.
SessionProtocol	sessionProtocol() Returns the SessionProtocol of the Request.
SSLSession	sslSession() Returns the SSLSession of the connection which handled the Request.
void	startRequest(io.netty.channel.Channel channel, SessionProtocol sessionProtocol, SSLSession sslSession) Starts the collection of the Request information.
void	startRequest(io.netty.channel.Channel channel, SessionProtocol sessionProtocol, SSLSession sslSession, long requestStartTimeNanos, long requestStartTimeMicros) Starts the collection of the Request information.
void	startResponse() Starts the collection of Response information.
void	startResponse(long responseStartTimeNanos, long responseStartTimeMicros) Starts the collection of Response information.
String	toString()
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

authority, decodedPath, ensureAvailability, ensureAvailability, ensureAvailability, host, id, method, path, query, status, statusCode

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

startRequest, startRequest

Constructor Detail

DefaultRequestLog

public DefaultRequestLog(RequestContext ctx)

Creates a new instance.

DefaultRequestLog

public DefaultRequestLog(RequestContext ctx,
                         ContentPreviewerFactory requestContentPreviewerFactory,
                         ContentPreviewerFactory responseContentPreviewerFactory)

Creates a new instance.

Method Detail

attr

public <T> io.netty.util.Attribute<T> attr(io.netty.util.AttributeKey<T> key)

Specified by:

attr in interface io.netty.util.AttributeMap

hasAttr

public <T> boolean hasAttr(io.netty.util.AttributeKey<T> key)

Specified by:

hasAttr in interface io.netty.util.AttributeMap

attrs

public Iterator<io.netty.util.Attribute<?>> attrs()

Description copied from interface: RequestLog

Returns all Attributes set in this log.

Specified by:

attrs in interface RequestLog

addChild

public void addChild(RequestLog child)

Description copied from interface: RequestLogBuilder

Adds the specified RequestLog so that the logs are propagated from the child. Note that only the request-side logs of the first added child will be propagated. To fill the response-side logs you need to call RequestLogBuilder.endResponseWithLastChild().

Specified by:

addChild in interface RequestLogBuilder

endResponseWithLastChild

public void endResponseWithLastChild()

Description copied from interface: RequestLogBuilder

Fills the response-side logs from the last added child. Note that already fulfilled RequestLogAvailabilitys in the child log will be propagated immediately.

Specified by:

endResponseWithLastChild in interface RequestLogBuilder

children

public List<RequestLog> children()

Description copied from interface: RequestLog

Returns the list of child RequestLogs, ordered by the time it was added.

Specified by:

children in interface RequestLog

availabilities

public Set<RequestLogAvailability> availabilities()

Description copied from interface: RequestLog

Returns the set of satisfied RequestLogAvailabilitys.

Specified by:

availabilities in interface RequestLog

isAvailable

public boolean isAvailable(RequestLogAvailability availability)

Description copied from interface: RequestLog

Returns true if the specified RequestLogAvailability is satisfied.

Specified by:

isAvailable in interface RequestLog

isAvailable

public boolean isAvailable(RequestLogAvailability... availabilities)

Description copied from interface: RequestLog

Returns true if all of the specified RequestLogAvailabilitys are satisfied.

Specified by:

isAvailable in interface RequestLog

isAvailable

public boolean isAvailable(Iterable<RequestLogAvailability> availabilities)

Description copied from interface: RequestLog

Returns true if all of the specified RequestLogAvailabilitys are satisfied.

Specified by:

isAvailable in interface RequestLog

addListener

public void addListener(RequestLogListener listener,
                        RequestLogAvailability availability)

Description copied from interface: RequestLog

Adds the specified RequestLogListener so that it's notified when the specified RequestLogAvailability is satisfied.

Specified by:

addListener in interface RequestLog

addListener

public void addListener(RequestLogListener listener,
                        RequestLogAvailability... availabilities)

Description copied from interface: RequestLog

Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.

Specified by:

addListener in interface RequestLog

addListener

public void addListener(RequestLogListener listener,
                        Iterable<RequestLogAvailability> availabilities)

Description copied from interface: RequestLog

Adds the specified RequestLogListener so that it's notified when all of the specified RequestLogAvailabilitys are satisfied.

Specified by:

addListener in interface RequestLog

context

public RequestContext context()

Description copied from interface: RequestLog

Returns the RequestContext associated with the Request being handled. This method returns non-null regardless the current RequestLogAvailability.

Specified by:

context in interface RequestLog

startRequest

public void startRequest(io.netty.channel.Channel channel,
                         SessionProtocol sessionProtocol,
                         @Nullable
                         SSLSession sslSession)

Description copied from interface: RequestLogBuilder

Starts the collection of the Request information. This method sets the following properties:

• RequestLog.requestStartTimeMillis()
• RequestLog.requestStartTimeMicros()
• RequestLog.requestStartTimeNanos()
• RequestLog.channel()
• RequestLog.sessionProtocol()
• RequestLog.authority()
• RequestLog.sslSession()

Specified by:

startRequest in interface RequestLogBuilder

Parameters:

channel - the Channel which handled the Request.

sessionProtocol - the SessionProtocol of the connection.

sslSession - the SSLSession of the connection, or null.

startRequest

public void startRequest(io.netty.channel.Channel channel,
                         SessionProtocol sessionProtocol,
                         @Nullable
                         SSLSession sslSession,
                         long requestStartTimeNanos,
                         long requestStartTimeMicros)

Description copied from interface: RequestLogBuilder

Starts the collection of the Request information. This method sets the following properties:

• RequestLog.requestStartTimeMillis()
• RequestLog.requestStartTimeMicros()
• RequestLog.requestStartTimeNanos()
• RequestLog.channel()
• RequestLog.sessionProtocol()
• RequestLog.authority()
• RequestLog.sslSession()

Specified by:

startRequest in interface RequestLogBuilder

Parameters:

channel - the Channel which handled the Request.

sessionProtocol - the SessionProtocol of the connection.

sslSession - the SSLSession of the connection, or null.

requestStartTimeNanos - System.nanoTime() value when the request started.

requestStartTimeMicros - the number of microseconds since the epoch, e.g. System.currentTimeMillis() * 1000.

requestStartTimeMicros

public long requestStartTimeMicros()

Description copied from interface: RequestLog

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

Specified by:

requestStartTimeMicros in interface RequestLog

requestStartTimeMillis

public long requestStartTimeMillis()

Description copied from interface: RequestLog

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

Specified by:

requestStartTimeMillis in interface RequestLog

requestStartTimeNanos

public long requestStartTimeNanos()

Description copied from interface: RequestLog

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.

Specified by:

requestStartTimeNanos in interface RequestLog

requestFirstBytesTransferredTimeNanos

public long requestFirstBytesTransferredTimeNanos()

Description copied from interface: RequestLog

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.

Specified by:

requestFirstBytesTransferredTimeNanos in interface RequestLog

requestEndTimeNanos

public long requestEndTimeNanos()

Description copied from interface: RequestLog

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.

Specified by:

requestEndTimeNanos in interface RequestLog

requestDurationNanos

public long requestDurationNanos()

Description copied from interface: RequestLog

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

Specified by:

requestDurationNanos in interface RequestLog

requestCause

public Throwable requestCause()

Description copied from interface: RequestLog

Returns the cause of request processing failure.

Specified by:

requestCause in interface RequestLog

Returns:

the cause. null if the request was processed completely.

channel

public io.netty.channel.Channel channel()

Description copied from interface: RequestLog

Returns the Netty Channel which handled the Request.

Specified by:

channel in interface RequestLog

Returns:

the Netty Channel. null if the Request has failed even before a connection is established.

sslSession

public SSLSession sslSession()

Description copied from interface: RequestLog

Returns the SSLSession of the connection which handled the Request.

Specified by:

sslSession in interface RequestLog

Returns:

the SSLSession, or null if the Request has failed even before a TLS connection is established.

sessionProtocol

public SessionProtocol sessionProtocol()

Description copied from interface: RequestLog

Returns the SessionProtocol of the Request.

Specified by:

sessionProtocol in interface RequestLog

serializationFormat

public SerializationFormat serializationFormat()

Description copied from interface: RequestLog

Returns the SerializationFormat of the Request.

Specified by:

serializationFormat in interface RequestLog

serializationFormat

public void serializationFormat(SerializationFormat serializationFormat)

Description copied from interface: RequestLogBuilder

Sets the SerializationFormat.

Specified by:

serializationFormat in interface RequestLogBuilder

scheme

public Scheme scheme()

Description copied from interface: RequestLog

Returns the Scheme of the Request.

Specified by:

scheme in interface RequestLog

requestLength

public long requestLength()

Description copied from interface: RequestLog

Returns the length of the request content.

Specified by:

requestLength in interface RequestLog

requestLength

public void requestLength(long requestLength)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.requestLength().

Specified by:

requestLength in interface RequestLogBuilder

requestFirstBytesTransferred

public void requestFirstBytesTransferred()

Description copied from interface: RequestLogBuilder

Sets RequestLog.requestFirstBytesTransferredTimeNanos().

Specified by:

requestFirstBytesTransferred in interface RequestLogBuilder

requestFirstBytesTransferred

public void requestFirstBytesTransferred(long requestFirstBytesTransferredTimeNanos)

Description copied from interface: RequestLogBuilder

Sets RequestLog.requestFirstBytesTransferredTimeNanos() with the specified timestamp.

Specified by:

requestFirstBytesTransferred in interface RequestLogBuilder

increaseRequestLength

public void increaseRequestLength(long deltaBytes)

Description copied from interface: RequestLogBuilder

Increases the RequestLog.requestLength() by deltaBytes.

Specified by:

increaseRequestLength in interface RequestLogBuilder

increaseRequestLength

public void increaseRequestLength(HttpData data)

Description copied from interface: RequestLogBuilder

Increases the RequestLog.requestLength() by data.length() and passes data to the previewer.

Specified by:

increaseRequestLength in interface RequestLogBuilder

requestHeaders

public RequestHeaders requestHeaders()

Description copied from interface: RequestLog

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

Specified by:

requestHeaders in interface RequestLog

requestHeaders

public void requestHeaders(RequestHeaders requestHeaders)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.requestHeaders().

Specified by:

requestHeaders in interface RequestLogBuilder

requestContent

public Object requestContent()

Description copied from interface: RequestLog

Returns the high-level content object of the Request, which is specific to the SerializationFormat.

Specified by:

requestContent in interface RequestLog

Returns:

RpcRequest for RPC, or null for others

requestContent

public void requestContent(@Nullable
                           Object requestContent,
                           @Nullable
                           Object rawRequestContent)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.requestContent() and the RequestLog.rawRequestContent(). If the specified requestContent is an RpcRequest and the RequestContext.rpcRequest() is null, this method will call RequestContext.updateRpcRequest(RpcRequest).

Specified by:

requestContent in interface RequestLogBuilder

requestContentPreview

public String requestContentPreview()

Description copied from interface: RequestLog

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.

Specified by:

requestContentPreview in interface RequestLog

Returns:

the preview, or null if preview is not available or disabled.

See Also:

ServerBuilder.contentPreview(int), ServerBuilder.requestContentPreviewerFactory(ContentPreviewerFactory), VirtualHostBuilder.contentPreview(int), VirtualHostBuilder.requestContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.requestContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.contentPreview(int)

requestContentPreview

public void requestContentPreview(@Nullable
                                  String requestContentPreview)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.requestContentPreview().

Specified by:

requestContentPreview in interface RequestLogBuilder

rawRequestContent

public Object rawRequestContent()

Description copied from interface: RequestLog

Returns the low-level content object of the Request, which is specific to the SerializationFormat.

Specified by:

rawRequestContent in interface RequestLog

Returns:

ThriftCall for Thrift, or null for others

deferRequestContent

public void deferRequestContent()

Description copied from interface: RequestLogBuilder

Allows the RequestLogBuilder.requestContent(Object, Object) called after RequestLogBuilder.endRequest(). By default, if RequestLogBuilder.requestContent(Object, Object) was not called yet, RequestLogBuilder.endRequest() will call requestContent(null, null) automatically. This method turns off this default behavior. Note, however, this method will not prevent RequestLogBuilder.endRequest(Throwable) from calling requestContent(null, null) automatically.

Specified by:

deferRequestContent in interface RequestLogBuilder

isRequestContentDeferred

public boolean isRequestContentDeferred()

Description copied from interface: RequestLogBuilder

Returns true if RequestLogBuilder.deferRequestContent() was ever called.

Specified by:

isRequestContentDeferred in interface RequestLogBuilder

requestTrailers

public HttpHeaders requestTrailers()

Description copied from interface: RequestLog

Returns the HTTP trailers of the Request.

Specified by:

requestTrailers in interface RequestLog

requestTrailers

public void requestTrailers(HttpHeaders requestTrailers)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.requestTrailers().

Specified by:

requestTrailers in interface RequestLogBuilder

endRequest

public void endRequest()

Description copied from interface: RequestLogBuilder

Finishes the collection of the Request information. This method sets the following properties:

• RequestLog.requestEndTimeNanos()
• RequestLog.requestDurationNanos()
• RequestLog.requestCause()

Specified by:

endRequest in interface RequestLogBuilder

endRequest

public void endRequest(Throwable requestCause)

Description copied from interface: RequestLogBuilder

Finishes the collection of the Request information. This method sets the following properties:

• RequestLog.requestEndTimeNanos()
• RequestLog.requestDurationNanos()
• RequestLog.requestCause()

Specified by:

endRequest in interface RequestLogBuilder

Parameters:

requestCause - the cause of the failure.

endRequest

public void endRequest(long requestEndTimeNanos)

Description copied from interface: RequestLogBuilder

Finishes the collection of the Request information. This method sets the following properties:

• RequestLog.requestEndTimeNanos()
• RequestLog.requestDurationNanos()
• RequestLog.requestCause()

Specified by:

endRequest in interface RequestLogBuilder

Parameters:

requestEndTimeNanos - System.nanoTime() value when the request ended.

endRequest

public void endRequest(Throwable requestCause,
                       long requestEndTimeNanos)

Description copied from interface: RequestLogBuilder

Finishes the collection of the Request information. This method sets the following properties:

• RequestLog.requestEndTimeNanos()
• RequestLog.requestDurationNanos()
• RequestLog.requestCause()

Specified by:

endRequest in interface RequestLogBuilder

Parameters:

requestCause - the cause of the failure.

requestEndTimeNanos - System.nanoTime() value when the request ended.

startResponse

public void startResponse()

Description copied from interface: RequestLogBuilder

Starts the collection of Response information. This method sets the following properties:

• RequestLog.responseStartTimeMillis()
• RequestLog.responseStartTimeMicros()
• RequestLog.responseStartTimeNanos()

Specified by:

startResponse in interface RequestLogBuilder

startResponse

public void startResponse(long responseStartTimeNanos,
                          long responseStartTimeMicros)

Description copied from interface: RequestLogBuilder

Starts the collection of Response information. This method sets the following properties:

• RequestLog.responseStartTimeMillis()
• RequestLog.responseStartTimeMicros()
• RequestLog.responseStartTimeNanos()

Specified by:

startResponse in interface RequestLogBuilder

Parameters:

responseStartTimeNanos - System.nanoTime() value when the response started.

responseStartTimeMicros - the number of microseconds since the epoch, e.g. System.currentTimeMillis() * 1000.

responseStartTimeMicros

public long responseStartTimeMicros()

Description copied from interface: RequestLog

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

Specified by:

responseStartTimeMicros in interface RequestLog

responseStartTimeMillis

public long responseStartTimeMillis()

Description copied from interface: RequestLog

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

Specified by:

responseStartTimeMillis in interface RequestLog

responseStartTimeNanos

public long responseStartTimeNanos()

Description copied from interface: RequestLog

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.

Specified by:

responseStartTimeNanos in interface RequestLog

responseFirstBytesTransferredTimeNanos

public long responseFirstBytesTransferredTimeNanos()

Description copied from interface: RequestLog

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.

Specified by:

responseFirstBytesTransferredTimeNanos in interface RequestLog

responseEndTimeNanos

public long responseEndTimeNanos()

Description copied from interface: RequestLog

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.

Specified by:

responseEndTimeNanos in interface RequestLog

responseDurationNanos

public long responseDurationNanos()

Description copied from interface: RequestLog

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

Specified by:

responseDurationNanos in interface RequestLog

responseCause

public Throwable responseCause()

Description copied from interface: RequestLog

Returns the cause of response processing failure.

Specified by:

responseCause in interface RequestLog

Returns:

the cause. null if the response was processed completely.

responseLength

public long responseLength()

Description copied from interface: RequestLog

Returns the length of the response content.

Specified by:

responseLength in interface RequestLog

responseLength

public void responseLength(long responseLength)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.responseLength().

Specified by:

responseLength in interface RequestLogBuilder

responseFirstBytesTransferred

public void responseFirstBytesTransferred()

Description copied from interface: RequestLogBuilder

Sets RequestLog.responseFirstBytesTransferredTimeNanos().

Specified by:

responseFirstBytesTransferred in interface RequestLogBuilder

responseFirstBytesTransferred

public void responseFirstBytesTransferred(long responseFirstBytesTransferredTimeNanos)

Description copied from interface: RequestLogBuilder

Sets RequestLog.responseFirstBytesTransferredTimeNanos() with the specified timestamp.

Specified by:

responseFirstBytesTransferred in interface RequestLogBuilder

increaseResponseLength

public void increaseResponseLength(long deltaBytes)

Description copied from interface: RequestLogBuilder

Increases the RequestLog.responseLength() by deltaBytes.

Specified by:

increaseResponseLength in interface RequestLogBuilder

increaseResponseLength

public void increaseResponseLength(HttpData data)

Description copied from interface: RequestLogBuilder

Increases the RequestLog.responseLength() by data.length() and passes data to the previewer.

Specified by:

increaseResponseLength in interface RequestLogBuilder

responseHeaders

public ResponseHeaders responseHeaders()

Description copied from interface: RequestLog

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

Specified by:

responseHeaders in interface RequestLog

responseHeaders

public void responseHeaders(ResponseHeaders responseHeaders)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.responseHeaders().

Specified by:

responseHeaders in interface RequestLogBuilder

responseContent

public Object responseContent()

Description copied from interface: RequestLog

Returns the high-level content object of the Response, which is specific to the SerializationFormat.

Specified by:

responseContent in interface RequestLog

Returns:

RpcResponse for RPC, or null for others

responseContent

public void responseContent(@Nullable
                            Object responseContent,
                            @Nullable
                            Object rawResponseContent)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.responseContent() and the RequestLog.rawResponseContent().

Specified by:

responseContent in interface RequestLogBuilder

responseContentPreview

public String responseContentPreview()

Description copied from interface: RequestLog

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.

Specified by:

responseContentPreview in interface RequestLog

Returns:

the preview, or null if preview is not available or disabled.

See Also:

ServerBuilder.contentPreview(int), ServerBuilder.responseContentPreviewerFactory(ContentPreviewerFactory), VirtualHostBuilder.contentPreview(int), VirtualHostBuilder.responseContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.responseContentPreviewerFactory(ContentPreviewerFactory), AbstractClientOptionsBuilder.contentPreview(int)

responseContentPreview

public void responseContentPreview(@Nullable
                                   String responseContentPreview)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.responseContentPreview().

Specified by:

responseContentPreview in interface RequestLogBuilder

rawResponseContent

public Object rawResponseContent()

Description copied from interface: RequestLog

Returns the low-level content object of the Response, which is specific to the SerializationFormat.

Specified by:

rawResponseContent in interface RequestLog

Returns:

ThriftReply for Thrift, or null for others

deferResponseContent

public void deferResponseContent()

Description copied from interface: RequestLogBuilder

Allows the RequestLogBuilder.responseContent(Object, Object) called after RequestLogBuilder.endResponse(). By default, if RequestLogBuilder.responseContent(Object, Object) was not called yet, RequestLogBuilder.endResponse() will call responseContent(null, null) automatically. This method turns off this default behavior. Note, however, this method will not prevent RequestLogBuilder.endResponse(Throwable) from calling responseContent(null, null) automatically.

Specified by:

deferResponseContent in interface RequestLogBuilder

isResponseContentDeferred

public boolean isResponseContentDeferred()

Description copied from interface: RequestLogBuilder

Returns true if RequestLogBuilder.deferResponseContent() was ever called.

Specified by:

isResponseContentDeferred in interface RequestLogBuilder

responseTrailers

public HttpHeaders responseTrailers()

Description copied from interface: RequestLog

Returns the HTTP trailers of the Response.

Specified by:

responseTrailers in interface RequestLog

responseTrailers

public void responseTrailers(HttpHeaders responseTrailers)

Description copied from interface: RequestLogBuilder

Sets the RequestLog.responseTrailers().

Specified by:

responseTrailers in interface RequestLogBuilder

endResponse

public void endResponse()

Description copied from interface: RequestLogBuilder

Finishes the collection of the Response information. If a Throwable cause has been set with RequestLogBuilder.responseContent(Object, Object), it will be treated as the responseCause for this log. This method sets the following properties:

• RequestLog.responseEndTimeNanos()
• RequestLog.responseDurationNanos()
• RequestLog.responseCause()

Specified by:

endResponse in interface RequestLogBuilder

endResponse

public void endResponse(Throwable responseCause)

Description copied from interface: RequestLogBuilder

Finishes the collection of the Response information. This method sets the following properties:

• RequestLog.responseEndTimeNanos()
• RequestLog.responseDurationNanos()
• RequestLog.responseCause()

Specified by:

endResponse in interface RequestLogBuilder

Parameters:

responseCause - the cause of the failure.

endResponse

public void endResponse(long responseEndTimeNanos)

Description copied from interface: RequestLogBuilder

Finishes the collection of the Response information. If a Throwable cause has been set with RequestLogBuilder.responseContent(Object, Object), it will be treated as the responseCause for this log. This method sets the following properties:

• RequestLog.responseEndTimeNanos()
• RequestLog.responseDurationNanos()
• RequestLog.responseCause()

Specified by:

endResponse in interface RequestLogBuilder

Parameters:

responseEndTimeNanos - System.nanoTime() value when the response ended.

endResponse

public void endResponse(Throwable responseCause,
                        long responseEndTimeNanos)

Description copied from interface: RequestLogBuilder

Finishes the collection of the Response information. This method sets the following properties:

• RequestLog.responseEndTimeNanos()
• RequestLog.responseDurationNanos()
• RequestLog.responseCause()

Specified by:

endResponse in interface RequestLogBuilder

Parameters:

responseCause - the cause of the failure.

responseEndTimeNanos - System.nanoTime() value when the response ended.

totalDurationNanos

public long totalDurationNanos()

Description copied from interface: RequestLog

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.

Specified by:

totalDurationNanos in interface RequestLog

toString

public String toString()

Overrides:

toString in class Object

toStringRequestOnly

public String toStringRequestOnly()

Description copied from interface: RequestLog

Returns the string representation of the Request, with no sanitization of headers or content.

Specified by:

toStringRequestOnly in interface RequestLog

toStringRequestOnly

public String toStringRequestOnly(Function<? super HttpHeaders,?> headersSanitizer,
                                  Function<Object,?> contentSanitizer)

Description copied from interface: RequestLog

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

 toStringRequestOnly(headersSanitizer, contentSanitizer, headersSanitizer);
 

Specified by:

toStringRequestOnly in interface RequestLog

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

public String toStringRequestOnly(Function<? super RequestHeaders,?> headersSanitizer,
                                  Function<Object,?> contentSanitizer,
                                  Function<? super HttpHeaders,?> trailersSanitizer)

Description copied from interface: RequestLog

Returns the string representation of the Request.

Specified by:

toStringRequestOnly in interface RequestLog

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

public String toStringResponseOnly()

Description copied from interface: RequestLog

Returns the string representation of the Response, with no sanitization of headers or content.

Specified by:

toStringResponseOnly in interface RequestLog

toStringResponseOnly

public String toStringResponseOnly(Function<? super HttpHeaders,?> headersSanitizer,
                                   Function<Object,?> contentSanitizer)

Description copied from interface: RequestLog

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

 toStringResponseOnly(headersSanitizer, contentSanitizer, headersSanitizer);
 

Specified by:

toStringResponseOnly in interface RequestLog

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

public String toStringResponseOnly(Function<? super ResponseHeaders,?> headersSanitizer,
                                   Function<Object,?> contentSanitizer,
                                   Function<? super HttpHeaders,?> trailersSanitizer)

Description copied from interface: RequestLog

Returns the string representation of the Response.

Specified by:

toStringResponseOnly in interface RequestLog

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.