io.dropwizard.logging

Class FileAppenderFactory

java.lang.Object

io.dropwizard.logging.AbstractAppenderFactory

io.dropwizard.logging.FileAppenderFactory

All Implemented Interfaces:

Discoverable, AppenderFactory

public class FileAppenderFactory
extends AbstractAppenderFactory

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. %d is replaced with the date in yyyy-MM-dd form, and the fact that it ends with .gz indicates the file will be gzipped as it's archived. Likewise, filename patterns which end in .zip will be filled as they are archived.
archivedFileCount	5	The number of archived files to keep. Must be greater than 0.
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

Constructor Summary

Constructors

Constructor and Description
FileAppenderFactory()

Method Summary

Methods

Modifier and Type	Method and Description
ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>	build(ch.qos.logback.classic.LoggerContext context, String applicationName, ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout) Given a Logback context, an application name, and a layout, build a new appender.
protected ch.qos.logback.core.FileAppender<ch.qos.logback.classic.spi.ILoggingEvent>	buildAppender(ch.qos.logback.classic.LoggerContext context)
int	getArchivedFileCount()
String	getArchivedLogFilenamePattern()
String	getCurrentLogFilename()
TimeZone	getTimeZone()
boolean	isArchive()
boolean	isValidArchiveConfiguration()
void	setArchive(boolean archive)
void	setArchivedFileCount(int archivedFileCount)
void	setArchivedLogFilenamePattern(String archivedLogFilenamePattern)
void	setCurrentLogFilename(String currentLogFilename)
void	setTimeZone(TimeZone timeZone)

Methods inherited from class io.dropwizard.logging.AbstractAppenderFactory

addThresholdFilter, buildLayout, getBatchDuration, getBatchSize, getLogFormat, getThreshold, isBounded, setBatchDuration, setBatchSize, setBounded, setLogFormat, setThreshold, 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)

getTimeZone

public TimeZone getTimeZone()

setTimeZone

public void setTimeZone(TimeZone timeZone)

isValidArchiveConfiguration

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

build

public ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent> build(ch.qos.logback.classic.LoggerContext context,
                                                                           String applicationName,
                                                                           ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout)

Description copied from interface: AppenderFactory

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

Parameters:

context - the Logback context

applicationName - the application name

layout - the layout for logging

Returns:

a new, started Appender

buildAppender

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