Package com.linecorp.armeria.client.logging

Class LoggingRpcClientBuilder

java.lang.Object

com.linecorp.armeria.common.logging.LoggingDecoratorBuilder

com.linecorp.armeria.client.logging.LoggingRpcClientBuilder

public final class LoggingRpcClientBuilder
extends LoggingDecoratorBuilder

Builds a new LoggingRpcClient.

Method Summary

Modifier and Type	Method	Description
LoggingRpcClient	build(RpcClient delegate)	Returns a newly-created LoggingRpcClient decorating delegate based on the properties of this builder.
LoggingRpcClientBuilder	contentSanitizer(BiFunction<? super RequestContext,Object,?> contentSanitizer)	Sets the BiFunction to use to sanitize request and response content before logging.
LoggingRpcClientBuilder	failureResponseLogLevel(LogLevel failedResponseLogLevel)	Sets the LogLevel to use when logging failure responses (e.g., failed with an exception).
LoggingRpcClientBuilder	headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> headersSanitizer)	Sets the BiFunction to use to sanitize request, response and trailers before logging.
LoggingRpcClientBuilder	logger(String loggerName)	Sets the name of the Logger to use when logging.
LoggingRpcClientBuilder	logger(Logger logger)	Sets the Logger to use when logging.
Function<? super RpcClient,LoggingRpcClient>	newDecorator()	Returns a newly-created LoggingRpcClient decorator based on the properties of this builder.
LoggingRpcClientBuilder	requestContentSanitizer(BiFunction<? super RequestContext,Object,?> requestContentSanitizer)	Sets the BiFunction to use to sanitize request content before logging.
LoggingRpcClientBuilder	requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> requestHeadersSanitizer)	Sets the BiFunction to use to sanitize request headers before logging.
LoggingRpcClientBuilder	requestLogLevel(LogLevel requestLogLevel)	Sets the LogLevel to use when logging requests.
LoggingRpcClientBuilder	requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)	Sets the Function to use when mapping the log level of request logs.
LoggingRpcClientBuilder	requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> requestTrailersSanitizer)	Sets the BiFunction to use to sanitize request trailers before logging.
LoggingRpcClientBuilder	responseCauseSanitizer(BiFunction<? super RequestContext,? super Throwable,?> responseCauseSanitizer)	Sets the BiFunction to use to sanitize a response cause before logging.
LoggingRpcClientBuilder	responseContentSanitizer(BiFunction<? super RequestContext,Object,?> responseContentSanitizer)	Sets the BiFunction to use to sanitize response content before logging.
LoggingRpcClientBuilder	responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> responseHeadersSanitizer)	Sets the BiFunction to use to sanitize response headers before logging.
LoggingRpcClientBuilder	responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)	Sets the Function to use when mapping the log level of response logs.
LoggingRpcClientBuilder	responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> responseTrailersSanitizer)	Sets the BiFunction to use to sanitize response trailers before logging.
LoggingRpcClientBuilder	sampler(Sampler<? super ClientRequestContext> sampler)	Sets the Sampler that determines which request needs logging.
LoggingRpcClientBuilder	samplingRate(float samplingRate)	Sets the rate at which to sample requests to log.
LoggingRpcClientBuilder	successfulResponseLogLevel(LogLevel successfulResponseLogLevel)	Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception).

Methods inherited from class com.linecorp.armeria.common.logging.LoggingDecoratorBuilder

logger, requestContentSanitizer, requestHeadersSanitizer, requestLogLevelMapper, requestTrailersSanitizer, responseCauseSanitizer, responseContentSanitizer, responseHeadersSanitizer, responseLogLevelMapper, responseTrailersSanitizer, toString

Methods inherited from class java.lang.Object

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

Method Details

build

public LoggingRpcClient build(RpcClient delegate)

Returns a newly-created LoggingRpcClient decorating delegate based on the properties of this builder.

newDecorator

public Function<? super RpcClient,LoggingRpcClient> newDecorator()

Returns a newly-created LoggingRpcClient decorator based on the properties of this builder.

samplingRate

public LoggingRpcClientBuilder samplingRate(float samplingRate)

Sets the rate at which to sample requests to log. Any number between 0.0 and 1.0 will cause a random sample of the requests to be logged.

sampler

public LoggingRpcClientBuilder sampler(Sampler<? super ClientRequestContext> sampler)

Sets the Sampler that determines which request needs logging.

logger

public LoggingRpcClientBuilder logger(Logger logger)

Description copied from class: LoggingDecoratorBuilder

Sets the Logger to use when logging. If unset, a default Logger will be used.

Overrides:

logger in class LoggingDecoratorBuilder

logger

public LoggingRpcClientBuilder logger(String loggerName)

Description copied from class: LoggingDecoratorBuilder

Sets the name of the Logger to use when logging. This method is a shortcut for this.logger(LoggerFactory.getLogger(loggerName)).

Overrides:

logger in class LoggingDecoratorBuilder

requestLogLevel

public LoggingRpcClientBuilder requestLogLevel(LogLevel requestLogLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when logging requests. If unset, will use LogLevel.DEBUG.

Overrides:

requestLogLevel in class LoggingDecoratorBuilder

successfulResponseLogLevel

public LoggingRpcClientBuilder successfulResponseLogLevel(LogLevel successfulResponseLogLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception). If unset, will use LogLevel.DEBUG.

Overrides:

successfulResponseLogLevel in class LoggingDecoratorBuilder

failureResponseLogLevel

public LoggingRpcClientBuilder failureResponseLogLevel(LogLevel failedResponseLogLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when logging failure responses (e.g., failed with an exception). If unset, will use LogLevel.WARN. The request will be logged too if it was not otherwise.

Overrides:

failureResponseLogLevel in class LoggingDecoratorBuilder

requestLogLevelMapper

public LoggingRpcClientBuilder requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)

Description copied from class: LoggingDecoratorBuilder

Sets the Function to use when mapping the log level of request logs.

Overrides:

requestLogLevelMapper in class LoggingDecoratorBuilder

responseLogLevelMapper

public LoggingRpcClientBuilder responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)

Description copied from class: LoggingDecoratorBuilder

Sets the Function to use when mapping the log level of response logs.

Overrides:

responseLogLevelMapper in class LoggingDecoratorBuilder

requestHeadersSanitizer

public LoggingRpcClientBuilder requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> requestHeadersSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize request headers before logging. It is common to have the BiFunction that removes sensitive headers, like Cookie, before logging. If unset, will not sanitize request headers.

Overrides:

requestHeadersSanitizer in class LoggingDecoratorBuilder

responseHeadersSanitizer

public LoggingRpcClientBuilder responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> responseHeadersSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize response headers before logging. It is common to have the BiFunction that removes sensitive headers, like Set-Cookie, before logging. If unset, will not sanitize response headers.

Overrides:

responseHeadersSanitizer in class LoggingDecoratorBuilder

requestTrailersSanitizer

public LoggingRpcClientBuilder requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> requestTrailersSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize request trailers before logging. If unset, will not sanitize request trailers.

Overrides:

requestTrailersSanitizer in class LoggingDecoratorBuilder

responseTrailersSanitizer

public LoggingRpcClientBuilder responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> responseTrailersSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize response trailers before logging. If unset, will not sanitize response trailers.

Overrides:

responseTrailersSanitizer in class LoggingDecoratorBuilder

headersSanitizer

public LoggingRpcClientBuilder headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,?> headersSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize request, response and trailers before logging. It is common to have the BiFunction that removes sensitive headers, like "Cookie" and "Set-Cookie", before logging. This method is a shortcut for:

 builder.requestHeadersSanitizer(headersSanitizer);
 builder.requestTrailersSanitizer(headersSanitizer);
 builder.responseHeadersSanitizer(headersSanitizer);
 builder.responseTrailersSanitizer(headersSanitizer);
 

Overrides:

headersSanitizer in class LoggingDecoratorBuilder

See Also:

LoggingDecoratorBuilder.requestHeadersSanitizer(BiFunction), LoggingDecoratorBuilder.requestTrailersSanitizer(BiFunction), LoggingDecoratorBuilder.responseHeadersSanitizer(BiFunction), LoggingDecoratorBuilder.responseTrailersSanitizer(BiFunction)

requestContentSanitizer

public LoggingRpcClientBuilder requestContentSanitizer(BiFunction<? super RequestContext,Object,?> requestContentSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize request content before logging. It is common to have the BiFunction that removes sensitive content, such as an GPS location query, before logging. If unset, will not sanitize request content.

Overrides:

requestContentSanitizer in class LoggingDecoratorBuilder

responseContentSanitizer

public LoggingRpcClientBuilder responseContentSanitizer(BiFunction<? super RequestContext,Object,?> responseContentSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize response content before logging. It is common to have the BiFunction that removes sensitive content, such as an address, before logging. If unset, will not sanitize response content.

Overrides:

responseContentSanitizer in class LoggingDecoratorBuilder

contentSanitizer

public LoggingRpcClientBuilder contentSanitizer(BiFunction<? super RequestContext,Object,?> contentSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize request and response content before logging. It is common to have the BiFunction that removes sensitive content, such as an GPS location query and an address, before logging. If unset, will not sanitize content. This method is a shortcut for:

 builder.requestContentSanitizer(contentSanitizer);
 builder.responseContentSanitizer(contentSanitizer);
 

Overrides:

contentSanitizer in class LoggingDecoratorBuilder

See Also:

LoggingDecoratorBuilder.requestContentSanitizer(BiFunction), LoggingDecoratorBuilder.responseContentSanitizer(BiFunction)

responseCauseSanitizer

public LoggingRpcClientBuilder responseCauseSanitizer(BiFunction<? super RequestContext,? super Throwable,?> responseCauseSanitizer)

Description copied from class: LoggingDecoratorBuilder

Sets the BiFunction to use to sanitize a response cause before logging. You can sanitize the stack trace of the exception to remove sensitive information, or prevent from logging the stack trace completely by returning null in the BiFunction. If unset, will not sanitize a response cause.

Overrides:

responseCauseSanitizer in class LoggingDecoratorBuilder