org.apache.hadoop.yarn.util

Class WindowsBasedProcessTree

java.lang.Object

org.apache.hadoop.conf.Configured

org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree

org.apache.hadoop.yarn.util.WindowsBasedProcessTree

All Implemented Interfaces:

org.apache.hadoop.conf.Configurable

@InterfaceAudience.Private
public class WindowsBasedProcessTree
extends ResourceCalculatorProcessTree

Field Summary

Fields inherited from class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree

UNAVAILABLE

Constructor Summary

Constructors

Constructor and Description
WindowsBasedProcessTree(String pid) Create a monitor for a Windows process tree.
WindowsBasedProcessTree(String pid, Clock pClock) Create a monitor for a Windows process tree.

Method Summary

Modifier and Type	Method and Description
boolean	checkPidPgrpidForMatch() Verify that the tree process id is same as its process group id.
float	getCpuUsagePercent() Get the CPU usage by all the processes in the process-tree in Windows.
long	getCumulativeCpuTime() Get the CPU time in millisecond used by all the processes in the process-tree since the process-tree was created
String	getProcessTreeDump() Get a dump of the process-tree.
long	getRssMemorySize(int olderThanAge) Get the resident set size (rss) memory used by all the processes in the process-tree that are older than the passed in age.
long	getVirtualMemorySize(int olderThanAge) Get the virtual memory used by all the processes in the process-tree that are older than the passed in age.
static boolean	isAvailable()
void	updateProcessTree() Update the process-tree with latest state.

Methods inherited from class org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree

getResourceCalculatorProcessTree, getRssMemorySize, getVirtualMemorySize, initialize

Methods inherited from class org.apache.hadoop.conf.Configured

getConf, setConf

Methods inherited from class java.lang.Object

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

Constructor Detail

WindowsBasedProcessTree

public WindowsBasedProcessTree(String pid)

Create a monitor for a Windows process tree.

Parameters:

pid - Identifier of the job object.

WindowsBasedProcessTree

public WindowsBasedProcessTree(String pid,
                               Clock pClock)

Create a monitor for a Windows process tree.

Parameters:

pid - Identifier of the job object.

pClock - Clock to keep track of time for CPU utilization.

Method Detail

isAvailable

public static boolean isAvailable()

updateProcessTree

public void updateProcessTree()

Description copied from class: ResourceCalculatorProcessTree

Update the process-tree with latest state. Each call to this function should increment the age of the running processes that already exist in the process tree. Age is used other API's of the interface.

Specified by:

updateProcessTree in class ResourceCalculatorProcessTree

checkPidPgrpidForMatch

public boolean checkPidPgrpidForMatch()

Description copied from class: ResourceCalculatorProcessTree

Verify that the tree process id is same as its process group id.

Specified by:

checkPidPgrpidForMatch in class ResourceCalculatorProcessTree

Returns:

true if the process id matches else return false.

getProcessTreeDump

public String getProcessTreeDump()

Description copied from class: ResourceCalculatorProcessTree

Get a dump of the process-tree.

Specified by:

getProcessTreeDump in class ResourceCalculatorProcessTree

Returns:

a string concatenating the dump of information of all the processes in the process-tree

getVirtualMemorySize

public long getVirtualMemorySize(int olderThanAge)

Description copied from class: ResourceCalculatorProcessTree

Get the virtual memory used by all the processes in the process-tree that are older than the passed in age.

Overrides:

getVirtualMemorySize in class ResourceCalculatorProcessTree

Parameters:

olderThanAge - processes above this age are included in the memory addition

Returns:

virtual memory used by the process-tree in bytes for processes older than the specified age, ResourceCalculatorProcessTree.UNAVAILABLE if it cannot be calculated.

getRssMemorySize

public long getRssMemorySize(int olderThanAge)

Description copied from class: ResourceCalculatorProcessTree

Get the resident set size (rss) memory used by all the processes in the process-tree that are older than the passed in age.

Overrides:

getRssMemorySize in class ResourceCalculatorProcessTree

Parameters:

olderThanAge - processes above this age are included in the memory addition

Returns:

rss memory used by the process-tree in bytes for processes older than specified age, ResourceCalculatorProcessTree.UNAVAILABLE if it cannot be calculated.

getCumulativeCpuTime

public long getCumulativeCpuTime()

Description copied from class: ResourceCalculatorProcessTree

Get the CPU time in millisecond used by all the processes in the process-tree since the process-tree was created

Overrides:

getCumulativeCpuTime in class ResourceCalculatorProcessTree

Returns:

cumulative CPU time in millisecond since the process-tree created, ResourceCalculatorProcessTree.UNAVAILABLE if it cannot be calculated.

getCpuUsagePercent

public float getCpuUsagePercent()

Get the CPU usage by all the processes in the process-tree in Windows. Note: UNAVAILABLE will be returned in case when CPU usage is not available. It is NOT advised to return any other error code.

Overrides:

getCpuUsagePercent in class ResourceCalculatorProcessTree

Returns:

percentage CPU usage since the process-tree was created, ResourceCalculatorProcessTree.UNAVAILABLE if CPU usage cannot be calculated or not available.