Package com.linecorp.armeria.server.logging

Class LoggingServiceBuilder

java.lang.Object

com.linecorp.armeria.common.logging.LoggingDecoratorBuilder

com.linecorp.armeria.server.logging.LoggingServiceBuilder

public final class LoggingServiceBuilder
extends LoggingDecoratorBuilder

Builds a new LoggingService.

Method Summary

Modifier and Type	Method	Description
LoggingService	build(HttpService delegate)	Returns a newly-created LoggingService decorating HttpService based on the properties of this builder.
LoggingServiceBuilder	contentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> contentSanitizer)	Deprecated.
protected LoggingServiceBuilder	defaultLogger(Logger logger)	Sets the logger that is used when neither LoggingDecoratorBuilder.logWriter(LogWriter) nor LoggingDecoratorBuilder.logger(Logger) is set.
LoggingServiceBuilder	failureResponseLogLevel(LogLevel failureResponseLogLevel)	Sets the LogLevel to use when logging failure responses (e.g., failed with an exception).
LoggingServiceBuilder	failureSampler(Sampler<? super ServiceRequestContext> failureSampler)	Sets the Sampler that determines which failure request needs logging.
LoggingServiceBuilder	failureSamplingRate(float failureSamplingRate)	Sets the rate at which to sample requests to log.
LoggingServiceBuilder	headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> headersSanitizer)	Deprecated.
LoggingServiceBuilder	logger(String loggerName)	Sets the name of the Logger to use when logging.
LoggingServiceBuilder	logger(Logger logger)	Sets the Logger to use when logging.
LoggingServiceBuilder	logWriter(LogWriter logWriter)	Sets the LogWriter which write a RequestOnlyLog or RequestLog.
Function<? super HttpService,LoggingService>	newDecorator()	Returns a newly-created LoggingService decorator based on the properties of this builder.
LoggingServiceBuilder	requestContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> requestContentSanitizer)	Deprecated.
LoggingServiceBuilder	requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestHeadersSanitizer)	Deprecated.
LoggingServiceBuilder	requestLogLevel(LogLevel requestLogLevel)	Sets the LogLevel to use when logging requests.
LoggingServiceBuilder	requestLogLevel(Class<? extends Throwable> clazz, LogLevel requestLogLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
LoggingServiceBuilder	requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)	Sets the RequestLogLevelMapper to use when mapping the log level of request logs.
LoggingServiceBuilder	requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)	Deprecated.
LoggingServiceBuilder	requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestTrailersSanitizer)	Deprecated.
LoggingServiceBuilder	responseCauseFilter(Predicate<Throwable> responseCauseFilter)	Sets the Predicate used for evaluating whether to log the response cause or not.
LoggingServiceBuilder	responseCauseSanitizer(BiFunction<? super RequestContext,? super Throwable,? extends @Nullable Object> responseCauseSanitizer)	Deprecated.
LoggingServiceBuilder	responseContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> responseContentSanitizer)	Deprecated.
LoggingServiceBuilder	responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseHeadersSanitizer)	Deprecated.
LoggingServiceBuilder	responseLogLevel(HttpStatusClass statusClass, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status belongs to the specified HttpStatusClass.
LoggingServiceBuilder	responseLogLevel(HttpStatus status, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status is equal to the specified HttpStatus.
LoggingServiceBuilder	responseLogLevel(Class<? extends Throwable> clazz, LogLevel logLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
LoggingServiceBuilder	responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)	Sets the ResponseLogLevelMapper to use when mapping the log level of response logs.
LoggingServiceBuilder	responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)	Deprecated.
LoggingServiceBuilder	responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseTrailersSanitizer)	Deprecated.
LoggingServiceBuilder	sampler(Sampler<? super ServiceRequestContext> sampler)	Sets the Sampler that determines which request needs logging.
LoggingServiceBuilder	samplingRate(float samplingRate)	Sets the rate at which to sample requests to log.
LoggingServiceBuilder	successfulResponseLogLevel(LogLevel successfulResponseLogLevel)	Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception).
LoggingServiceBuilder	successSampler(Sampler<? super ServiceRequestContext> successSampler)	Sets the Sampler that determines which success request needs logging.
LoggingServiceBuilder	successSamplingRate(float successSamplingRate)	Sets the rate at which to sample 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

sampler

public LoggingServiceBuilder sampler(Sampler<? super ServiceRequestContext> sampler)

Sets the Sampler that determines which request needs logging. This method sets both success and failure sampler. Use successSampler(Sampler) and failureSampler(Sampler) if you want to specify a different sampler for each case.

samplingRate

public LoggingServiceBuilder 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.

successSampler

public LoggingServiceBuilder successSampler(Sampler<? super ServiceRequestContext> successSampler)

Sets the Sampler that determines which success request needs logging.

successSamplingRate

public LoggingServiceBuilder successSamplingRate(float successSamplingRate)

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 success requests to be logged.

failureSampler

public LoggingServiceBuilder failureSampler(Sampler<? super ServiceRequestContext> failureSampler)

Sets the Sampler that determines which failure request needs logging.

failureSamplingRate

public LoggingServiceBuilder failureSamplingRate(float failureSamplingRate)

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 failure requests to be logged.

build

public LoggingService build(HttpService delegate)

Returns a newly-created LoggingService decorating HttpService based on the properties of this builder.

newDecorator

public Function<? super HttpService,LoggingService> newDecorator()

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

defaultLogger

protected LoggingServiceBuilder defaultLogger(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

logger

public LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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 LoggingServiceBuilder 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