| <!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_312) on Mon Jul 11 16:23:57 UTC 2022 --> |
| <title>SparkStatusTracker (Spark 3.2.2 JavaDoc)</title> |
| <meta name="date" content="2022-07-11"> |
| <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="SparkStatusTracker (Spark 3.2.2 JavaDoc)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10}; |
| var tabs = {65535:["t0","All 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="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/spark/SparkStageInfoImpl.html" title="class in org.apache.spark"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/spark/SparkThrowable.html" title="interface in org.apache.spark"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/spark/SparkStatusTracker.html" target="_top">Frames</a></li> |
| <li><a href="SparkStatusTracker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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.spark</div> |
| <h2 title="Class SparkStatusTracker" class="title">Class SparkStatusTracker</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li>Object</li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.spark.SparkStatusTracker</li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">SparkStatusTracker</span> |
| extends Object</pre> |
| <div class="block">Low-level status reporting APIs for monitoring job and stage progress. |
| <p> |
| These APIs intentionally provide very weak consistency semantics; consumers of these APIs should |
| be prepared to handle empty / missing information. For example, a job's stage ids may be known |
| but the status API may not have any information about the details of those stages, so |
| <code>getStageInfo</code> could potentially return <code>None</code> for a valid stage id. |
| <p> |
| To limit memory usage, these APIs only provide information on recent jobs / stages. These APIs |
| will provide information for the last <code>spark.ui.retainedStages</code> stages and |
| <code>spark.ui.retainedJobs</code> jobs. |
| <p> |
| NOTE: this class's constructor should be considered private and may be subject to change.</div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </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>int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/SparkStatusTracker.html#getActiveJobIds--">getActiveJobIds</a></span>()</code> |
| <div class="block">Returns an array containing the ids of all active jobs.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/SparkStatusTracker.html#getActiveStageIds--">getActiveStageIds</a></span>()</code> |
| <div class="block">Returns an array containing the ids of all active stages.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../../org/apache/spark/SparkExecutorInfo.html" title="interface in org.apache.spark">SparkExecutorInfo</a>[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/SparkStatusTracker.html#getExecutorInfos--">getExecutorInfos</a></span>()</code> |
| <div class="block">Returns information of all known executors, including host, port, cacheSize, numRunningTasks |
| and memory metrics.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>int[]</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/SparkStatusTracker.html#getJobIdsForGroup-java.lang.String-">getJobIdsForGroup</a></span>(String jobGroup)</code> |
| <div class="block">Return a list of all known jobs in a particular job group.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>scala.Option<<a href="../../../org/apache/spark/SparkJobInfo.html" title="interface in org.apache.spark">SparkJobInfo</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/SparkStatusTracker.html#getJobInfo-int-">getJobInfo</a></span>(int jobId)</code> |
| <div class="block">Returns job information, or <code>None</code> if the job info could not be found or was garbage collected.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>scala.Option<<a href="../../../org/apache/spark/SparkStageInfo.html" title="interface in org.apache.spark">SparkStageInfo</a>></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/spark/SparkStatusTracker.html#getStageInfo-int-">getStageInfo</a></span>(int stageId)</code> |
| <div class="block">Returns stage information, or <code>None</code> if the stage info could not be found or was |
| garbage collected.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class Object</h3> |
| <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="getActiveJobIds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActiveJobIds</h4> |
| <pre>public int[] getActiveJobIds()</pre> |
| <div class="block">Returns an array containing the ids of all active jobs. |
| <p> |
| This method does not guarantee the order of the elements in its result.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getActiveStageIds--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getActiveStageIds</h4> |
| <pre>public int[] getActiveStageIds()</pre> |
| <div class="block">Returns an array containing the ids of all active stages. |
| <p> |
| This method does not guarantee the order of the elements in its result.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getExecutorInfos--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getExecutorInfos</h4> |
| <pre>public <a href="../../../org/apache/spark/SparkExecutorInfo.html" title="interface in org.apache.spark">SparkExecutorInfo</a>[] getExecutorInfos()</pre> |
| <div class="block">Returns information of all known executors, including host, port, cacheSize, numRunningTasks |
| and memory metrics. |
| Note this include information for both the driver and executors.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJobIdsForGroup-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJobIdsForGroup</h4> |
| <pre>public int[] getJobIdsForGroup(String jobGroup)</pre> |
| <div class="block">Return a list of all known jobs in a particular job group. If <code>jobGroup</code> is <code>null</code>, then |
| returns all known jobs that are not associated with a job group. |
| <p> |
| The returned list may contain running, failed, and completed jobs, and may vary across |
| invocations of this method. This method does not guarantee the order of the elements in |
| its result.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobGroup</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getJobInfo-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getJobInfo</h4> |
| <pre>public scala.Option<<a href="../../../org/apache/spark/SparkJobInfo.html" title="interface in org.apache.spark">SparkJobInfo</a>> getJobInfo(int jobId)</pre> |
| <div class="block">Returns job information, or <code>None</code> if the job info could not be found or was garbage collected.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>jobId</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getStageInfo-int-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getStageInfo</h4> |
| <pre>public scala.Option<<a href="../../../org/apache/spark/SparkStageInfo.html" title="interface in org.apache.spark">SparkStageInfo</a>> getStageInfo(int stageId)</pre> |
| <div class="block">Returns stage information, or <code>None</code> if the stage info could not be found or was |
| garbage collected.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>stageId</code> - (undocumented)</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>(undocumented)</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="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/spark/SparkStageInfoImpl.html" title="class in org.apache.spark"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../org/apache/spark/SparkThrowable.html" title="interface in org.apache.spark"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../index.html?org/apache/spark/SparkStatusTracker.html" target="_top">Frames</a></li> |
| <li><a href="SparkStatusTracker.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../allclasses-noframe.html">All 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: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <script defer="defer" type="text/javascript" src="../../../lib/jquery.js"></script><script defer="defer" type="text/javascript" src="../../../lib/api-javadocs.js"></script></body> |
| </html> |
