RequestLogBuilder (filter-service-metrics 1.13 1.13 API)

All Superinterfaces:

RequestLogAccess
```
public interface RequestLogBuilder
extends RequestLogAccess
```
Updates a RequestLog with newly available information.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`void`	`addChild(RequestLogAccess child)` Adds the specified `RequestLogAccess` so that the logs are propagated from the `child`.
`void`	`deferRequestContent()` Allows setting the request content using `requestContent(Object, Object)` even after `endRequest()` is called.
`void`	`deferRequestContentPreview()` Allows setting the request content preview using `requestContentPreview(String)` even after `endRequest()` is called.
`void`	`deferResponseContent()` Allows setting the response content using `responseContent(Object, Object)` even after `endResponse()` is called.
`void`	`deferResponseContentPreview()` Allows setting the response content preview using `responseContentPreview(String)` even after `endResponse()` is called.
`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(HttpData data)` Increases the `RequestOnlyLog.requestLength()` by `data.length()` and passes `data` to the previewer.
`void`	`increaseRequestLength(long deltaBytes)` Increases the `RequestOnlyLog.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`.
`void`	`name(String name)` Sets the human-readable name of the `Request`, such as RPC method name, annotated service method name or HTTP method name.
`void`	`requestContent(Object requestContent, Object rawRequestContent)` Sets the `RequestOnlyLog.requestContent()` and the `RequestOnlyLog.rawRequestContent()`.
`void`	`requestContentPreview(String requestContentPreview)` Sets the `RequestOnlyLog.requestContentPreview()`.
`void`	`requestFirstBytesTransferred()` Sets `RequestOnlyLog.requestFirstBytesTransferredTimeNanos()`.
`void`	`requestFirstBytesTransferred(long requestFirstBytesTransferredNanos)` Sets `RequestOnlyLog.requestFirstBytesTransferredTimeNanos()` with the specified timestamp.
`void`	`requestHeaders(RequestHeaders requestHeaders)` Sets the `RequestOnlyLog.requestHeaders()`.
`void`	`requestLength(long requestLength)` Sets the `RequestOnlyLog.requestLength()`.
`void`	`requestTrailers(HttpHeaders requestTrailers)` Sets the `RequestOnlyLog.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`.
`void`	`session(io.netty.channel.Channel channel, SessionProtocol sessionProtocol, ClientConnectionTimings connectionTimings)` Sets the properties related with socket connection.
`void`	`session(io.netty.channel.Channel channel, SessionProtocol sessionProtocol, SSLSession sslSession, ClientConnectionTimings connectionTimings)` Sets the properties related with socket connection.
`default void`	`startRequest()` Starts the collection of the `Request` information.
`void`	`startRequest(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.

Methods inherited from interface com.linecorp.armeria.common.logging.RequestLogAccess
availabilityStamp, children, context, ensureAvailable, ensureAvailable, ensureAvailable, ensureComplete, ensureRequestComplete, isAvailable, isAvailable, isAvailable, isComplete, isRequestComplete, partial, whenAvailable, whenAvailable, whenAvailable, whenComplete, whenRequestComplete

- Method Detail
  - startRequest
```
default void startRequest()
```
    Starts the collection of the Request information. This method sets the following properties:
  - startRequest
```
void startRequest(long requestStartTimeNanos,
                  long requestStartTimeMicros)
```
    Starts the collection of the Request information. This method sets the following properties:
    Parameters:
    
    requestStartTimeNanos - System.nanoTime() value when the request started.
    
    requestStartTimeMicros - the number of microseconds since the epoch, e.g. System.currentTimeMillis() * 1000.
  - session
```
void session(io.netty.channel.Channel channel,
             SessionProtocol sessionProtocol,
             ClientConnectionTimings connectionTimings)
```
    Sets the properties related with socket connection. This method sets the following properties:
    Parameters:
    
    channel - the Channel which handled the Request.
    
    sessionProtocol - the SessionProtocol of the connection.
  - session
```
void session(io.netty.channel.Channel channel,
             SessionProtocol sessionProtocol,
             SSLSession sslSession,
             ClientConnectionTimings connectionTimings)
```
    Sets the properties related with socket connection. This method sets the following properties:
    Parameters:
    
    channel - the Channel which handled the Request.
    
    sessionProtocol - the SessionProtocol of the connection.
    
    sslSession - the SSLSession of the connection, or null.
  - serializationFormat
```
void serializationFormat(SerializationFormat serializationFormat)
```
    Sets the SerializationFormat.
  - name
```
void name(String name)
```
    Sets the human-readable name of the Request, such as RPC method name, annotated service method name or HTTP method name. This property is often used as a meter tag or distributed trace's span name.
  - increaseRequestLength
```
void increaseRequestLength(long deltaBytes)
```
    Increases the RequestOnlyLog.requestLength() by deltaBytes.
  - increaseRequestLength
```
void increaseRequestLength(HttpData data)
```
    Increases the RequestOnlyLog.requestLength() by data.length() and passes data to the previewer.
  - requestLength
```
void requestLength(long requestLength)
```
    Sets the RequestOnlyLog.requestLength().
  - requestFirstBytesTransferred
```
void requestFirstBytesTransferred()
```
    Sets RequestOnlyLog.requestFirstBytesTransferredTimeNanos().
  - requestFirstBytesTransferred
```
void requestFirstBytesTransferred(long requestFirstBytesTransferredNanos)
```
    Sets RequestOnlyLog.requestFirstBytesTransferredTimeNanos() with the specified timestamp.
  - requestHeaders
```
void requestHeaders(RequestHeaders requestHeaders)
```
    Sets the RequestOnlyLog.requestHeaders().
  - requestContent
```
void requestContent(Object requestContent,
                    Object rawRequestContent)
```
    Sets the RequestOnlyLog.requestContent() and the RequestOnlyLog.rawRequestContent(). If the specified requestContent is an RpcRequest and the RequestContext.rpcRequest() is null, this method will call RequestContext.updateRpcRequest(RpcRequest).
  - requestContentPreview
```
void requestContentPreview(String requestContentPreview)
```
    Sets the RequestOnlyLog.requestContentPreview().
  - deferRequestContent
```
void deferRequestContent()
```
    Allows setting the request content using requestContent(Object, Object) even after endRequest() is called.
    Note, however, the request content is not set if endRequest(Throwable) was called.
  - deferRequestContentPreview
```
void deferRequestContentPreview()
```
    Allows setting the request content preview using requestContentPreview(String) even after endRequest() is called.
    Note, however, the request content preview is not set if endRequest(Throwable) was called.
  - requestTrailers
```
void requestTrailers(HttpHeaders requestTrailers)
```
    Sets the RequestOnlyLog.requestTrailers().
  - endRequest
```
void endRequest()
```
    Finishes the collection of the Request information. This method sets the following properties:
  - endRequest
```
void endRequest(Throwable requestCause)
```
    Finishes the collection of the Request information. This method sets the following properties:
    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:
    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:
    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:
  - startResponse
```
void startResponse(long responseStartTimeNanos,
                   long responseStartTimeMicros)
```
    Starts the collection of Response information. This method sets the following properties:
    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(Object responseContent,
                     Object rawResponseContent)
```
    Sets the RequestLog.responseContent() and the RequestLog.rawResponseContent().
  - responseContentPreview
```
void responseContentPreview(String responseContentPreview)
```
    Sets the RequestLog.responseContentPreview().
  - deferResponseContent
```
void deferResponseContent()
```
    Allows setting the response content using responseContent(Object, Object) even after endResponse() is called.
    Note, however, the response content is not set if endResponse(Throwable) was called.
  - deferResponseContentPreview
```
void deferResponseContentPreview()
```
    Allows setting the response content preview using responseContentPreview(String) even after endResponse() is called.
    Note, however, the response content preview is not set if endResponse(Throwable) was 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:
  - endResponse
```
void endResponse(Throwable responseCause)
```
    Finishes the collection of the Response information. This method sets the following properties:
    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:
    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:
    Parameters:
    
    responseCause - the cause of the failure.
    
    responseEndTimeNanos - System.nanoTime() value when the response ended.
  - addChild
```
void addChild(RequestLogAccess child)
```
    Adds the specified RequestLogAccess 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 collected properties in the child log will be propagated immediately.

Interface RequestLogBuilder

Method Summary

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

Method Detail

startRequest

startRequest

session

session

serializationFormat

name

increaseRequestLength

increaseRequestLength

requestLength

requestFirstBytesTransferred

requestFirstBytesTransferred

requestHeaders

requestContent

requestContentPreview

deferRequestContent

deferRequestContentPreview

requestTrailers

endRequest

endRequest

endRequest

endRequest

startResponse

startResponse

increaseResponseLength

increaseResponseLength

responseLength

responseFirstBytesTransferred

responseFirstBytesTransferred

responseHeaders

responseContent

responseContentPreview

deferResponseContent

deferResponseContentPreview

responseTrailers

endResponse

endResponse

endResponse

endResponse

addChild

endResponseWithLastChild