Package com.linecorp.armeria.common.logging

Interface RequestLogBuilder

All Known Implementing Classes:

DefaultRequestLog

public interface RequestLogBuilder

Updates a RequestLog with newly available information.

Field Summary

Fields

Modifier and Type	Field	Description
static RequestLogBuilder	NOOP	A dummy RequestLogBuilder that discards everything it collected.

Method Summary

Modifier and Type	Method	Description
void	addChild(RequestLog child)	Adds the specified RequestLog so that the logs are propagated from the child.
void	deferRequestContent()	Allows the requestContent(Object, Object) called after endRequest().
void	deferResponseContent()	Allows the responseContent(Object, Object) called after 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.
void	increaseRequestLength(long deltaBytes)	Increases the RequestLog.requestLength() by deltaBytes.
void	increaseRequestLength(HttpData data)	Increases the RequestLog.requestLength() by data.length() and passes data to the previewer.
void	increaseResponseLength(long deltaBytes)	Increases the RequestLog.responseLength() by deltaBytes.
void	increaseResponseLength(HttpData data)	Increases the RequestLog.responseLength() by data.length() and passes data to the previewer.
boolean	isRequestContentDeferred()	Returns true if deferRequestContent() was ever called.
boolean	isResponseContentDeferred()	Returns true if deferResponseContent() was ever called.
void	requestContent(Object requestContent, Object rawRequestContent)	Sets the RequestLog.requestContent() and the RequestLog.rawRequestContent().
void	requestContentPreview(String requestContentPreview)	Sets the RequestLog.requestContentPreview().
void	requestFirstBytesTransferred()	Sets RequestLog.requestFirstBytesTransferredTimeNanos().
void	requestFirstBytesTransferred(long requestFirstBytesTransferredNanos)	Sets RequestLog.requestFirstBytesTransferredTimeNanos() with the specified timestamp.
void	requestHeaders(RequestHeaders requestHeaders)	Sets the RequestLog.requestHeaders().
void	requestLength(long requestLength)	Sets the RequestLog.requestLength().
void	requestTrailers(HttpHeaders requestTrailers)	Sets the RequestLog.requestTrailers().
void	responseContent(Object responseContent, Object rawResponseContent)	Sets the RequestLog.responseContent() and the RequestLog.rawResponseContent().
void	responseContentPreview(String responseContentPreview)	Sets the RequestLog.responseContentPreview().
void	responseFirstBytesTransferred()	Sets RequestLog.responseFirstBytesTransferredTimeNanos().
void	responseFirstBytesTransferred(long responseFirstBytesTransferredNanos)	Sets RequestLog.responseFirstBytesTransferredTimeNanos() with the specified timestamp.
void	responseHeaders(ResponseHeaders responseHeaders)	Sets the RequestLog.responseHeaders().
void	responseLength(long responseLength)	Sets the RequestLog.responseLength().
void	responseTrailers(HttpHeaders responseTrailers)	Sets the RequestLog.responseTrailers().
void	serializationFormat(SerializationFormat serializationFormat)	Sets the SerializationFormat.
default void	startRequest(Channel channel, SessionProtocol sessionProtocol)	Starts the collection of the Request information.
default void	startRequest(Channel channel, SessionProtocol sessionProtocol, long requestStartTimeNanos, long requestStartTimeMicros)	Starts the collection of the Request information.
void	startRequest(Channel channel, SessionProtocol sessionProtocol, SSLSession sslSession)	Starts the collection of the Request information.
void	startRequest(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.

Field Detail

NOOP

static final RequestLogBuilder NOOP

A dummy RequestLogBuilder that discards everything it collected.

Method Detail

addChild

void addChild(RequestLog child)

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 endResponseWithLastChild().

endResponseWithLastChild

void endResponseWithLastChild()

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

startRequest

default void startRequest(Channel channel,
                          SessionProtocol sessionProtocol)

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()

Parameters:

channel - the Channel which handled the Request.

sessionProtocol - the SessionProtocol of the connection.

startRequest

void startRequest(Channel channel,
                  SessionProtocol sessionProtocol,
                  @Nullable
                  SSLSession sslSession)

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()

Parameters:

channel - the Channel which handled the Request.

sessionProtocol - the SessionProtocol of the connection.

sslSession - the SSLSession of the connection, or null.

startRequest

default void startRequest(Channel channel,
                          SessionProtocol sessionProtocol,
                          long requestStartTimeNanos,
                          long requestStartTimeMicros)

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()

Parameters:

channel - the Channel which handled the Request.

sessionProtocol - the SessionProtocol of the connection.

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

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

startRequest

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

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()

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.

serializationFormat

void serializationFormat(SerializationFormat serializationFormat)

Sets the SerializationFormat.

increaseRequestLength

void increaseRequestLength(long deltaBytes)

Increases the RequestLog.requestLength() by deltaBytes.

increaseRequestLength

void increaseRequestLength(HttpData data)

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

requestLength

void requestLength(long requestLength)

Sets the RequestLog.requestLength().

requestFirstBytesTransferred

void requestFirstBytesTransferred()

Sets RequestLog.requestFirstBytesTransferredTimeNanos().

requestFirstBytesTransferred

void requestFirstBytesTransferred(long requestFirstBytesTransferredNanos)

Sets RequestLog.requestFirstBytesTransferredTimeNanos() with the specified timestamp.

requestHeaders

void requestHeaders(RequestHeaders requestHeaders)

Sets the RequestLog.requestHeaders().

requestContent

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

Sets the RequestLog.requestContent() and the RequestLog.rawRequestContent().

requestContentPreview

void requestContentPreview(@Nullable
                           String requestContentPreview)

Sets the RequestLog.requestContentPreview().

deferRequestContent

void deferRequestContent()

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

isRequestContentDeferred

boolean isRequestContentDeferred()

Returns true if deferRequestContent() was ever called.

requestTrailers

void requestTrailers(HttpHeaders requestTrailers)

Sets the RequestLog.requestTrailers().

endRequest

void endRequest()

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

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

endRequest

void endRequest(Throwable requestCause)

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

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

Parameters:

requestCause - the cause of the failure.

endRequest

void endRequest(long requestEndTimeNanos)

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

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

Parameters:

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

endRequest

void endRequest(Throwable requestCause,
                long requestEndTimeNanos)

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

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

Parameters:

requestCause - the cause of the failure.

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

startResponse

void startResponse()

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

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

startResponse

void startResponse(long responseStartTimeNanos,
                   long responseStartTimeMicros)

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

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

Parameters:

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

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

increaseResponseLength

void increaseResponseLength(long deltaBytes)

Increases the RequestLog.responseLength() by deltaBytes.

increaseResponseLength

void increaseResponseLength(HttpData data)

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

responseLength

void responseLength(long responseLength)

Sets the RequestLog.responseLength().

responseFirstBytesTransferred

void responseFirstBytesTransferred()

Sets RequestLog.responseFirstBytesTransferredTimeNanos().

responseFirstBytesTransferred

void responseFirstBytesTransferred(long responseFirstBytesTransferredNanos)

Sets RequestLog.responseFirstBytesTransferredTimeNanos() with the specified timestamp.

responseHeaders

void responseHeaders(ResponseHeaders responseHeaders)

Sets the RequestLog.responseHeaders().

responseContent

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

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

responseContentPreview

void responseContentPreview(@Nullable
                            String responseContentPreview)

Sets the RequestLog.responseContentPreview().

deferResponseContent

void deferResponseContent()

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

isResponseContentDeferred

boolean isResponseContentDeferred()

Returns true if deferResponseContent() was ever called.

responseTrailers

void responseTrailers(HttpHeaders responseTrailers)

Sets the RequestLog.responseTrailers().

endResponse

void endResponse()

Finishes the collection of the Response information. If a Throwable cause has been set with 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()

endResponse

void endResponse(Throwable responseCause)

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

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

Parameters:

responseCause - the cause of the failure.

endResponse

void endResponse(long responseEndTimeNanos)

Finishes the collection of the Response information. If a Throwable cause has been set with 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()

Parameters:

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

endResponse

void endResponse(Throwable responseCause,
                 long responseEndTimeNanos)

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

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

Parameters:

responseCause - the cause of the failure.

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