org.apache.oozie.util

Class XLogFilter

java.lang.Object

org.apache.oozie.util.XLogFilter

public class XLogFilter
extends java.lang.Object

Filter that will construct the regular expression that will be used to filter the log statement. And also checks if the given log message go through the filter. Filters that can be used are logLevel(Multi values separated by "|") jobId appName actionId token

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOW_ALL_REGEX
static java.lang.String	MAX_ACTIONLIST_SCAN_DURATION
static java.lang.String	MAX_SCAN_DURATION

Constructor Summary

Constructors

Constructor and Description
XLogFilter()
XLogFilter(XLogUserFilterParam userLogFilter)

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	adjustOffset(java.util.Date date, int offset) Adjust offset, offset will always be in min.
void	calculateAndValidateDateRange(java.util.Date jobStartTime, java.util.Date jobEndTime) Calculate and validate date range.
void	constructPattern() Constructs the regular expression according to the filter and assigns it to fileterPattarn.
static void	defineParameter(java.lang.String filterParam)
java.lang.String	getDebugMessage()
java.util.Date	getEndDate()
java.util.Map<java.lang.String,java.lang.String>	getFilterParams()
java.util.regex.Pattern	getFilterPattern()
java.lang.String	getFormattedEndDate()
java.lang.String	getFormattedStartDate()
int	getLogLimit()
java.util.Date	getStartDate()
XLogUserFilterParam	getUserLogFilter()
boolean	isActionList()
boolean	isDebugMode()
boolean	isFilterPresent()
boolean	matches(java.util.ArrayList<java.lang.String> logParts) Checks if the logLevel and logMessage goes through the logFilter.
static void	reset()
void	setActionList(boolean isActionList)
void	setFilterPattern(java.util.regex.Pattern filterPattern)
void	setLogLevel(java.lang.String logLevel)
void	setParameter(java.lang.String filterParam, java.lang.String value)
void	setUserLogFilter(XLogUserFilterParam userLogFilter)
void	splitLogMessage(LogLine logLine, java.util.regex.Pattern splitPattern) If logLine matches with splitPattern, Split the log line into timestamp, logLevel and remaining log message. Record the parts of message in logLine to avoid regex matching in future. Record the pattern to which logLine has matched.
java.util.ArrayList<java.lang.String>	splitLogMessage(java.lang.String logLine) Splits the log line into timestamp, logLevel and remaining log message.
boolean	splitsMatches(LogLine logLine) Checks if the logLevel and logMessage goes through the logFilter.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_ACTIONLIST_SCAN_DURATION

public static java.lang.String MAX_ACTIONLIST_SCAN_DURATION

MAX_SCAN_DURATION

public static java.lang.String MAX_SCAN_DURATION

ALLOW_ALL_REGEX

public static final java.lang.String ALLOW_ALL_REGEX

See Also:

Constant Field Values

Constructor Detail

XLogFilter

public XLogFilter()

XLogFilter

public XLogFilter(XLogUserFilterParam userLogFilter)

Method Detail

setLogLevel

public void setLogLevel(java.lang.String logLevel)

setParameter

public void setParameter(java.lang.String filterParam,
                java.lang.String value)

defineParameter

public static void defineParameter(java.lang.String filterParam)

isFilterPresent

public boolean isFilterPresent()

splitsMatches

public boolean splitsMatches(LogLine logLine)

Checks if the logLevel and logMessage goes through the logFilter.

Parameters:

logParts -

Returns:

matches

public boolean matches(java.util.ArrayList<java.lang.String> logParts)

Checks if the logLevel and logMessage goes through the logFilter.

Parameters:

logParts -

Returns:

splitLogMessage

public java.util.ArrayList<java.lang.String> splitLogMessage(java.lang.String logLine)

Splits the log line into timestamp, logLevel and remaining log message. Returns array containing timestamp, logLevel, and logMessage if the pattern matches i.e A new log statement, else returns null.

Parameters:

logLine -

Returns:

Array containing log level and log message

splitLogMessage

public void splitLogMessage(LogLine logLine,
                   java.util.regex.Pattern splitPattern)

If logLine matches with splitPattern,

1. Split the log line into timestamp, logLevel and remaining log message.
2. Record the parts of message in logLine to avoid regex matching in future.
3. Record the pattern to which logLine has matched.

Parameters:

logLine -

splitPattern -

constructPattern

public void constructPattern()

Constructs the regular expression according to the filter and assigns it to fileterPattarn. ".*" will be assigned if no filters are set.

reset

public static void reset()

getFilterParams

public final java.util.Map<java.lang.String,java.lang.String> getFilterParams()

getUserLogFilter

public XLogUserFilterParam getUserLogFilter()

setUserLogFilter

public void setUserLogFilter(XLogUserFilterParam userLogFilter)

getEndDate

public java.util.Date getEndDate()

getFormattedEndDate

public java.lang.String getFormattedEndDate()

getFormattedStartDate

public java.lang.String getFormattedStartDate()

getStartDate

public java.util.Date getStartDate()

isDebugMode

public boolean isDebugMode()

getLogLimit

public int getLogLimit()

getDebugMessage

public java.lang.String getDebugMessage()

isActionList

public boolean isActionList()

setActionList

public void setActionList(boolean isActionList)

calculateAndValidateDateRange

public void calculateAndValidateDateRange(java.util.Date jobStartTime,
                                 java.util.Date jobEndTime)
                                   throws java.io.IOException

Calculate and validate date range.

Parameters:

jobStartTime - the job start time

jobEndTime - the job end time

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

adjustOffset

public java.util.Date adjustOffset(java.util.Date date,
                          int offset)
                            throws java.io.IOException

Adjust offset, offset will always be in min.

Parameters:

date - the date

offset - the offset

Returns:

the date

Throws:

java.io.IOException - Signals that an I/O exception has occurred.

setFilterPattern

public void setFilterPattern(java.util.regex.Pattern filterPattern)

getFilterPattern

public java.util.regex.Pattern getFilterPattern()