Class RollingFileAppender
- java.lang.Object
-
- org.apache.logging.log4j.core.AbstractLifeCycle
-
- org.apache.logging.log4j.core.filter.AbstractFilterable
-
- org.apache.logging.log4j.core.appender.AbstractAppender
-
- org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<RollingFileManager>
-
- org.apache.logging.log4j.core.appender.RollingFileAppender
-
- All Implemented Interfaces:
Appender
,Filterable
,LocationAware
,LifeCycle
,LifeCycle2
@Plugin(name="RollingFile", category="Core", elementType="appender", printObject=true) public final class RollingFileAppender extends AbstractOutputStreamAppender<RollingFileManager>
An appender that writes to files and can roll over at intervals.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
RollingFileAppender.Builder<B extends RollingFileAppender.Builder<B>>
Builds FileAppender instances.-
Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle
LifeCycle.State
-
-
Field Summary
Fields Modifier and Type Field Description static String
PLUGIN_NAME
-
Fields inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
-
Fields inherited from interface org.apache.logging.log4j.core.Appender
ELEMENT_TYPE
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
append(LogEvent event)
Writes the log entry rolling over the file when required.static <B extends RollingFileAppender.Builder<B>>
RollingFileAppendercreateAppender(String fileName, String filePattern, String append, String name, String bufferedIO, String bufferSizeStr, String immediateFlush, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignore, String advertise, String advertiseUri, Configuration config)
Deprecated.UsenewBuilder()
.String
getFileName()
Returns the File name for the Appender.String
getFilePattern()
Returns the file pattern used when rolling over.<T extends TriggeringPolicy>
TgetTriggeringPolicy()
Returns the triggering policy.static <B extends RollingFileAppender.Builder<B>>
BnewBuilder()
Creates a new Builder.boolean
stop(long timeout, TimeUnit timeUnit)
Cleanup the Filter.-
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender
directEncodeEvent, getImmediateFlush, getManager, start, stop, writeByteArrayToManager
-
Methods inherited from class org.apache.logging.log4j.core.appender.AbstractAppender
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toString
-
Methods inherited from class org.apache.logging.log4j.core.filter.AbstractFilterable
addFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilter
-
Methods inherited from class org.apache.logging.log4j.core.AbstractLifeCycle
equalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stop
-
-
-
-
Field Detail
-
PLUGIN_NAME
public static final String PLUGIN_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
stop
public boolean stop(long timeout, TimeUnit timeUnit)
Description copied from class:AbstractFilterable
Cleanup the Filter.- Specified by:
stop
in interfaceLifeCycle2
- Overrides:
stop
in classAbstractOutputStreamAppender<RollingFileManager>
- Parameters:
timeout
- the maximum time to waittimeUnit
- the time unit of the timeout argument- Returns:
- true if the receiver was stopped cleanly and normally, false otherwise.
-
append
public void append(LogEvent event)
Writes the log entry rolling over the file when required.- Specified by:
append
in interfaceAppender
- Overrides:
append
in classAbstractOutputStreamAppender<RollingFileManager>
- Parameters:
event
- The LogEvent.
-
getFileName
public String getFileName()
Returns the File name for the Appender.- Returns:
- The file name.
-
getFilePattern
public String getFilePattern()
Returns the file pattern used when rolling over.- Returns:
- The file pattern.
-
getTriggeringPolicy
public <T extends TriggeringPolicy> T getTriggeringPolicy()
Returns the triggering policy.- Type Parameters:
T
- TriggeringPolicy type- Returns:
- The TriggeringPolicy
-
createAppender
@Deprecated public static <B extends RollingFileAppender.Builder<B>> RollingFileAppender createAppender(String fileName, String filePattern, String append, String name, String bufferedIO, String bufferSizeStr, String immediateFlush, TriggeringPolicy policy, RolloverStrategy strategy, Layout<? extends Serializable> layout, Filter filter, String ignore, String advertise, String advertiseUri, Configuration config)
Deprecated.UsenewBuilder()
.Creates a RollingFileAppender.- Parameters:
fileName
- The name of the file that is actively written to. (required).filePattern
- The pattern of the file name to use on rollover. (required).append
- If true, events are appended to the file. If false, the file is overwritten when opened. Defaults to "true"name
- The name of the Appender (required).bufferedIO
- When true, I/O will be buffered. Defaults to "true".bufferSizeStr
- buffer size for buffered IO (default is 8192).immediateFlush
- When true, events are immediately flushed. Defaults to "true".policy
- The triggering policy. (required).strategy
- The rollover strategy. Defaults to DefaultRolloverStrategy.layout
- The layout to use (defaults to the default PatternLayout).filter
- The Filter or null.ignore
- If"true"
(default) exceptions encountered when appending events are logged; otherwise they are propagated to the caller.advertise
- "true" if the appender configuration should be advertised, "false" otherwise.advertiseUri
- The advertised URI which can be used to retrieve the file contents.config
- The Configuration.- Returns:
- A RollingFileAppender.
-
newBuilder
@PluginBuilderFactory public static <B extends RollingFileAppender.Builder<B>> B newBuilder()
Creates a new Builder.- Returns:
- a new Builder.
- Since:
- 2.7
-
-