@Plugin(name="RollingFile", category="Core", elementType="appender", printObject=true) public final class RollingFileAppender extends AbstractOutputStreamAppender<RollingFileManager>
LifeCycle.State
immediateFlush
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGER
Modifier and Type | Method and Description |
---|---|
void |
append(LogEvent event)
Write the log entry rolling over the file when required.
|
static 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)
Create a RollingFileAppender.
|
String |
getFileName()
Returns the File name for the Appender.
|
String |
getFilePattern()
Returns the file pattern used when rolling over.
|
void |
stop()
Cleanup the Filter.
|
getManager, start
error, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, setHandler, toString
addFilter, getFilter, hasFilter, isFiltered, removeFilter
equalsImpl, getState, hashCodeImpl, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping
public void stop()
AbstractFilterable
stop
in interface LifeCycle
stop
in class AbstractOutputStreamAppender<RollingFileManager>
public void append(LogEvent event)
append
in interface Appender
append
in class AbstractOutputStreamAppender<RollingFileManager>
event
- The LogEvent.public String getFileName()
public String getFilePattern()
@PluginFactory public static RollingFileAppender createAppender(@PluginAttribute(value="fileName") String fileName, @PluginAttribute(value="filePattern") String filePattern, @PluginAttribute(value="append") String append, @PluginAttribute(value="name") String name, @PluginAttribute(value="bufferedIO") String bufferedIO, @PluginAttribute(value="bufferSize") String bufferSizeStr, @PluginAttribute(value="immediateFlush") String immediateFlush, @PluginElement(value="Policy") TriggeringPolicy policy, @PluginElement(value="Strategy") RolloverStrategy strategy, @PluginElement(value="Layout") Layout<? extends Serializable> layout, @PluginElement(value="Filter") Filter filter, @PluginAttribute(value="ignoreExceptions") String ignore, @PluginAttribute(value="advertise") String advertise, @PluginAttribute(value="advertiseURI") String advertiseURI, @PluginConfiguration Configuration config)
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.Copyright © 1999-2021 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.