Class LoggingServiceBuilder
java.lang.Object
com.linecorp.armeria.common.logging.LoggingDecoratorBuilder
com.linecorp.armeria.server.logging.LoggingServiceBuilder
Builds a new
LoggingService
.-
Method Summary
Modifier and TypeMethodDescriptionbuild
(HttpService delegate) Returns a newly-createdLoggingService
decoratingHttpService
based on the properties of this builder.contentSanitizer
(BiFunction<? super RequestContext, Object, ? extends @Nullable Object> contentSanitizer) Sets theBiFunction
to use to sanitize request and response content before logging.failureResponseLogLevel
(LogLevel failedResponseLogLevel) Sets theLogLevel
to use when logging failure responses (e.g., failed with an exception).headersSanitizer
(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> headersSanitizer) Sets theBiFunction
to use to sanitize request, response and trailers before logging.Sets the name of theLogger
to use when logging.Sets theLogger
to use when logging.Function<? super HttpService,
LoggingService> Returns a newly-createdLoggingService
decorator based on the properties of this builder.requestContentSanitizer
(BiFunction<? super RequestContext, Object, ? extends @Nullable Object> requestContentSanitizer) Sets theBiFunction
to use to sanitize request content before logging.requestHeadersSanitizer
(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> requestHeadersSanitizer) Sets theBiFunction
to use to sanitize request headers before logging.requestLogLevel
(LogLevel requestLogLevel) Sets theLogLevel
to use when logging requests.requestLogLevelMapper
(Function<? super RequestOnlyLog, LogLevel> requestLogLevelMapper) Sets theFunction
to use when mapping the log level of request logs.requestTrailersSanitizer
(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> requestTrailersSanitizer) Sets theBiFunction
to use to sanitize request trailers before logging.responseCauseSanitizer
(BiFunction<? super RequestContext, ? super Throwable, ? extends @Nullable Object> responseCauseSanitizer) Sets theBiFunction
to use to sanitize a response cause before logging.responseContentSanitizer
(BiFunction<? super RequestContext, Object, ? extends @Nullable Object> responseContentSanitizer) Sets theBiFunction
to use to sanitize response content before logging.responseHeadersSanitizer
(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> responseHeadersSanitizer) Sets theBiFunction
to use to sanitize response headers before logging.responseLogLevelMapper
(Function<? super RequestLog, LogLevel> responseLogLevelMapper) Sets theFunction
to use when mapping the log level of response logs.responseTrailersSanitizer
(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> responseTrailersSanitizer) Sets theBiFunction
to use to sanitize response trailers before logging.sampler
(Sampler<? super ServiceRequestContext> sampler) Sets theSampler
that determines which request needs logging.samplingRate
(float samplingRate) Sets the rate at which to sample requests to log.successfulResponseLogLevel
(LogLevel successfulResponseLogLevel) Sets theLogLevel
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
-
Method Details
-
sampler
Sets theSampler
that determines which request needs logging. -
samplingRate
Sets the rate at which to sample requests to log. Any number between0.0
and1.0
will cause a random sample of the requests to be logged. -
build
Returns a newly-createdLoggingService
decoratingHttpService
based on the properties of this builder. -
newDecorator
Returns a newly-createdLoggingService
decorator based on the properties of this builder. -
logger
Description copied from class:LoggingDecoratorBuilder
- Overrides:
logger
in classLoggingDecoratorBuilder
-
logger
Description copied from class:LoggingDecoratorBuilder
Sets the name of theLogger
to use when logging. This method is a shortcut forthis.logger(LoggerFactory.getLogger(loggerName))
.- Overrides:
logger
in classLoggingDecoratorBuilder
-
requestLogLevel
Description copied from class:LoggingDecoratorBuilder
Sets theLogLevel
to use when logging requests. If unset, will useLogLevel.DEBUG
.- Overrides:
requestLogLevel
in classLoggingDecoratorBuilder
-
successfulResponseLogLevel
Description copied from class:LoggingDecoratorBuilder
Sets theLogLevel
to use when logging successful responses (e.g., no unhandled exception). If unset, will useLogLevel.DEBUG
.- Overrides:
successfulResponseLogLevel
in classLoggingDecoratorBuilder
-
failureResponseLogLevel
Description copied from class:LoggingDecoratorBuilder
Sets theLogLevel
to use when logging failure responses (e.g., failed with an exception). If unset, will useLogLevel.WARN
. The request will be logged too if it was not otherwise.- Overrides:
failureResponseLogLevel
in classLoggingDecoratorBuilder
-
requestLogLevelMapper
public LoggingServiceBuilder requestLogLevelMapper(Function<? super RequestOnlyLog, LogLevel> requestLogLevelMapper) Description copied from class:LoggingDecoratorBuilder
Sets theFunction
to use when mapping the log level of request logs.- Overrides:
requestLogLevelMapper
in classLoggingDecoratorBuilder
-
responseLogLevelMapper
public LoggingServiceBuilder responseLogLevelMapper(Function<? super RequestLog, LogLevel> responseLogLevelMapper) Description copied from class:LoggingDecoratorBuilder
Sets theFunction
to use when mapping the log level of response logs.- Overrides:
responseLogLevelMapper
in classLoggingDecoratorBuilder
-
requestHeadersSanitizer
public LoggingServiceBuilder requestHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> requestHeadersSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize request headers before logging. It is common to have theBiFunction
that removes sensitive headers, likeCookie
, before logging. If unset, will not sanitize request headers.- Overrides:
requestHeadersSanitizer
in classLoggingDecoratorBuilder
-
responseHeadersSanitizer
public LoggingServiceBuilder responseHeadersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> responseHeadersSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize response headers before logging. It is common to have theBiFunction
that removes sensitive headers, likeSet-Cookie
, before logging. If unset, will not sanitize response headers.- Overrides:
responseHeadersSanitizer
in classLoggingDecoratorBuilder
-
requestTrailersSanitizer
public LoggingServiceBuilder requestTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> requestTrailersSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize request trailers before logging. If unset, will not sanitize request trailers.- Overrides:
requestTrailersSanitizer
in classLoggingDecoratorBuilder
-
responseTrailersSanitizer
public LoggingServiceBuilder responseTrailersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> responseTrailersSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize response trailers before logging. If unset, will not sanitize response trailers.- Overrides:
responseTrailersSanitizer
in classLoggingDecoratorBuilder
-
headersSanitizer
public LoggingServiceBuilder headersSanitizer(BiFunction<? super RequestContext, ? super HttpHeaders, ? extends @Nullable Object> headersSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize request, response and trailers before logging. It is common to have theBiFunction
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 classLoggingDecoratorBuilder
- See Also:
-
requestContentSanitizer
public LoggingServiceBuilder requestContentSanitizer(BiFunction<? super RequestContext, Object, ? extends @Nullable Object> requestContentSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize request content before logging. It is common to have theBiFunction
that removes sensitive content, such as an GPS location query, before logging. If unset, will not sanitize request content.- Overrides:
requestContentSanitizer
in classLoggingDecoratorBuilder
-
responseContentSanitizer
public LoggingServiceBuilder responseContentSanitizer(BiFunction<? super RequestContext, Object, ? extends @Nullable Object> responseContentSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize response content before logging. It is common to have theBiFunction
that removes sensitive content, such as an address, before logging. If unset, will not sanitize response content.- Overrides:
responseContentSanitizer
in classLoggingDecoratorBuilder
-
contentSanitizer
public LoggingServiceBuilder contentSanitizer(BiFunction<? super RequestContext, Object, ? extends @Nullable Object> contentSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
to use to sanitize request and response content before logging. It is common to have theBiFunction
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);
-
responseCauseSanitizer
public LoggingServiceBuilder responseCauseSanitizer(BiFunction<? super RequestContext, ? super Throwable, ? extends @Nullable Object> responseCauseSanitizer) Description copied from class:LoggingDecoratorBuilder
Sets theBiFunction
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 returningnull
in theBiFunction
. If unset, will not sanitize a response cause.- Overrides:
responseCauseSanitizer
in classLoggingDecoratorBuilder
-