1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
<!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 (version 1.7.0_51) on Wed Sep 16 10:26:34 PDT 2015 -->
<title>SparkStatusTracker</title>
<meta name="date" content="2015-09-16">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="SparkStatusTracker";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/Success.html" title="class in org.apache.spark"><span class="strong">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>java.lang.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="strong">SparkStatusTracker</span>
extends java.lang.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="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkStatusTracker.html#getActiveJobIds()">getActiveJobIds</a></strong>()</code>
<div class="block">Returns an array containing the ids of all active jobs.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkStatusTracker.html#getActiveStageIds()">getActiveStageIds</a></strong>()</code>
<div class="block">Returns an array containing the ids of all active stages.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/apache/spark/SparkStatusTracker.html#getJobIdsForGroup(java.lang.String)">getJobIdsForGroup</a></strong>(java.lang.String jobGroup)</code>
<div class="block">Return a list of all known jobs in a particular job group.</div>
</td>
</tr>
<tr class="rowColor">
<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><strong><a href="../../../org/apache/spark/SparkStatusTracker.html#getJobInfo(int)">getJobInfo</a></strong>(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 class="altColor">
<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><strong><a href="../../../org/apache/spark/SparkStatusTracker.html#getStageInfo(int)">getStageInfo</a></strong>(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_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, 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="getJobIdsForGroup(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getJobIdsForGroup</h4>
<pre>public int[] getJobIdsForGroup(java.lang.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="strong">Parameters:</span></dt><dd><code>jobGroup</code> - (undocumented)</dd>
<dt><span class="strong">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="strong">Returns:</span></dt><dd>(undocumented)</dd></dl>
</li>
</ul>
<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="strong">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="strong">Parameters:</span></dt><dd><code>jobId</code> - (undocumented)</dd>
<dt><span class="strong">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="strong">Parameters:</span></dt><dd><code>stageId</code> - (undocumented)</dd>
<dt><span class="strong">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><a href="#skip-navbar_bottom" title="Skip navigation links"></a><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="strong">Prev Class</span></a></li>
<li><a href="../../../org/apache/spark/Success.html" title="class in org.apache.spark"><span class="strong">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>
|
