Package com.linecorp.armeria.client.logging

Class LoggingClientBuilder

java.lang.Object

com.linecorp.armeria.common.logging.LoggingDecoratorBuilder

com.linecorp.armeria.client.logging.LoggingClientBuilder

public final class LoggingClientBuilder
extends LoggingDecoratorBuilder

Builds a new LoggingClient.

Method Summary

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

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

newDecorator

public Function<? super HttpClient,LoggingClient> newDecorator()

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

samplingRate

public LoggingClientBuilder 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 LoggingClientBuilder sampler(Sampler<? super ClientRequestContext> sampler)

Sets the Sampler that determines which request needs logging.

logger

public LoggingClientBuilder 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 LoggingClientBuilder 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 LoggingClientBuilder 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 LoggingClientBuilder 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 LoggingClientBuilder 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 LoggingClientBuilder 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 LoggingClientBuilder 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 LoggingClientBuilder requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> 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 LoggingClientBuilder responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> 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 LoggingClientBuilder requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> 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 LoggingClientBuilder responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> 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 LoggingClientBuilder headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> 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 LoggingClientBuilder requestContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable 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 LoggingClientBuilder responseContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable 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 LoggingClientBuilder contentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable 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 LoggingClientBuilder responseCauseSanitizer(BiFunction<? super RequestContext,? super Throwable,? extends @Nullable Object> 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