alluxio

Class AlluxioRemoteLogFilter

java.lang.Object

org.apache.log4j.spi.Filter

alluxio.AlluxioRemoteLogFilter

All Implemented Interfaces:

org.apache.log4j.spi.OptionHandler

public class AlluxioRemoteLogFilter
extends org.apache.log4j.spi.Filter

Thin filter to add MDC information to LoggingEvent. Remote log server can read LoggingEvent off Socket and retrieve the MDC information. In this case the MDC information is the name of the log4j appender. Remote log server then uses this appender to log messages. The implementation of this class is similar to that of org.apache.log4j.varia.StringMatchFilter.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROCESS_TYPE_OPTION Deprecated. Option name to configure this AlluxioRemoteLogFilter in log4j.properties.
static String	REMOTE_LOG_MDC_PROCESS_TYPE_KEY Name (Key) of the MDC info.

Fields inherited from class org.apache.log4j.spi.Filter

ACCEPT, DENY, NEUTRAL, next

Constructor Summary

Constructors

Constructor and Description
AlluxioRemoteLogFilter()

Method Summary

Modifier and Type	Method and Description
int	decide(org.apache.log4j.spi.LoggingEvent event)
String[]	getOptionStrings() Deprecated. Gets the option strings.
String	getProcessType() Retrieves the string representation of process type.
void	setOption(String key, String value) Deprecated. Sets option value use key=value format. The log4j.properties file uses this to set options. See the log4j.properties for more details.
void	setProcessType(String processType) Sets mProcessType to be the type of the process generating this log message.

Methods inherited from class org.apache.log4j.spi.Filter

activateOptions, getNext, setNext

Methods inherited from class java.lang.Object

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

Field Detail

REMOTE_LOG_MDC_PROCESS_TYPE_KEY

public static final String REMOTE_LOG_MDC_PROCESS_TYPE_KEY

Name (Key) of the MDC info.

See Also:

Constant Field Values

PROCESS_TYPE_OPTION

@Deprecated
public static final String PROCESS_TYPE_OPTION

Deprecated. Option name to configure this AlluxioRemoteLogFilter in log4j.properties.

See Also:

Constant Field Values

Constructor Detail

AlluxioRemoteLogFilter

public AlluxioRemoteLogFilter()

Method Detail

getOptionStrings

@Deprecated
public String[] getOptionStrings()

Deprecated. Gets the option strings.

Returns:

option strings as an array

setOption

@Deprecated
public void setOption(String key,
                                  String value)

Deprecated. Sets option value use key=value format. The log4j.properties file uses this to set options. See the log4j.properties for more details.

Parameters:

key - key (name) of the option

value - value of the option

setProcessType

public void setProcessType(String processType)

Sets mProcessType to be the type of the process generating this log message. Log4j parses log4j.properties, extracting the Java class that corresponds to the filter. In this case, the Java class is AlluxioRemoteLogFilter. Log4j also extracts option information as a key-value pair, e.g. "ProcessType" : "MASTER". Then log4j invokes the setProcessType(String) method to set the value of mProcessType.

Parameters:

processType - name of the log appender

getProcessType

public String getProcessType()

Retrieves the string representation of process type. This method can potentially be called by log4j reflectively. Even if currently log4j does not call it, it is possible to be called in the future. Therefore, to be consistent with org.apache.log4j.varia.StringMatchFilter, we should prevent this method from been removed.

Returns:

the name of the log appender

decide

public int decide(org.apache.log4j.spi.LoggingEvent event)

Specified by:

decide in class org.apache.log4j.spi.Filter