Google Git
Sign in
apache / hadoop-site / 952d547359cafef280f0a0324055741b2ed55be1 / . / content / docs / r3.3.1 / hadoop-yarn / hadoop-yarn-common / apidocs / org / apache / hadoop / yarn / util / ResourceCalculatorPlugin.html
blob: b30b1fba17d5dabe347800226fd92f994cb1bd29 [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>ResourceCalculatorPlugin (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="ResourceCalculatorPlugin (Apache Hadoop YARN Common 3.3.1 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":9,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":9,"i9":10,"i10":10,"i11":10,"i12":10,"i13":9,"i14":10,"i15":10,"i16":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/ResourceCalculatorPlugin.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/RackResolver.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/ResourceCalculatorProcessTree.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/ResourceCalculatorPlugin.html" target="_top">Frames</a></li>
<li><a href="ResourceCalculatorPlugin.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>Field&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 ResourceCalculatorPlugin" class="title">Class ResourceCalculatorPlugin</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>org.apache.hadoop.yarn.util.ResourceCalculatorPlugin</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>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/hadoop/yarn/util/LinuxResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">LinuxResourceCalculatorPlugin</a>, <a href="../../../../../org/apache/hadoop/yarn/util/WindowsResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">WindowsResourceCalculatorPlugin</a></dd>
</dl>
<hr>
<br>
<pre>@InterfaceAudience.LimitedPrivate(value={"YARN","MAPREDUCE"})
@InterfaceStability.Unstable
public class <span class="typeNameLabel">ResourceCalculatorPlugin</span>
extends org.apache.hadoop.conf.Configured</pre>
<div class="block">Plugin to calculate resource information on the system.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#ResourceCalculatorPlugin--">ResourceCalculatorPlugin</a></span>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#ResourceCalculatorPlugin-org.apache.hadoop.util.SysInfo-">ResourceCalculatorPlugin</a></span>(org.apache.hadoop.util.SysInfo&nbsp;sys)</code>&nbsp;</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>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getAvailablePhysicalMemorySize--">getAvailablePhysicalMemorySize</a></span>()</code>
<div class="block">Obtain the total size of the available physical memory present
in the system.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getAvailableVirtualMemorySize--">getAvailableVirtualMemorySize</a></span>()</code>
<div class="block">Obtain the total size of the available virtual memory present
in the system.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getContainersMonitorPlugin-org.apache.hadoop.conf.Configuration-">getContainersMonitorPlugin</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Create the ResourceCalculatorPlugin for the containers monitor in the Node
Manager and configure it.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getCpuFrequency--">getCpuFrequency</a></span>()</code>
<div class="block">Obtain the CPU frequency of on the system.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getCpuUsagePercentage--">getCpuUsagePercentage</a></span>()</code>
<div class="block">Obtain the CPU usage % of the machine.</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/ResourceCalculatorPlugin.html#getCumulativeCpuTime--">getCumulativeCpuTime</a></span>()</code>
<div class="block">Obtain the cumulative CPU time since the system is on.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getNetworkBytesRead--">getNetworkBytesRead</a></span>()</code>
<div class="block">Obtain the aggregated number of bytes read over the network.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getNetworkBytesWritten--">getNetworkBytesWritten</a></span>()</code>
<div class="block">Obtain the aggregated number of bytes written to the network.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getNodeResourceMonitorPlugin-org.apache.hadoop.conf.Configuration-">getNodeResourceMonitorPlugin</a></span>(org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Create the ResourceCalculatorPlugin for the node resource monitor in the
Node Manager and configure it.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getNumCores--">getNumCores</a></span>()</code>
<div class="block">Obtain total number of physical cores present on the system.</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getNumProcessors--">getNumProcessors</a></span>()</code>
<div class="block">Obtain the total number of logical processors present on the system.</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>float</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getNumVCoresUsed--">getNumVCoresUsed</a></span>()</code>
<div class="block">Obtain the number of VCores used.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getPhysicalMemorySize--">getPhysicalMemorySize</a></span>()</code>
<div class="block">Obtain the total size of the physical memory present in the system.</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getResourceCalculatorPlugin-java.lang.Class-org.apache.hadoop.conf.Configuration-">getResourceCalculatorPlugin</a></span>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a>&gt;&nbsp;clazz,
org.apache.hadoop.conf.Configuration&nbsp;conf)</code>
<div class="block">Create the ResourceCalculatorPlugin from the class name and configure it.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getStorageBytesRead--">getStorageBytesRead</a></span>()</code>
<div class="block">Obtain the aggregated number of bytes read from disks.</div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getStorageBytesWritten--">getStorageBytesWritten</a></span>()</code>
<div class="block">Obtain the aggregated number of bytes written to disks.</div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html#getVirtualMemorySize--">getVirtualMemorySize</a></span>()</code>
<div class="block">Obtain the total size of the virtual memory present in the system.</div>
</td>
</tr>
</table>
<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="ResourceCalculatorPlugin--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ResourceCalculatorPlugin</h4>
<pre>protected&nbsp;ResourceCalculatorPlugin()</pre>
</li>
</ul>
<a name="ResourceCalculatorPlugin-org.apache.hadoop.util.SysInfo-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ResourceCalculatorPlugin</h4>
<pre>public&nbsp;ResourceCalculatorPlugin(org.apache.hadoop.util.SysInfo&nbsp;sys)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getVirtualMemorySize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVirtualMemorySize</h4>
<pre>public&nbsp;long&nbsp;getVirtualMemorySize()</pre>
<div class="block">Obtain the total size of the virtual memory present in the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>virtual memory size in bytes.</dd>
</dl>
</li>
</ul>
<a name="getPhysicalMemorySize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getPhysicalMemorySize</h4>
<pre>public&nbsp;long&nbsp;getPhysicalMemorySize()</pre>
<div class="block">Obtain the total size of the physical memory present in the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>physical memory size bytes.</dd>
</dl>
</li>
</ul>
<a name="getAvailableVirtualMemorySize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailableVirtualMemorySize</h4>
<pre>public&nbsp;long&nbsp;getAvailableVirtualMemorySize()</pre>
<div class="block">Obtain the total size of the available virtual memory present
in the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>available virtual memory size in bytes.</dd>
</dl>
</li>
</ul>
<a name="getAvailablePhysicalMemorySize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAvailablePhysicalMemorySize</h4>
<pre>public&nbsp;long&nbsp;getAvailablePhysicalMemorySize()</pre>
<div class="block">Obtain the total size of the available physical memory present
in the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>available physical memory size bytes.</dd>
</dl>
</li>
</ul>
<a name="getNumProcessors--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumProcessors</h4>
<pre>public&nbsp;int&nbsp;getNumProcessors()</pre>
<div class="block">Obtain the total number of logical processors present on the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of logical processors</dd>
</dl>
</li>
</ul>
<a name="getNumCores--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumCores</h4>
<pre>public&nbsp;int&nbsp;getNumCores()</pre>
<div class="block">Obtain total number of physical cores present on the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>number of physical cores</dd>
</dl>
</li>
</ul>
<a name="getCpuFrequency--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCpuFrequency</h4>
<pre>public&nbsp;long&nbsp;getCpuFrequency()</pre>
<div class="block">Obtain the CPU frequency of on the system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CPU frequency in kHz</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">Obtain the cumulative CPU time since the system is on.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>cumulative CPU time in milliseconds</dd>
</dl>
</li>
</ul>
<a name="getCpuUsagePercentage--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCpuUsagePercentage</h4>
<pre>public&nbsp;float&nbsp;getCpuUsagePercentage()</pre>
<div class="block">Obtain the CPU usage % of the machine. Return -1 if it is unavailable.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>CPU usage in %</dd>
</dl>
</li>
</ul>
<a name="getNumVCoresUsed--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumVCoresUsed</h4>
<pre>public&nbsp;float&nbsp;getNumVCoresUsed()</pre>
<div class="block">Obtain the number of VCores used. Return -1 if it is unavailable.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Number of VCores used a percentage (from 0 to #VCores)</dd>
</dl>
</li>
</ul>
<a name="getNetworkBytesRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNetworkBytesRead</h4>
<pre>public&nbsp;long&nbsp;getNetworkBytesRead()</pre>
<div class="block">Obtain the aggregated number of bytes read over the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>total number of bytes read.</dd>
</dl>
</li>
</ul>
<a name="getNetworkBytesWritten--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNetworkBytesWritten</h4>
<pre>public&nbsp;long&nbsp;getNetworkBytesWritten()</pre>
<div class="block">Obtain the aggregated number of bytes written to the network.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>total number of bytes written.</dd>
</dl>
</li>
</ul>
<a name="getStorageBytesRead--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStorageBytesRead</h4>
<pre>public&nbsp;long&nbsp;getStorageBytesRead()</pre>
<div class="block">Obtain the aggregated number of bytes read from disks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>total number of bytes read.</dd>
</dl>
</li>
</ul>
<a name="getStorageBytesWritten--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStorageBytesWritten</h4>
<pre>public&nbsp;long&nbsp;getStorageBytesWritten()</pre>
<div class="block">Obtain the aggregated number of bytes written to disks.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>total number of bytes written.</dd>
</dl>
</li>
</ul>
<a name="getResourceCalculatorPlugin-java.lang.Class-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResourceCalculatorPlugin</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a>&nbsp;getResourceCalculatorPlugin(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;? extends <a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a>&gt;&nbsp;clazz,
org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Create the ResourceCalculatorPlugin from the class name and configure it. If
class name is null, this method will try and return a memory calculator
plugin available for this system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>clazz</code> - ResourceCalculator plugin class-name</dd>
<dd><code>conf</code> - configure the plugin with this.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ResourceCalculatorPlugin or null if ResourceCalculatorPlugin is not
available for current system</dd>
</dl>
</li>
</ul>
<a name="getContainersMonitorPlugin-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContainersMonitorPlugin</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a>&nbsp;getContainersMonitorPlugin(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Create the ResourceCalculatorPlugin for the containers monitor in the Node
Manager and configure it. If the plugin is not configured, this method
will try and return a memory calculator plugin available for this system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - Configure the plugin with this.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ResourceCalculatorPlugin or null if ResourceCalculatorPlugin is
not available for current system.</dd>
</dl>
</li>
</ul>
<a name="getNodeResourceMonitorPlugin-org.apache.hadoop.conf.Configuration-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getNodeResourceMonitorPlugin</h4>
<pre>public static&nbsp;<a href="../../../../../org/apache/hadoop/yarn/util/ResourceCalculatorPlugin.html" title="class in org.apache.hadoop.yarn.util">ResourceCalculatorPlugin</a>&nbsp;getNodeResourceMonitorPlugin(org.apache.hadoop.conf.Configuration&nbsp;conf)</pre>
<div class="block">Create the ResourceCalculatorPlugin for the node resource monitor in the
Node Manager and configure it. If the plugin is not configured, this
method will try and return a memory calculator plugin available for this
system.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>conf</code> - Configure the plugin with this.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>ResourceCalculatorPlugin or null if ResourceCalculatorPlugin is
not available for current system.</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/ResourceCalculatorPlugin.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/RackResolver.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/ResourceCalculatorProcessTree.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/ResourceCalculatorPlugin.html" target="_top">Frames</a></li>
<li><a href="ResourceCalculatorPlugin.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>Field&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>