| <!DOCTYPE HTML> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>CgroupManager (Storm 2.6.2 API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.storm.container.cgroup, class: CgroupManager"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-3.6.1.min.js"></script> |
| <script type="text/javascript" src="../../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/CgroupManager.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#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li><a href="#constructor-summary">Constr</a> | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li><a href="#constructor-detail">Constr</a> | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.storm.container.cgroup</a></div> |
| <h1 title="Class CgroupManager" class="title">Class CgroupManager</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a> |
| <div class="inheritance"><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">org.apache.storm.container.DefaultResourceIsolationManager</a> |
| <div class="inheritance">org.apache.storm.container.cgroup.CgroupManager</div> |
| </div> |
| </div> |
| <section class="class-description" id="class-description"> |
| <dl class="notes"> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| </dl> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">CgroupManager</span> |
| <span class="extends-implements">extends <a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></span></div> |
| <div class="block">Class that implements ResourceIsolationInterface that manages cgroups.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="inherited-list"> |
| <h3 id="fields-inherited-from-class-org.apache.storm.container.DefaultResourceIsolationManager">Fields inherited from class org.apache.storm.container.<a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></h3> |
| <code><a href="../DefaultResourceIsolationManager.html#conf">conf</a>, <a href="../DefaultResourceIsolationManager.html#runAsUser">runAsUser</a></code></div> |
| </section> |
| </li> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <li> |
| <section class="constructor-summary" id="constructor-summary"> |
| <h2>Constructor Summary</h2> |
| <div class="caption"><span>Constructors</span></div> |
| <div class="summary-table two-column-summary"> |
| <div class="table-header col-first">Constructor</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">CgroupManager</a>()</code></div> |
| <div class="col-last even-row-color"> </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#cleanup(java.lang.String,java.lang.String,int)" class="member-name-link">cleanup</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> user, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| int port)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This function will be called when the worker needs to shutdown.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getAllPids(java.lang.String)" class="member-name-link">getAllPids</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get all of the pids that are a part of this container.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getLaunchCommand(java.lang.String,java.util.List)" class="member-name-link">getLaunchCommand</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> existingCommand)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">To compose launch command based on workerId and existing command.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getMemoryUsage(java.lang.String,java.lang.String,int)" class="member-name-link">getMemoryUsage</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> user, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| int port)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the current memory usage of the a given worker.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>long</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getSystemFreeMemoryMb()" class="member-name-link">getSystemFreeMemoryMb</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">Get the amount of free memory in MB.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>protected static boolean</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#isOnLinux()" class="member-name-link">isOnLinux</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> |
| <div class="block">Extracting out to mock it for tests.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#isResourceManaged()" class="member-name-link">isResourceManaged</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This class doesn't really manage resources.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#launchWorkerProcess(java.lang.String,java.lang.String,java.util.Map,int,java.lang.String,java.util.List,java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.ExitCodeCallback,java.io.File)" class="member-name-link">launchWorkerProcess</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> user, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topologyId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| int port, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> command, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> env, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> logPrefix, |
| <a href="../../daemon/supervisor/ExitCodeCallback.html" title="interface in org.apache.storm.daemon.supervisor">ExitCodeCallback</a> processExitCallback, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> targetDir)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">After reserving resources for the worker (i.e. calling reserveResourcesForWorker), |
| this function can be used to launch worker process.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#prepare(java.util.Map)" class="member-name-link">prepare</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf)</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">initialize data structures.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#reserveResourcesForWorker(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String)" class="member-name-link">reserveResourcesForWorker</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> totalMem, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> cpuNum, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> numaId)</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> |
| <div class="block">This function should be used prior to starting the worker to reserve resources for the worker.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-org.apache.storm.container.DefaultResourceIsolationManager">Methods inherited from class org.apache.storm.container.<a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></h3> |
| <code><a href="../DefaultResourceIsolationManager.html#areAllProcessesDead(java.lang.String,java.lang.String)">areAllProcessesDead</a>, <a href="../DefaultResourceIsolationManager.html#forceKill(java.lang.String,java.lang.String)">forceKill</a>, <a href="../DefaultResourceIsolationManager.html#kill(java.lang.String,java.lang.String)">kill</a>, <a href="../DefaultResourceIsolationManager.html#runProfilingCommand(java.lang.String,java.lang.String,java.util.List,java.util.Map,java.lang.String,java.io.File)">runProfilingCommand</a></code></div> |
| <div class="inherited-list"> |
| <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <li> |
| <section class="constructor-details" id="constructor-detail"> |
| <h2>Constructor Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="<init>()"> |
| <h3>CgroupManager</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CgroupManager</span>()</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="prepare(java.util.Map)"> |
| <h3>prepare</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">prepare</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> conf)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">initialize data structures.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html#prepare(java.util.Map)">prepare</a></code> in interface <code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#prepare(java.util.Map)">prepare</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>conf</code> - storm confs</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on any error.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="reserveResourcesForWorker(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String)"> |
| <h3>reserveResourcesForWorker</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">reserveResourcesForWorker</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> totalMem, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Integer.html" title="class or interface in java.lang" class="external-link">Integer</a> cpuNum, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> numaId)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link">SecurityException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ResourceIsolationInterface.html#reserveResourcesForWorker(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String)">ResourceIsolationInterface</a></code></span></div> |
| <div class="block">This function should be used prior to starting the worker to reserve resources for the worker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html#reserveResourcesForWorker(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String)">reserveResourcesForWorker</a></code> in interface <code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#reserveResourcesForWorker(java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.String)">reserveResourcesForWorker</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>workerId</code> - worker id of the worker to start</dd> |
| <dd><code>totalMem</code> - the amount of memory for the worker or null if not enforced</dd> |
| <dd><code>cpuNum</code> - the amount of cpu for the worker or null if not enforced</dd> |
| <dd><code>numaId</code> - NUMA zone if applicable the worker should be bound to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link">SecurityException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="cleanup(java.lang.String,java.lang.String,int)"> |
| <h3>cleanup</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">cleanup</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> user, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| int port)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ResourceIsolationInterface.html#cleanup(java.lang.String,java.lang.String,int)">ResourceIsolationInterface</a></code></span></div> |
| <div class="block">This function will be called when the worker needs to shutdown. This function should include logic to clean up |
| after a worker is shutdown.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html#cleanup(java.lang.String,java.lang.String,int)">cleanup</a></code> in interface <code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#cleanup(java.lang.String,java.lang.String,int)">cleanup</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>user</code> - the user of the worker</dd> |
| <dd><code>workerId</code> - worker id to shutdown and clean up after</dd> |
| <dd><code>port</code> - the port of the worker</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isOnLinux()"> |
| <h3>isOnLinux</h3> |
| <div class="member-signature"><span class="modifiers">protected static</span> <span class="return-type">boolean</span> <span class="element-name">isOnLinux</span>()</div> |
| <div class="block">Extracting out to mock it for tests.</div> |
| <dl class="notes"> |
| <dt>Returns:</dt> |
| <dd>true if on Linux.</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="launchWorkerProcess(java.lang.String,java.lang.String,java.util.Map,int,java.lang.String,java.util.List,java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.ExitCodeCallback,java.io.File)"> |
| <h3>launchWorkerProcess</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">launchWorkerProcess</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> user, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> topologyId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a>> topoConf, |
| int port, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> command, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Map.html" title="class or interface in java.util" class="external-link">Map</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>,<wbr><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> env, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> logPrefix, |
| <a href="../../daemon/supervisor/ExitCodeCallback.html" title="interface in org.apache.storm.daemon.supervisor">ExitCodeCallback</a> processExitCallback, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/File.html" title="class or interface in java.io" class="external-link">File</a> targetDir)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ResourceIsolationInterface.html#launchWorkerProcess(java.lang.String,java.lang.String,java.util.Map,int,java.lang.String,java.util.List,java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.ExitCodeCallback,java.io.File)">ResourceIsolationInterface</a></code></span></div> |
| <div class="block">After reserving resources for the worker (i.e. calling reserveResourcesForWorker), |
| this function can be used to launch worker process.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html#launchWorkerProcess(java.lang.String,java.lang.String,java.util.Map,int,java.lang.String,java.util.List,java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.ExitCodeCallback,java.io.File)">launchWorkerProcess</a></code> in interface <code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#launchWorkerProcess(java.lang.String,java.lang.String,java.util.Map,int,java.lang.String,java.util.List,java.util.Map,java.lang.String,org.apache.storm.daemon.supervisor.ExitCodeCallback,java.io.File)">launchWorkerProcess</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>user</code> - the user who runs the command as</dd> |
| <dd><code>topologyId</code> - the Id of the topology</dd> |
| <dd><code>topoConf</code> - the topology configuration</dd> |
| <dd><code>port</code> - the port where the worker is on</dd> |
| <dd><code>workerId</code> - the Id of the worker</dd> |
| <dd><code>command</code> - the command to run</dd> |
| <dd><code>env</code> - the environment to run the command</dd> |
| <dd><code>logPrefix</code> - the prefix to include in the logs</dd> |
| <dd><code>processExitCallback</code> - a callback for when the process exits</dd> |
| <dd><code>targetDir</code> - the working directory to run the command in</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on I/O exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getLaunchCommand(java.lang.String,java.util.List)"> |
| <h3>getLaunchCommand</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>></span> <span class="element-name">getLaunchCommand</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>> existingCommand)</span></div> |
| <div class="block">To compose launch command based on workerId and existing command.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>workerId</code> - the worker id</dd> |
| <dd><code>existingCommand</code> - the current command to run that may need to be modified</dd> |
| <dt>Returns:</dt> |
| <dd>new commandline with necessary additions to launch worker</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getAllPids(java.lang.String)"> |
| <h3>getAllPids</h3> |
| <div class="member-signature"><span class="modifiers">protected</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Set.html" title="class or interface in java.util" class="external-link">Set</a><<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/Long.html" title="class or interface in java.lang" class="external-link">Long</a>></span> <span class="element-name">getAllPids</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block">Get all of the pids that are a part of this container.</div> |
| <dl class="notes"> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#getAllPids(java.lang.String)">getAllPids</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>workerId</code> - the worker id</dd> |
| <dt>Returns:</dt> |
| <dd>all of the pids that are a part of this container</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code></dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getMemoryUsage(java.lang.String,java.lang.String,int)"> |
| <h3>getMemoryUsage</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getMemoryUsage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> user, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a> workerId, |
| int port)</span> |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ResourceIsolationInterface.html#getMemoryUsage(java.lang.String,java.lang.String,int)">ResourceIsolationInterface</a></code></span></div> |
| <div class="block">Get the current memory usage of the a given worker.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html#getMemoryUsage(java.lang.String,java.lang.String,int)">getMemoryUsage</a></code> in interface <code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#getMemoryUsage(java.lang.String,java.lang.String,int)">getMemoryUsage</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Parameters:</dt> |
| <dd><code>user</code> - the user that the worker is running as</dd> |
| <dd><code>workerId</code> - the id of the worker</dd> |
| <dd><code>port</code> - the port of the worker</dd> |
| <dt>Returns:</dt> |
| <dd>the amount of memory the worker is using in bytes or -1 if not supported</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on I/O exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="getSystemFreeMemoryMb()"> |
| <h3>getSystemFreeMemoryMb</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">long</span> <span class="element-name">getSystemFreeMemoryMb</span>() |
| throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></span></div> |
| <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="../ResourceIsolationInterface.html#getSystemFreeMemoryMb()">ResourceIsolationInterface</a></code></span></div> |
| <div class="block">Get the amount of free memory in MB. |
| This might not be the entire box, it might be within a parent resource group.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html#getSystemFreeMemoryMb()">getSystemFreeMemoryMb</a></code> in interface <code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#getSystemFreeMemoryMb()">getSystemFreeMemoryMb</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>The amount of memory in MB that are free on the system.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/io/IOException.html" title="class or interface in java.io" class="external-link">IOException</a></code> - on I/O exception</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="isResourceManaged()"> |
| <h3>isResourceManaged</h3> |
| <div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">isResourceManaged</span>()</div> |
| <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="../DefaultResourceIsolationManager.html#isResourceManaged()">DefaultResourceIsolationManager</a></code></span></div> |
| <div class="block">This class doesn't really manage resources.</div> |
| <dl class="notes"> |
| <dt>Specified by:</dt> |
| <dd><code><a href="../ResourceIsolationInterface.html#isResourceManaged()">isResourceManaged</a></code> in interface <code><a href="../ResourceIsolationInterface.html" title="interface in org.apache.storm.container">ResourceIsolationInterface</a></code></dd> |
| <dt>Overrides:</dt> |
| <dd><code><a href="../DefaultResourceIsolationManager.html#isResourceManaged()">isResourceManaged</a></code> in class <code><a href="../DefaultResourceIsolationManager.html" title="class in org.apache.storm.container">DefaultResourceIsolationManager</a></code></dd> |
| <dt>Returns:</dt> |
| <dd>false</dd> |
| </dl> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2023 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
