io.dropwizard.logging

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

java.lang.Object

io.dropwizard.logging.AbstractAppenderFactory<E>

io.dropwizard.logging.FileAppenderFactory<E>

All Implemented Interfaces:

Discoverable, AppenderFactory<E>

public class FileAppenderFactory<E extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends AbstractAppenderFactory<E>

An AppenderFactory implementation which provides an appender that writes events to a file, archiving older files as it goes.

Configuration Parameters:

Name	Default	Description
type	REQUIRED	The appender type. Must be file.
threshold	ALL	The lowest level of events to write to the file.
currentLogFilename	REQUIRED	The filename where current events are logged.
archive	true	Whether or not to archive old events in separate files.
archivedLogFilenamePattern	REQUIRED if archive is true.	The filename pattern for archived files. If maxFileSize is specified, rollover is size-based, and the pattern must contain %i for an integer index of the archived file. Otherwise rollover is date-based, and the pattern must contain %d, which is replaced with the date in yyyy-MM-dd form. If the pattern ends with .gz or .zip, files will be compressed as they are archived.
archivedFileCount	5	The number of archived files to keep. Must be greater than or equal to 0. Zero is a special value signifying to keep infinite logs (use with caution)
maxFileSize	(unlimited)	The maximum size of the currently active file before a rollover is triggered. The value can be expressed in bytes, kilobytes, megabytes, gigabytes, and terabytes by appending B, K, MB, GB, or TB to the numeric value. Examples include 100MB, 1GB, 1TB. Sizes can also be spelled out, such as 100 megabytes, 1 gigabyte, 1 terabyte.
timeZone	UTC	The time zone to which event timestamps will be converted.
logFormat	the default format	The Logback pattern with which events will be formatted. See the Logback documentation for details.

See Also:

AbstractAppenderFactory

Field Summary

Fields inherited from class io.dropwizard.logging.AbstractAppenderFactory

logFormat, threshold, timeZone

Constructor Summary

Constructors

Constructor and Description
FileAppenderFactory()

Method Summary

Modifier and Type	Method and Description
ch.qos.logback.core.Appender<E>	build(ch.qos.logback.classic.LoggerContext context, String applicationName, LayoutFactory<E> layoutFactory, LevelFilterFactory<E> levelFilterFactory, AsyncAppenderFactory<E> asyncAppenderFactory) Given a Logback context, an application name, a layout, a levelFilterFactory, and an asyncAppenderFactory build a new appender.
protected ch.qos.logback.core.FileAppender<E>	buildAppender(ch.qos.logback.classic.LoggerContext context)
int	getArchivedFileCount()
String	getArchivedLogFilenamePattern()
String	getCurrentLogFilename()
io.dropwizard.util.Size	getMaxFileSize()
boolean	isArchive()
boolean	isMaxFileSizeSettingSpecified()
boolean	isValidArchiveConfiguration()
boolean	isValidFileConfiguration()
boolean	isValidForMaxFileSizeSetting()
void	setArchive(boolean archive)
void	setArchivedFileCount(int archivedFileCount)
void	setArchivedLogFilenamePattern(String archivedLogFilenamePattern)
void	setCurrentLogFilename(String currentLogFilename)
void	setMaxFileSize(io.dropwizard.util.Size maxFileSize)

Methods inherited from class io.dropwizard.logging.AbstractAppenderFactory

buildLayout, getDiscardingThreshold, getFilterFactories, getLogFormat, getQueueSize, getThreshold, getTimeZone, isIncludeCallerData, setDiscardingThreshold, setFilterFactories, setIncludeCallerData, setLogFormat, setQueueSize, setThreshold, setTimeZone, wrapAsync, wrapAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

FileAppenderFactory

public FileAppenderFactory()

Method Detail

getCurrentLogFilename

public String getCurrentLogFilename()

setCurrentLogFilename

public void setCurrentLogFilename(String currentLogFilename)

isArchive

public boolean isArchive()

setArchive

public void setArchive(boolean archive)

getArchivedLogFilenamePattern

public String getArchivedLogFilenamePattern()

setArchivedLogFilenamePattern

public void setArchivedLogFilenamePattern(String archivedLogFilenamePattern)

getArchivedFileCount

public int getArchivedFileCount()

setArchivedFileCount

public void setArchivedFileCount(int archivedFileCount)

getMaxFileSize

public io.dropwizard.util.Size getMaxFileSize()

setMaxFileSize

public void setMaxFileSize(io.dropwizard.util.Size maxFileSize)

isValidArchiveConfiguration

@ValidationMethod(message="must have archivedLogFilenamePattern if archive is true")
public boolean isValidArchiveConfiguration()

isValidForMaxFileSizeSetting

@ValidationMethod(message="when specifying maxFileSize, archivedLogFilenamePattern must contain %i")
public boolean isValidForMaxFileSizeSetting()

isMaxFileSizeSettingSpecified

@ValidationMethod(message="when archivedLogFilenamePattern contains %i, maxFileSize must be specified")
public boolean isMaxFileSizeSettingSpecified()

isValidFileConfiguration

@ValidationMethod(message="currentLogFilename can only be null when archiving is enabled")
public boolean isValidFileConfiguration()

build

public ch.qos.logback.core.Appender<E> build(ch.qos.logback.classic.LoggerContext context,
                                             String applicationName,
                                             LayoutFactory<E> layoutFactory,
                                             LevelFilterFactory<E> levelFilterFactory,
                                             AsyncAppenderFactory<E> asyncAppenderFactory)

Description copied from interface: AppenderFactory

Given a Logback context, an application name, a layout, a levelFilterFactory, and an asyncAppenderFactory build a new appender.

Parameters:

context - the Logback context

applicationName - the application name

layoutFactory - the factory for the layout for logging

levelFilterFactory - the factory for the level filter

asyncAppenderFactory - the factory for the async appender

Returns:

a new, started Appender

buildAppender

protected ch.qos.logback.core.FileAppender<E> buildAppender(ch.qos.logback.classic.LoggerContext context)