Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-common / apidocs / org / apache / hadoop / yarn / util / WindowsBasedProcessTree.html
blob: 556a8047bb67befb926788c729f533edbcff0c8a [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_292) on Tue Jun 15 06:10:04 GMT 2021 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WindowsBasedProcessTree (Apache Hadoop YARN Common 3.3.1 API)</title>
<meta name="date" content="2021-06-15">
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="WindowsBasedProcessTree (Apache Hadoop YARN Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":9,"i7":10};
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WindowsBasedProcessTree.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/yarn/util/UTCClock.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/yarn/util/WindowsResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html" target="_top">Frames</a></li>
<li><a href="WindowsBasedProcessTree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.hadoop.yarn.util</div>
<h2 title="Class WindowsBasedProcessTree" class="title">Class WindowsBasedProcessTree</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.conf.Configured</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree</a></li>
<li>
<ul class="inheritance">
<li>org.apache.hadoop.yarn.util.WindowsBasedProcessTree</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.hadoop.conf.Configurable</dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.Private
public class <span class="typeNameLabel">WindowsBasedProcessTree</span>
extends <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.hadoop.yarn.util.<a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></h3>
<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#UNAVAILABLE">UNAVAILABLE</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#WindowsBasedProcessTree-java.lang.String-">WindowsBasedProcessTree</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pid)</code>
<div class="block">Create a monitor for a Windows process tree.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#WindowsBasedProcessTree-java.lang.String-org.apache.hadoop.yarn.util.Clock-">WindowsBasedProcessTree</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pid,
<a href="../../../../../org/apache/hadoop/yarn/util/Clock.html" title="interface in org.apache.hadoop.yarn.util">Clock</a>&nbsp;pClock)</code>
<div class="block">Create a monitor for a Windows process tree.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#checkPidPgrpidForMatch--">checkPidPgrpidForMatch</a></span>()</code>
<div class="block">Verify that the tree process id is same as its process group id.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#getCpuUsagePercent--">getCpuUsagePercent</a></span>()</code>
<div class="block">Get the CPU usage by all the processes in the process-tree in Windows.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#getCumulativeCpuTime--">getCumulativeCpuTime</a></span>()</code>
<div class="block">Get the CPU time in millisecond used by all the processes in the
process-tree since the process-tree was created</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#getProcessTreeDump--">getProcessTreeDump</a></span>()</code>
<div class="block">Get a dump of the process-tree.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#getRssMemorySize-int-">getRssMemorySize</a></span>(int&nbsp;olderThanAge)</code>
<div class="block">Get the resident set size (rss) memory used by all the processes
in the process-tree that are older than the passed in age.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#getVirtualMemorySize-int-">getVirtualMemorySize</a></span>(int&nbsp;olderThanAge)</code>
<div class="block">Get the virtual memory used by all the processes in the
process-tree that are older than the passed in age.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>static boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#isAvailable--">isAvailable</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html#updateProcessTree--">updateProcessTree</a></span>()</code>
<div class="block">Update the process-tree with latest state.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.yarn.util.<a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></h3>
<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getResourceCalculatorProcessTree-java.lang.String-java.lang.Class-org.apache.hadoop.conf.Configuration-">getResourceCalculatorProcessTree</a>, <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getRssMemorySize--">getRssMemorySize</a>, <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getVirtualMemorySize--">getVirtualMemorySize</a>, <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#initialize--">initialize</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.hadoop.conf.Configured">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.hadoop.conf.Configured</h3>
<code>getConf, setConf</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="WindowsBasedProcessTree-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>WindowsBasedProcessTree</h4>
<pre>public&nbsp;WindowsBasedProcessTree(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pid)</pre>
<div class="block">Create a monitor for a Windows process tree.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pid</code> - Identifier of the job object.</dd>
</dl>
</li>
</ul>
<a name="WindowsBasedProcessTree-java.lang.String-org.apache.hadoop.yarn.util.Clock-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>WindowsBasedProcessTree</h4>
<pre>public&nbsp;WindowsBasedProcessTree(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;pid,
<a href="../../../../../org/apache/hadoop/yarn/util/Clock.html" title="interface in org.apache.hadoop.yarn.util">Clock</a>&nbsp;pClock)</pre>
<div class="block">Create a monitor for a Windows process tree.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>pid</code> - Identifier of the job object.</dd>
<dd><code>pClock</code> - Clock to keep track of time for CPU utilization.</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="isAvailable--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAvailable</h4>
<pre>public static&nbsp;boolean&nbsp;isAvailable()</pre>
</li>
</ul>
<a name="updateProcessTree--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateProcessTree</h4>
<pre>public&nbsp;void&nbsp;updateProcessTree()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#updateProcessTree--">ResourceCalculatorProcessTree</a></code></span></div>
<div class="block">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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#updateProcessTree--">updateProcessTree</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></code></dd>
</dl>
</li>
</ul>
<a name="checkPidPgrpidForMatch--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkPidPgrpidForMatch</h4>
<pre>public&nbsp;boolean&nbsp;checkPidPgrpidForMatch()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#checkPidPgrpidForMatch--">ResourceCalculatorProcessTree</a></code></span></div>
<div class="block">Verify that the tree process id is same as its process group id.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#checkPidPgrpidForMatch--">checkPidPgrpidForMatch</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the process id matches else return false.</dd>
</dl>
</li>
</ul>
<a name="getProcessTreeDump--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessTreeDump</h4>
<pre>public&nbsp;<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getProcessTreeDump()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getProcessTreeDump--">ResourceCalculatorProcessTree</a></code></span></div>
<div class="block">Get a dump of the process-tree.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getProcessTreeDump--">getProcessTreeDump</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string concatenating the dump of information of all the processes
in the process-tree</dd>
</dl>
</li>
</ul>
<a name="getVirtualMemorySize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVirtualMemorySize</h4>
<pre>public&nbsp;long&nbsp;getVirtualMemorySize(int&nbsp;olderThanAge)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getVirtualMemorySize-int-">ResourceCalculatorProcessTree</a></code></span></div>
<div class="block">Get the virtual memory used by all the processes in the
process-tree that are older than the passed in age.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getVirtualMemorySize-int-">getVirtualMemorySize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>olderThanAge</code> - processes above this age are included in the
memory addition</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>virtual memory used by the process-tree in bytes for
processes older than the specified age, <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#UNAVAILABLE"><code>ResourceCalculatorProcessTree.UNAVAILABLE</code></a> if it
cannot be calculated.</dd>
</dl>
</li>
</ul>
<a name="getRssMemorySize-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRssMemorySize</h4>
<pre>public&nbsp;long&nbsp;getRssMemorySize(int&nbsp;olderThanAge)</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getRssMemorySize-int-">ResourceCalculatorProcessTree</a></code></span></div>
<div class="block">Get the resident set size (rss) memory used by all the processes
in the process-tree that are older than the passed in age.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getRssMemorySize-int-">getRssMemorySize</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>olderThanAge</code> - processes above this age are included in the
memory addition</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>rss memory used by the process-tree in bytes for
processes older than specified age, <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#UNAVAILABLE"><code>ResourceCalculatorProcessTree.UNAVAILABLE</code></a> if it cannot be
calculated.</dd>
</dl>
</li>
</ul>
<a name="getCumulativeCpuTime--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCumulativeCpuTime</h4>
<pre>public&nbsp;long&nbsp;getCumulativeCpuTime()</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getCumulativeCpuTime--">ResourceCalculatorProcessTree</a></code></span></div>
<div class="block">Get the CPU time in millisecond used by all the processes in the
process-tree since the process-tree was created</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getCumulativeCpuTime--">getCumulativeCpuTime</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>cumulative CPU time in millisecond since the process-tree
created, <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#UNAVAILABLE"><code>ResourceCalculatorProcessTree.UNAVAILABLE</code></a> if it cannot be calculated.</dd>
</dl>
</li>
</ul>
<a name="getCpuUsagePercent--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getCpuUsagePercent</h4>
<pre>public&nbsp;float&nbsp;getCpuUsagePercent()</pre>
<div class="block">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.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#getCpuUsagePercent--">getCpuUsagePercent</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorProcessTree</a></code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>percentage CPU usage since the process-tree was created,
<a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorProcessTree.html#UNAVAILABLE"><code>ResourceCalculatorProcessTree.UNAVAILABLE</code></a> if CPU usage cannot be calculated or not available.</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/WindowsBasedProcessTree.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/hadoop/yarn/util/UTCClock.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../org/apache/hadoop/yarn/util/WindowsResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/hadoop/yarn/util/WindowsBasedProcessTree.html" target="_top">Frames</a></li>
<li><a href="WindowsBasedProcessTree.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.org.apache.hadoop.yarn.util.ResourceCalculatorProcessTree">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2008&#x2013;2021 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>