Package com.linecorp.armeria.common.logging

Class LogWriterBuilder

java.lang.Object

com.linecorp.armeria.common.logging.LogWriterBuilder

@UnstableApi
public final class LogWriterBuilder
extends Object

Builds a new LogWriter.

Method Summary

Modifier and Type	Method	Description
LogWriter	build()	Returns a newly-created LogWriter based on the properties of this builder.
LogWriterBuilder	failureResponseLogLevel(LogLevel failedResponseLogLevel)	Sets the LogLevel to use when logging failure responses (e.g., failed with an exception).
LogWriterBuilder	logFormatter(LogFormatter logFormatter)	Sets the LogFormatter which converts a RequestOnlyLog or RequestLog into a log message.
LogWriterBuilder	logger(String loggerName)	Sets the name of the Logger to use when logging.
LogWriterBuilder	logger(Logger logger)	Sets the Logger to use when logging.
LogWriterBuilder	requestLogLevel(LogLevel requestLogLevel)	Sets the LogLevel to use when logging requests.
LogWriterBuilder	requestLogLevel(Class<? extends Throwable> clazz, LogLevel requestLogLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
LogWriterBuilder	requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)	Sets the RequestLogLevelMapper to use when mapping the log level of request logs.
LogWriterBuilder	responseCauseFilter(Predicate<? super Throwable> responseCauseFilter)	Sets the Predicate used for evaluating whether to log the response cause or not.
LogWriterBuilder	responseLogLevel(HttpStatusClass statusClass, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status belongs to the specified HttpStatusClass.
LogWriterBuilder	responseLogLevel(HttpStatus status, LogLevel logLevel)	Sets the LogLevel to use when logging responses whose status is equal to the specified HttpStatus.
LogWriterBuilder	responseLogLevel(Class<? extends Throwable> clazz, LogLevel logLevel)	Sets the LogLevel to use when the response fails with the specified Throwable.
LogWriterBuilder	responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)	Sets the ResponseLogLevelMapper to use when mapping the log level of response logs.
LogWriterBuilder	successfulResponseLogLevel(LogLevel successfulResponseLogLevel)	Sets the LogLevel to use when logging successful responses (e.g., no unhandled exception).

Methods inherited from class java.lang.Object

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

Method Details

logger

public LogWriterBuilder logger(Logger logger)

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

logger

public LogWriterBuilder logger(String loggerName)

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

requestLogLevel

public LogWriterBuilder requestLogLevel(LogLevel requestLogLevel)

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

requestLogLevel

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

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

requestLogLevelMapper

public LogWriterBuilder requestLogLevelMapper(RequestLogLevelMapper requestLogLevelMapper)

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

responseLogLevel

public LogWriterBuilder responseLogLevel(HttpStatus status,
 LogLevel logLevel)

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

responseLogLevel

public LogWriterBuilder responseLogLevel(HttpStatusClass statusClass,
 LogLevel logLevel)

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

responseLogLevel

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

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

successfulResponseLogLevel

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

public LogWriterBuilder responseLogLevelMapper(ResponseLogLevelMapper responseLogLevelMapper)

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

responseCauseFilter

public LogWriterBuilder responseCauseFilter(Predicate<? super Throwable> responseCauseFilter)

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.

logFormatter

public LogWriterBuilder logFormatter(LogFormatter logFormatter)

Sets the LogFormatter which converts a RequestOnlyLog or RequestLog into a log message. By default LogFormatter.ofText() will be used.

Throws:

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

build

public LogWriter build()

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