@Plugin(name="File", category="Core", elementType="appender", printObject=true) public final class FileAppender extends AbstractOutputStreamAppender<FileManager>
| Modifier and Type | Class and Description |
|---|---|
static class |
FileAppender.Builder<B extends FileAppender.Builder<B>>
Builds FileAppender instances.
|
LifeCycle.State| Modifier and Type | Field and Description |
|---|---|
static String |
PLUGIN_NAME |
DEFAULT_STOP_TIMEOUT, DEFAULT_STOP_TIMEUNIT, LOGGERELEMENT_TYPE| Modifier and Type | Method and Description |
|---|---|
static <B extends FileAppender.Builder<B>> |
createAppender(String fileName,
String append,
String locking,
String name,
String immediateFlush,
String ignoreExceptions,
String bufferedIo,
String bufferSizeStr,
Layout<? extends Serializable> layout,
Filter filter,
String advertise,
String advertiseUri,
Configuration config)
Deprecated.
Use
newBuilder() |
String |
getFileName()
Returns the file name this appender is associated with.
|
static <B extends FileAppender.Builder<B>> |
newBuilder() |
boolean |
stop(long timeout,
TimeUnit timeUnit)
Cleanup the Filter.
|
append, directEncodeEvent, getImmediateFlush, getManager, start, stop, writeByteArrayToManagererror, error, error, getHandler, getLayout, getName, ignoreExceptions, parseInt, requiresLocation, setHandler, toSerializable, toStringaddFilter, getFilter, getPropertyArray, hasFilter, isFiltered, removeFilterequalsImpl, getState, getStatusLogger, hashCodeImpl, initialize, isInitialized, isStarted, isStarting, isStopped, isStopping, setStarted, setStarting, setState, setStopped, setStopping, stop, stoppublic static final String PLUGIN_NAME
@Deprecated public static <B extends FileAppender.Builder<B>> FileAppender createAppender(String fileName, String append, String locking, String name, String immediateFlush, String ignoreExceptions, String bufferedIo, String bufferSizeStr, Layout<? extends Serializable> layout, Filter filter, String advertise, String advertiseUri, Configuration config)
newBuilder()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".locking - "True" if the file should be locked. The default is "false".name - The name of the Appender.immediateFlush - "true" if the contents should be flushed on every write, "false" otherwise. The default
is "true".ignoreExceptions - If "true" (default) exceptions encountered when appending events are logged; otherwise
they are propagated to the caller.bufferedIo - "true" if I/O should be buffered, "false" otherwise. The default is "true".bufferSizeStr - buffer size for buffered IO (default is 8192).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@PluginBuilderFactory public static <B extends FileAppender.Builder<B>> B newBuilder()
public String getFileName()
public boolean stop(long timeout, TimeUnit timeUnit)
AbstractFilterablestop in interface LifeCycle2stop in class AbstractOutputStreamAppender<FileManager>timeout - the maximum time to waittimeUnit - the time unit of the timeout argumentCopyright © 1999-2021 The 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.