@Plugin(name="MemoryMappedFile", category="Core", elementType="appender", printObject=true) public final class MemoryMappedFileAppender extends AbstractOutputStreamAppender<MemoryMappedFileManager>
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 MemoryMappedFileAppender |
createAppender(String fileName,
String append,
String name,
String immediateFlush,
String regionLengthStr,
String ignore,
Layout<? extends Serializable> layout,
Filter filter,
String advertise,
String advertiseURI,
Configuration config)
Create a Memory Mapped File Appender.
|
String |
getFileName()
Returns the file name this appender is associated with.
|
int |
getRegionLength()
Returns the length of the memory mapped region.
|
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<MemoryMappedFileManager>
public void append(LogEvent event)
append
in interface Appender
append
in class AbstractOutputStreamAppender<MemoryMappedFileManager>
event
- The LogEvent.public String getFileName()
public int getRegionLength()
@PluginFactory public static MemoryMappedFileAppender createAppender(@PluginAttribute(value="fileName") String fileName, @PluginAttribute(value="append") String append, @PluginAttribute(value="name") String name, @PluginAttribute(value="immediateFlush") String immediateFlush, @PluginAttribute(value="regionLength") String regionLengthStr, @PluginAttribute(value="ignoreExceptions") String ignore, @PluginElement(value="Layout") Layout<? extends Serializable> layout, @PluginElement(value="Filter") Filter filter, @PluginAttribute(value="advertise") String advertise, @PluginAttribute(value="advertiseURI") String advertiseURI, @PluginConfiguration Configuration config)
fileName
- The name and path of the file.append
- "True" if the file should be appended to, "false" if it should be overwritten. The default is
"true".name
- The name of the Appender.immediateFlush
- "true" if the contents should be flushed on every write, "false" otherwise. The default is
"true".regionLengthStr
- The buffer size, defaults to .ignore
- If "true"
(default) exceptions encountered when appending events are logged; otherwise they
are propagated to the caller.layout
- The layout to use to format the event. If no layout is provided the default PatternLayout will be
used.filter
- The filter, if any, to use.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.