org.apache.hadoop.yarn.api.records

Class LogAggregationContext

java.lang.Object

org.apache.hadoop.yarn.api.records.LogAggregationContext

@InterfaceStability.Evolving
 @InterfaceAudience.Public
public abstract class LogAggregationContext
extends Object

LogAggregationContext represents all of the information needed by the NodeManager to handle the logs for an application.

It includes details such as:

• includePattern. It uses Java Regex to filter the log files which match the defined include pattern and those log files will be uploaded when the application finishes.
• excludePattern. It uses Java Regex to filter the log files which match the defined exclude pattern and those log files will not be uploaded when application finishes. If the log file name matches both the include and the exclude pattern, this file will be excluded eventually.
• rolledLogsIncludePattern. It uses Java Regex to filter the log files which match the defined include pattern and those log files will be aggregated in a rolling fashion.
• rolledLogsExcludePattern. It uses Java Regex to filter the log files which match the defined exclude pattern and those log files will not be aggregated in a rolling fashion. If the log file name matches both the include and the exclude pattern, this file will be excluded eventually.

See Also:

ApplicationSubmissionContext

Constructor Summary

Constructors

Constructor and Description
LogAggregationContext()

Method Summary

Modifier and Type	Method and Description
abstract String	getExcludePattern() Get exclude pattern.
abstract String	getIncludePattern() Get include pattern.
abstract String	getRolledLogsExcludePattern() Get exclude pattern for aggregation in a rolling fashion.
abstract String	getRolledLogsIncludePattern() Get include pattern in a rolling fashion.
static LogAggregationContext	newInstance(String includePattern, String excludePattern)
static LogAggregationContext	newInstance(String includePattern, String excludePattern, String rolledLogsIncludePattern, String rolledLogsExcludePattern)
abstract void	setExcludePattern(String excludePattern) Set exclude pattern.
abstract void	setIncludePattern(String includePattern) Set include pattern.
abstract void	setRolledLogsExcludePattern(String rolledLogsExcludePattern) Set exclude pattern for in a rolling fashion.
abstract void	setRolledLogsIncludePattern(String rolledLogsIncludePattern) Set include pattern in a rolling fashion.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogAggregationContext

public LogAggregationContext()

Method Detail

newInstance

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public static LogAggregationContext newInstance(String includePattern,
                                                                                                        String excludePattern)

newInstance

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public static LogAggregationContext newInstance(String includePattern,
                                                                                                        String excludePattern,
                                                                                                        String rolledLogsIncludePattern,
                                                                                                        String rolledLogsExcludePattern)

getIncludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract String getIncludePattern()

Get include pattern. This includePattern only takes affect on logs that exist at the time of application finish.

Returns:

include pattern

setIncludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract void setIncludePattern(String includePattern)

Set include pattern. This includePattern only takes affect on logs that exist at the time of application finish.

Parameters:

includePattern -

getExcludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract String getExcludePattern()

Get exclude pattern. This excludePattern only takes affect on logs that exist at the time of application finish.

Returns:

exclude pattern

setExcludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract void setExcludePattern(String excludePattern)

Set exclude pattern. This excludePattern only takes affect on logs that exist at the time of application finish.

Parameters:

excludePattern -

getRolledLogsIncludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract String getRolledLogsIncludePattern()

Get include pattern in a rolling fashion.

Returns:

include pattern

setRolledLogsIncludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract void setRolledLogsIncludePattern(String rolledLogsIncludePattern)

Set include pattern in a rolling fashion.

Parameters:

rolledLogsIncludePattern -

getRolledLogsExcludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract String getRolledLogsExcludePattern()

Get exclude pattern for aggregation in a rolling fashion.

Returns:

exclude pattern

setRolledLogsExcludePattern

@InterfaceAudience.Public
 @InterfaceStability.Unstable
public abstract void setRolledLogsExcludePattern(String rolledLogsExcludePattern)

Set exclude pattern for in a rolling fashion.

Parameters:

rolledLogsExcludePattern -