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)	Deprecated.
protected LoggingClientBuilder	defaultLogger(org.slf4j.Logger logger)	Sets the logger that is used when neither LoggingDecoratorBuilder.logWriter(LogWriter) nor LoggingDecoratorBuilder.logger(Logger) is set.
LoggingClientBuilder	failureResponseLogLevel(LogLevel failureResponseLogLevel)	Sets the LogLevel to use when logging failure responses (e.g., failed with an exception).
LoggingClientBuilder	failureSampler(Sampler<? super ClientRequestContext> sampler)	Sets the Sampler that determines which failure request needs logging.
LoggingClientBuilder	failureSamplingRate(float samplingRate)	Sets the rate at which to sample failure requests to log.
LoggingClientBuilder	headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> headersSanitizer)	Deprecated.
LoggingClientBuilder	logger(String loggerName)	Sets the name of the Logger to use when logging.
LoggingClientBuilder	logger(org.slf4j.Logger logger)	Sets the Logger to use when logging.
LoggingClientBuilder	logWriter(LogWriter logWriter)	Sets the LogWriter which write a RequestOnlyLog or RequestLog.
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)	Deprecated.
LoggingClientBuilder	requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestHeadersSanitizer)	Deprecated.
LoggingClientBuilder	requestLogLevel(LogLevel requestLogLevel)	Sets the LogLevel to use when logging requests.
LoggingClientBuilder	requestLogLevel(Class<? extends Throwable> clazz, LogLevel requestLogLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
LoggingClientBuilder	requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)	Sets the RequestLogLevelMapper to use when mapping the log level of request logs.
LoggingClientBuilder	requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)	Deprecated.
LoggingClientBuilder	requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestTrailersSanitizer)	Deprecated.
LoggingClientBuilder	responseCauseFilter(Predicate<Throwable> responseCauseFilter)	Sets the Predicate used for evaluating whether to log the response cause or not.
LoggingClientBuilder	responseCauseSanitizer(BiFunction<? super RequestContext,? super Throwable,? extends @Nullable Object> responseCauseSanitizer)	Deprecated.
LoggingClientBuilder	responseContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> responseContentSanitizer)	Deprecated.
LoggingClientBuilder	responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseHeadersSanitizer)	Deprecated.
LoggingClientBuilder	responseLogLevel(HttpStatusClass statusClass, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status belongs to the specified HttpStatusClass.
LoggingClientBuilder	responseLogLevel(HttpStatus status, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status is equal to the specified HttpStatus.
LoggingClientBuilder	responseLogLevel(Class<? extends Throwable> clazz, LogLevel logLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
LoggingClientBuilder	responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)	Sets the ResponseLogLevelMapper to use when mapping the log level of response logs.
LoggingClientBuilder	responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)	Deprecated.
LoggingClientBuilder	responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseTrailersSanitizer)	Deprecated.
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).
LoggingClientBuilder	successSampler(Sampler<? super ClientRequestContext> sampler)	Sets the Sampler that determines which success request needs logging.
LoggingClientBuilder	successSamplingRate(float samplingRate)	Sets the rate at which to sample success requests to log.

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

logger, logWriter, 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.

defaultLogger

protected LoggingClientBuilder defaultLogger(org.slf4j.Logger logger)

Description copied from class: LoggingDecoratorBuilder

Sets the logger that is used when neither LoggingDecoratorBuilder.logWriter(LogWriter) nor LoggingDecoratorBuilder.logger(Logger) is set.

Overrides:

defaultLogger in class LoggingDecoratorBuilder

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. This method sets both success and failure sampling rate. Use successSamplingRate(float) and failureSamplingRate(float) if you want to specify a different sampling rate for each case.

sampler

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

Sets the Sampler that determines which request needs logging.

successSampler

public LoggingClientBuilder successSampler(Sampler<? super ClientRequestContext> sampler)

Sets the Sampler that determines which success request needs logging.

successSamplingRate

public LoggingClientBuilder successSamplingRate(float samplingRate)

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

failureSampler

public LoggingClientBuilder failureSampler(Sampler<? super ClientRequestContext> sampler)

Sets the Sampler that determines which failure request needs logging.

failureSamplingRate

public LoggingClientBuilder failureSamplingRate(float samplingRate)

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

logger

public LoggingClientBuilder logger(org.slf4j.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

requestLogLevel

public LoggingClientBuilder requestLogLevel(Class<? extends Throwable> clazz,
 LogLevel requestLogLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when the response fails with the specified Throwable.

Overrides:

requestLogLevel in class LoggingDecoratorBuilder

requestLogLevelMapper

@Deprecated
public LoggingClientBuilder requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)

Deprecated.

Description copied from class: LoggingDecoratorBuilder

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

Overrides:

requestLogLevelMapper in class LoggingDecoratorBuilder

requestLogLevelMapper

public LoggingClientBuilder requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)

Description copied from class: LoggingDecoratorBuilder

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

Overrides:

requestLogLevelMapper in class LoggingDecoratorBuilder

responseLogLevel

public LoggingClientBuilder responseLogLevel(HttpStatus status,
 LogLevel logLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when logging responses whose status is equal to the specified HttpStatus.

Overrides:

responseLogLevel in class LoggingDecoratorBuilder

responseLogLevel

public LoggingClientBuilder responseLogLevel(HttpStatusClass statusClass,
 LogLevel logLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when logging responses whose status belongs to the specified HttpStatusClass.

Overrides:

responseLogLevel in class LoggingDecoratorBuilder

responseLogLevel

public LoggingClientBuilder responseLogLevel(Class<? extends Throwable> clazz,
 LogLevel logLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when the response fails with the specified Throwable.

Overrides:

responseLogLevel 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). LogLevel.DEBUG will be used by default.

Overrides:

successfulResponseLogLevel in class LoggingDecoratorBuilder

failureResponseLogLevel

public LoggingClientBuilder failureResponseLogLevel(LogLevel failureResponseLogLevel)

Description copied from class: LoggingDecoratorBuilder

Sets the LogLevel to use when logging failure responses (e.g., failed with an exception). LogLevel.WARN will be used by default.

Overrides:

failureResponseLogLevel in class LoggingDecoratorBuilder

responseLogLevelMapper

@Deprecated
public LoggingClientBuilder responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)

Deprecated.

Description copied from class: LoggingDecoratorBuilder

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

Overrides:

responseLogLevelMapper in class LoggingDecoratorBuilder

responseLogLevelMapper

public LoggingClientBuilder responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)

Description copied from class: LoggingDecoratorBuilder

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

Overrides:

responseLogLevelMapper in class LoggingDecoratorBuilder

requestHeadersSanitizer

@Deprecated
public LoggingClientBuilder requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestHeadersSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseHeadersSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestTrailersSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseTrailersSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> headersSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder requestContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> requestContentSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder responseContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> responseContentSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder contentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> contentSanitizer)

Deprecated.

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

@Deprecated
public LoggingClientBuilder responseCauseSanitizer(BiFunction<? super RequestContext,? super Throwable,? extends @Nullable Object> responseCauseSanitizer)

Deprecated.

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

responseCauseFilter

public LoggingClientBuilder responseCauseFilter(Predicate<Throwable> responseCauseFilter)

Description copied from class: LoggingDecoratorBuilder

Sets the Predicate used for evaluating whether to log the response cause or not. You can prevent logging the response cause by returning true in the Predicate. By default, the response cause will always be logged.

Overrides:

responseCauseFilter in class LoggingDecoratorBuilder

logWriter

public LoggingClientBuilder logWriter(LogWriter logWriter)

Description copied from class: LoggingDecoratorBuilder

Sets the LogWriter which write a RequestOnlyLog or RequestLog. By default LogWriter.of() will be used.

Overrides:

logWriter in class LoggingDecoratorBuilder