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)	Deprecated. Use LogFormatter to set the sanitizer.
protected LoggingDecoratorBuilder	defaultLogger(Logger logger)	Sets the logger that is used when neither logWriter(LogWriter) nor logger(Logger) is set.
LoggingDecoratorBuilder	failureResponseLogLevel(LogLevel failedResponseLogLevel)	Deprecated. Use LogWriterBuilder.failureResponseLogLevel(LogLevel) instead.
LoggingDecoratorBuilder	headersSanitizer(BiFunction<? super RequestContext,? super HttpHeaders,? extends @Nullable Object> headersSanitizer)	Deprecated. Use LogFormatter to set the sanitizer.
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)	Deprecated. Use LogWriterBuilder.logger(String) instead.
LoggingDecoratorBuilder	logger(Logger logger)	Deprecated. Use LogWriterBuilder.logger(Logger) instead.
protected final LogWriter	logWriter()	Returns LogWriter if set.
LoggingDecoratorBuilder	logWriter(LogWriter logWriter)	Sets the LogWriter which write a RequestOnlyLog or RequestLog.
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)	Deprecated. Use LogFormatter to set the sanitizer.
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)	Deprecated. Use LogFormatter to set the sanitizer.
LoggingDecoratorBuilder	requestLogLevel(LogLevel requestLogLevel)	Deprecated. Use LogWriterBuilder.requestLogLevel(LogLevel) instead.
LoggingDecoratorBuilder	requestLogLevel(Class<? extends Throwable> clazz, LogLevel requestLogLevel)	Deprecated. Use LogWriterBuilder.requestLogLevel(Class, LogLevel) instead.
protected final RequestLogLevelMapper	requestLogLevelMapper()	Returns the RequestLogLevelMapper to use when logging request logs.
LoggingDecoratorBuilder	requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)	Deprecated. Use LogWriterBuilder.requestLogLevelMapper(RequestLogLevelMapper) instead.
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)	Deprecated. Use LogFormatter to set the sanitizer.
LoggingDecoratorBuilder	responseCauseFilter(Predicate<Throwable> responseCauseFilter)	Deprecated. Use LogWriterBuilder.responseCauseFilter(Predicate) instead.
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)	Deprecated. Use LogWriterBuilder.responseCauseFilter(Predicate) instead.
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)	Deprecated. Use LogFormatter to set the sanitizer.
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)	Deprecated. Use LogFormatter to set the sanitizer.
LoggingDecoratorBuilder	responseLogLevel(HttpStatusClass statusClass, LogLevel logLevel)	Deprecated. Use LogWriterBuilder.responseLogLevel(HttpStatusClass, LogLevel) instead.
LoggingDecoratorBuilder	responseLogLevel(HttpStatus status, LogLevel logLevel)	Deprecated. Use LogWriterBuilder.responseLogLevel(HttpStatus, LogLevel) instead.
LoggingDecoratorBuilder	responseLogLevel(Class<? extends Throwable> clazz, LogLevel logLevel)	Deprecated. Use LogWriterBuilder.responseLogLevel(Class, LogLevel) instead.
protected final ResponseLogLevelMapper	responseLogLevelMapper()	Returns the ResponseLogLevelMapper to use when logging response logs.
LoggingDecoratorBuilder	responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)	Deprecated. Use LogWriterBuilder.responseLogLevelMapper(ResponseLogLevelMapper) instead.
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)	Deprecated. Use LogFormatter to set the sanitizer.
LoggingDecoratorBuilder	successfulResponseLogLevel(LogLevel successfulResponseLogLevel)	Deprecated. Use LogWriterBuilder.successfulResponseLogLevel(LogLevel) instead.
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

defaultLogger

protected LoggingDecoratorBuilder defaultLogger(Logger logger)

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

logger

@Deprecated
public LoggingDecoratorBuilder logger(Logger logger)

Deprecated.

Use LogWriterBuilder.logger(Logger) instead.

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

logger

@Deprecated
public LoggingDecoratorBuilder logger(String loggerName)

Deprecated.

Use LogWriterBuilder.logger(String) instead.

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

@Deprecated
public LoggingDecoratorBuilder requestLogLevel(LogLevel requestLogLevel)

Deprecated.

Use LogWriterBuilder.requestLogLevel(LogLevel) instead.

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

requestLogLevel

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

Deprecated.

Use LogWriterBuilder.requestLogLevel(Class, LogLevel) instead.

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

@Deprecated
public LoggingDecoratorBuilder requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)

Deprecated.

Use LogWriterBuilder.requestLogLevelMapper(RequestLogLevelMapper) instead.

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

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

Deprecated.

Use LogWriterBuilder.responseLogLevel(HttpStatus, LogLevel) instead.

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

responseLogLevel

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

Deprecated.

Use LogWriterBuilder.responseLogLevel(HttpStatusClass, LogLevel) instead.

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

responseLogLevel

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

Deprecated.

Use LogWriterBuilder.responseLogLevel(Class, LogLevel) instead.

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

successfulResponseLogLevel

@Deprecated
public LoggingDecoratorBuilder successfulResponseLogLevel(LogLevel successfulResponseLogLevel)

Deprecated.

Use LogWriterBuilder.successfulResponseLogLevel(LogLevel) instead.

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

failureResponseLogLevel

@Deprecated
public LoggingDecoratorBuilder failureResponseLogLevel(LogLevel failedResponseLogLevel)

Deprecated.

Use LogWriterBuilder.failureResponseLogLevel(LogLevel) instead.

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

@Deprecated
public LoggingDecoratorBuilder responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)

Deprecated.

Use LogWriterBuilder.responseLogLevelMapper(ResponseLogLevelMapper) instead.

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

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

Deprecated.

Use LogFormatter to set the sanitizer.

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.

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

requestHeadersSanitizer

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

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

responseHeadersSanitizer

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

Deprecated.

Use LogFormatter to set the sanitizer.

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.

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

responseHeadersSanitizer

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

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

requestTrailersSanitizer

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

Deprecated.

Use LogFormatter to set the sanitizer.

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

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

requestTrailersSanitizer

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

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

responseTrailersSanitizer

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

Deprecated.

Use LogFormatter to set the sanitizer.

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

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

responseTrailersSanitizer

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

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

headersSanitizer

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

Deprecated.

Use LogFormatter to set the sanitizer.

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

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

See Also:

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

requestContentSanitizer

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

Deprecated.

Use LogFormatter to set the sanitizer.

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.

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

requestContentSanitizer

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

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

responseContentSanitizer

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

Deprecated.

Use LogFormatter to set the sanitizer.

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.

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

responseContentSanitizer

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

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

contentSanitizer

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

Deprecated.

Use LogFormatter to set the sanitizer.

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

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

See Also:

• requestContentSanitizer(BiFunction)
• responseContentSanitizer(BiFunction)

responseCauseSanitizer

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

Deprecated.

Use LogWriterBuilder.responseCauseFilter(Predicate) instead.

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.

Throws:

IllegalStateException - If both the log sanitizers and the LogFormatter are specified.

responseCauseSanitizer

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

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

responseCauseFilter

@Deprecated
public LoggingDecoratorBuilder responseCauseFilter(Predicate<Throwable> responseCauseFilter)

Deprecated.

Use LogWriterBuilder.responseCauseFilter(Predicate) instead.

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.

logWriter

@UnstableApi
public LoggingDecoratorBuilder logWriter(LogWriter logWriter)

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

Throws:

IllegalStateException - If both the log sanitizers and the LogWriter are specified.

logWriter

protected final LogWriter logWriter()

Returns LogWriter if set.

toString

public String toString()

Overrides:

toString in class Object