io.dropwizard.logging

Class AbstractAppenderFactory<E extends ch.qos.logback.core.spi.DeferredProcessingAware>

java.lang.Object

io.dropwizard.logging.AbstractAppenderFactory<E>

All Implemented Interfaces:

Discoverable, AppenderFactory<E>

Direct Known Subclasses:

ConsoleAppenderFactory, FileAppenderFactory, SyslogAppenderFactory

public abstract class AbstractAppenderFactory<E extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends Object
implements AppenderFactory<E>

A base implementation of AppenderFactory.

Configuration Parameters:

Name	Default	Description
threshold	ALL	The minimum event level the appender will handle.
logFormat	(none)	An appender-specific log format.
timeZone	UTC	The time zone to which event timestamps will be converted. Ignored if logFormat is supplied.
queueSize	AsyncAppenderBase	The maximum capacity of the blocking queue.
includeCallerData	AsyncAppenderBase	Whether to include caller data, required for line numbers. Beware, is considered expensive.
discardingThreshold	AsyncAppenderBase	By default, when the blocking queue has 20% capacity remaining, it will drop events of level TRACE, DEBUG and INFO, keeping only events of level WARN and ERROR. To keep all events, set discardingThreshold to 0.
filterFactories	(none)	A list of filters to apply to the appender, in order, after the threshold.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	logFormat
protected ch.qos.logback.classic.Level	threshold
protected TimeZone	timeZone

Constructor Summary

Constructors

Constructor and Description
AbstractAppenderFactory()

Method Summary

Modifier and Type	Method and Description
protected ch.qos.logback.core.pattern.PatternLayoutBase<E>	buildLayout(ch.qos.logback.classic.LoggerContext context, LayoutFactory<E> layoutFactory)
int	getDiscardingThreshold()
com.google.common.collect.ImmutableList<FilterFactory<E>>	getFilterFactories()
String	getLogFormat()
int	getQueueSize()
ch.qos.logback.classic.Level	getThreshold()
TimeZone	getTimeZone()
boolean	isIncludeCallerData()
void	setDiscardingThreshold(int discardingThreshold)
void	setFilterFactories(List<FilterFactory<E>> appenders)
void	setIncludeCallerData(boolean includeCallerData)
void	setLogFormat(String logFormat)
void	setQueueSize(int queueSize)
void	setThreshold(ch.qos.logback.classic.Level threshold)
void	setTimeZone(TimeZone timeZone)
protected ch.qos.logback.core.Appender<E>	wrapAsync(ch.qos.logback.core.Appender<E> appender, AsyncAppenderFactory<E> asyncAppenderFactory)
protected ch.qos.logback.core.Appender<E>	wrapAsync(ch.qos.logback.core.Appender<E> appender, AsyncAppenderFactory<E> asyncAppenderFactory, ch.qos.logback.core.Context context)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.dropwizard.logging.AppenderFactory

build

Field Detail

threshold

@NotNull
protected ch.qos.logback.classic.Level threshold

logFormat

protected String logFormat

timeZone

@NotNull
protected TimeZone timeZone

Constructor Detail

AbstractAppenderFactory

public AbstractAppenderFactory()

Method Detail

getQueueSize

public int getQueueSize()

setQueueSize

public void setQueueSize(int queueSize)

getDiscardingThreshold

public int getDiscardingThreshold()

setDiscardingThreshold

public void setDiscardingThreshold(int discardingThreshold)

getThreshold

public ch.qos.logback.classic.Level getThreshold()

setThreshold

public void setThreshold(ch.qos.logback.classic.Level threshold)

getLogFormat

public String getLogFormat()

setLogFormat

public void setLogFormat(String logFormat)

getTimeZone

public TimeZone getTimeZone()

setTimeZone

public void setTimeZone(TimeZone timeZone)

isIncludeCallerData

public boolean isIncludeCallerData()

setIncludeCallerData

public void setIncludeCallerData(boolean includeCallerData)

getFilterFactories

public com.google.common.collect.ImmutableList<FilterFactory<E>> getFilterFactories()

setFilterFactories

public void setFilterFactories(List<FilterFactory<E>> appenders)

wrapAsync

protected ch.qos.logback.core.Appender<E> wrapAsync(ch.qos.logback.core.Appender<E> appender,
                                                    AsyncAppenderFactory<E> asyncAppenderFactory)

wrapAsync

protected ch.qos.logback.core.Appender<E> wrapAsync(ch.qos.logback.core.Appender<E> appender,
                                                    AsyncAppenderFactory<E> asyncAppenderFactory,
                                                    ch.qos.logback.core.Context context)

buildLayout

protected ch.qos.logback.core.pattern.PatternLayoutBase<E> buildLayout(ch.qos.logback.classic.LoggerContext context,
                                                                       LayoutFactory<E> layoutFactory)