org.apache.hadoop.hive.ql.log

Class HushableRandomAccessFileAppender

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<org.apache.logging.log4j.core.appender.RandomAccessFileManager>

org.apache.hadoop.hive.ql.log.HushableRandomAccessFileAppender

All Implemented Interfaces:

org.apache.logging.log4j.core.Appender, org.apache.logging.log4j.core.filter.Filterable, org.apache.logging.log4j.core.impl.LocationAware, org.apache.logging.log4j.core.LifeCycle, org.apache.logging.log4j.core.LifeCycle2

@Plugin(name="HushableRandomAccessFile",
        category="Core",
        elementType="appender",
        printObject=true)
public final class HushableRandomAccessFileAppender
extends org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.RandomAccessFileManager>

A File Appender that does not append log records after it has been stopped. Based on https://github.com/apache/logging-log4j2/blob/c02e7de69e81c174f1ea0be43639d9e231fa5283/log4j-core/src/main/java/org/apache/logging/log4j/core/appender/RandomAccessFileAppender.java (which is from log4j 2.6.2)

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender

org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder<B extends org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender.Builder<B>>

Nested classes/interfaces inherited from interface org.apache.logging.log4j.core.LifeCycle

org.apache.logging.log4j.core.LifeCycle.State

Field Summary

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

Modifier and Type	Method and Description
void	append(org.apache.logging.log4j.core.LogEvent event) Write the log entry rolling over the file when required.
static HushableRandomAccessFileAppender	createAppender(String fileName, String append, String name, String immediateFlush, String bufferSizeStr, String ignore, org.apache.logging.log4j.core.Layout<? extends Serializable> layout, org.apache.logging.log4j.core.Filter filter, String advertise, String advertiseURI, org.apache.logging.log4j.core.config.Configuration config) Create a File Appender.
int	getBufferSize() Returns the size of the file manager's buffer.
String	getFileName() Returns the file name this appender is associated with.
void	stop()

Methods inherited from class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender

directEncodeEvent, getImmediateFlush, getManager, start, stop, 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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.logging.log4j.core.LifeCycle

getState, initialize, isStarted, isStopped

Method Detail

stop

public void stop()

Specified by:

stop in interface org.apache.logging.log4j.core.LifeCycle

Overrides:

stop in class org.apache.logging.log4j.core.AbstractLifeCycle

append

public void append(org.apache.logging.log4j.core.LogEvent event)

Write the log entry rolling over the file when required.

Specified by:

append in interface org.apache.logging.log4j.core.Appender

Overrides:

append in class org.apache.logging.log4j.core.appender.AbstractOutputStreamAppender<org.apache.logging.log4j.core.appender.RandomAccessFileManager>

Parameters:

event - The LogEvent.

getFileName

public String getFileName()

Returns the file name this appender is associated with.

Returns:

The File name.

getBufferSize

public int getBufferSize()

Returns the size of the file manager's buffer.

Returns:

the buffer size

createAppender

@PluginFactory
public static HushableRandomAccessFileAppender createAppender(@PluginAttribute(value="fileName")
                                                                             String fileName,
                                                                             @PluginAttribute(value="append")
                                                                             String append,
                                                                             @PluginAttribute(value="name")
                                                                             String name,
                                                                             @PluginAttribute(value="immediateFlush")
                                                                             String immediateFlush,
                                                                             @PluginAttribute(value="bufferSize")
                                                                             String bufferSizeStr,
                                                                             @PluginAttribute(value="ignoreExceptions")
                                                                             String ignore,
                                                                             @PluginElement(value="Layout")
                                                                             org.apache.logging.log4j.core.Layout<? extends Serializable> layout,
                                                                             @PluginElement(value="Filter")
                                                                             org.apache.logging.log4j.core.Filter filter,
                                                                             @PluginAttribute(value="advertise")
                                                                             String advertise,
                                                                             @PluginAttribute(value="advertiseURI")
                                                                             String advertiseURI,
                                                                             @PluginConfiguration
                                                                             org.apache.logging.log4j.core.config.Configuration config)

Create a File Appender.

Parameters:

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".

bufferSizeStr - 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.

Returns:

The FileAppender.