Package com.linecorp.armeria.common.logging

Class LoggingDecoratorBuilder

java.lang.Object

com.linecorp.armeria.common.logging.LoggingDecoratorBuilder

Direct Known Subclasses:

LoggingClientBuilder, LoggingRpcClientBuilder, LoggingServiceBuilder

public abstract class LoggingDecoratorBuilder
extends Object

Builds a new logging decorator.

Constructor Summary

Constructors

Constructor	Description
LoggingDecoratorBuilder()

Method Summary

Modifier and Type	Method	Description
LoggingDecoratorBuilder	contentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> contentSanitizer)	Sets the BiFunction to use to sanitize request and response content before logging.
LoggingDecoratorBuilder	failureResponseLogLevel(LogLevel failedResponseLogLevel)	Sets the LogLevel to use when logging failure responses (e.g., failed with an exception).
LoggingDecoratorBuilder	headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> headersSanitizer)	Sets the BiFunction to use to sanitize request, response and trailers before logging.
protected final @Nullable Logger	logger()	Returns the Logger the user specified to use, or null if not set and a default logger should be used.
LoggingDecoratorBuilder	logger(String loggerName)	Sets the name of the Logger to use when logging.
LoggingDecoratorBuilder	logger(Logger logger)	Sets the Logger to use when logging.
protected final BiFunction<? super RequestContext,Object,? extends @Nullable Object>	requestContentSanitizer()	Returns the BiFunction to use to sanitize request content before logging.
LoggingDecoratorBuilder	requestContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> requestContentSanitizer)	Sets the BiFunction to use to sanitize request content before logging.
protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object>	requestHeadersSanitizer()	Returns the BiFunction to use to sanitize request headers before logging.
LoggingDecoratorBuilder	requestHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestHeadersSanitizer)	Sets the BiFunction to use to sanitize request headers before logging.
LoggingDecoratorBuilder	requestLogLevel(LogLevel requestLogLevel)	Sets the LogLevel to use when logging requests.
LoggingDecoratorBuilder	requestLogLevel(Class<? extends Throwable> clazz, LogLevel requestLogLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
protected final RequestLogLevelMapper	requestLogLevelMapper()	Returns the RequestLogLevelMapper to use when logging request logs.
LoggingDecoratorBuilder	requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)	Sets the RequestLogLevelMapper to use when mapping the log level of request logs.
LoggingDecoratorBuilder	requestLogLevelMapper(Function<? super RequestOnlyLog,LogLevel> requestLogLevelMapper)	Deprecated. Use requestLogLevelMapper(RequestLogLevelMapper) instead.
protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object>	requestTrailersSanitizer()	Returns the BiFunction to use to sanitize request trailers before logging.
LoggingDecoratorBuilder	requestTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestTrailersSanitizer)	Sets the BiFunction to use to sanitize request trailers before logging.
protected final BiFunction<? super RequestContext,? super Throwable,? extends @Nullable Object>	responseCauseSanitizer()	Returns the BiFunction to use to sanitize response cause before logging.
LoggingDecoratorBuilder	responseCauseSanitizer(BiFunction<? super RequestContext,? super Throwable,? extends @Nullable Object> responseCauseSanitizer)	Sets the BiFunction to use to sanitize a response cause before logging.
protected final BiFunction<? super RequestContext,Object,? extends @Nullable Object>	responseContentSanitizer()	Returns the BiFunction to use to sanitize response content before logging.
LoggingDecoratorBuilder	responseContentSanitizer(BiFunction<? super RequestContext,Object,? extends @Nullable Object> responseContentSanitizer)	Sets the BiFunction to use to sanitize response content before logging.
protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object>	responseHeadersSanitizer()	Returns the BiFunction to use to sanitize response headers before logging.
LoggingDecoratorBuilder	responseHeadersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseHeadersSanitizer)	Sets the BiFunction to use to sanitize response headers before logging.
LoggingDecoratorBuilder	responseLogLevel(HttpStatusClass statusClass, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status belongs to the specified HttpStatusClass.
LoggingDecoratorBuilder	responseLogLevel(HttpStatus status, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status is equal to the specified HttpStatus.
LoggingDecoratorBuilder	responseLogLevel(Class<? extends Throwable> clazz, LogLevel logLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
protected final ResponseLogLevelMapper	responseLogLevelMapper()	Returns the ResponseLogLevelMapper to use when logging response logs.
LoggingDecoratorBuilder	responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)	Sets the ResponseLogLevelMapper to use when mapping the log level of response logs.
LoggingDecoratorBuilder	responseLogLevelMapper(Function<? super RequestLog,LogLevel> responseLogLevelMapper)	Deprecated. Use responseLogLevelMapper(ResponseLogLevelMapper) instead.
protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object>	responseTrailersSanitizer()	Returns the Function to use to sanitize response trailers before logging.
LoggingDecoratorBuilder	responseTrailersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseTrailersSanitizer)	Sets the BiFunction to use to sanitize response trailers before logging.
LoggingDecoratorBuilder	successfulResponseLogLevel(LogLevel successfulResponseLogLevel)	Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception).
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

LoggingDecoratorBuilder

public LoggingDecoratorBuilder()

Method Details

logger

public LoggingDecoratorBuilder logger(Logger logger)

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

logger

public LoggingDecoratorBuilder logger(String loggerName)

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

logger

@Nullable
protected final @Nullable Logger logger()

Returns the Logger the user specified to use, or null if not set and a default logger should be used.

requestLogLevel

public LoggingDecoratorBuilder requestLogLevel(LogLevel requestLogLevel)

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

requestLogLevel

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

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

requestLogLevelMapper

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

Deprecated.

Use requestLogLevelMapper(RequestLogLevelMapper) instead.

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

requestLogLevelMapper

@UnstableApi
public LoggingDecoratorBuilder requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)

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

requestLogLevelMapper

protected final RequestLogLevelMapper requestLogLevelMapper()

Returns the RequestLogLevelMapper to use when logging request logs.

responseLogLevel

@UnstableApi
public LoggingDecoratorBuilder responseLogLevel(HttpStatus status,
 LogLevel logLevel)

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

responseLogLevel

@UnstableApi
public LoggingDecoratorBuilder responseLogLevel(HttpStatusClass statusClass,
 LogLevel logLevel)

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

responseLogLevel

@UnstableApi
public LoggingDecoratorBuilder responseLogLevel(Class<? extends Throwable> clazz,
 LogLevel logLevel)

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

successfulResponseLogLevel

public LoggingDecoratorBuilder successfulResponseLogLevel(LogLevel successfulResponseLogLevel)

Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception). LogLevel.DEBUG will be used by default.

failureResponseLogLevel

public LoggingDecoratorBuilder failureResponseLogLevel(LogLevel failedResponseLogLevel)

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

responseLogLevelMapper

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

Deprecated.

Use responseLogLevelMapper(ResponseLogLevelMapper) instead.

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

responseLogLevelMapper

@UnstableApi
public LoggingDecoratorBuilder responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)

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

responseLogLevelMapper

protected final ResponseLogLevelMapper responseLogLevelMapper()

Returns the ResponseLogLevelMapper to use when logging response logs.

requestHeadersSanitizer

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

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.

requestHeadersSanitizer

protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestHeadersSanitizer()

Returns the BiFunction to use to sanitize request headers before logging.

responseHeadersSanitizer

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

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.

responseHeadersSanitizer

protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseHeadersSanitizer()

Returns the BiFunction to use to sanitize response headers before logging.

requestTrailersSanitizer

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

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

requestTrailersSanitizer

protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> requestTrailersSanitizer()

Returns the BiFunction to use to sanitize request trailers before logging.

responseTrailersSanitizer

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

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

responseTrailersSanitizer

protected final BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> responseTrailersSanitizer()

Returns the Function to use to sanitize response trailers before logging.

headersSanitizer

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

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);
 

See Also:

• requestHeadersSanitizer(BiFunction)
• requestTrailersSanitizer(BiFunction)
• responseHeadersSanitizer(BiFunction)
• responseTrailersSanitizer(BiFunction)

requestContentSanitizer

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

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.

requestContentSanitizer

protected final BiFunction<? super RequestContext,Object,? extends @Nullable Object> requestContentSanitizer()

Returns the BiFunction to use to sanitize request content before logging.

responseContentSanitizer

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

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.

responseContentSanitizer

protected final BiFunction<? super RequestContext,Object,? extends @Nullable Object> responseContentSanitizer()

Returns the BiFunction to use to sanitize response content before logging.

contentSanitizer

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

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);
 

See Also:

• requestContentSanitizer(BiFunction)
• responseContentSanitizer(BiFunction)

responseCauseSanitizer

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

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.

responseCauseSanitizer

protected final BiFunction<? super RequestContext,? super Throwable,? extends @Nullable Object> responseCauseSanitizer()

Returns the BiFunction to use to sanitize response cause before logging.

toString

public String toString()

Overrides:

toString in class Object