1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
---|
2 | <!--NewPage--> |
---|
3 | <HTML> |
---|
4 | <HEAD> |
---|
5 | <!-- Generated by javadoc (build 1.6.0_07) on Tue Sep 01 20:56:54 UTC 2009 --> |
---|
6 | <TITLE> |
---|
7 | MetricsContext (Hadoop 0.20.1 API) |
---|
8 | </TITLE> |
---|
9 | |
---|
10 | <META NAME="date" CONTENT="2009-09-01"> |
---|
11 | |
---|
12 | <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
---|
13 | |
---|
14 | <SCRIPT type="text/javascript"> |
---|
15 | function windowTitle() |
---|
16 | { |
---|
17 | if (location.href.indexOf('is-external=true') == -1) { |
---|
18 | parent.document.title="MetricsContext (Hadoop 0.20.1 API)"; |
---|
19 | } |
---|
20 | } |
---|
21 | </SCRIPT> |
---|
22 | <NOSCRIPT> |
---|
23 | </NOSCRIPT> |
---|
24 | |
---|
25 | </HEAD> |
---|
26 | |
---|
27 | <BODY BGCOLOR="white" onload="windowTitle();"> |
---|
28 | <HR> |
---|
29 | |
---|
30 | |
---|
31 | <!-- ========= START OF TOP NAVBAR ======= --> |
---|
32 | <A NAME="navbar_top"><!-- --></A> |
---|
33 | <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
---|
34 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
35 | <TR> |
---|
36 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
37 | <A NAME="navbar_top_firstrow"><!-- --></A> |
---|
38 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
39 | <TR ALIGN="center" VALIGN="top"> |
---|
40 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
41 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
42 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
43 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MetricsContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
44 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
45 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
46 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
47 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
48 | </TR> |
---|
49 | </TABLE> |
---|
50 | </TD> |
---|
51 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
52 | </EM> |
---|
53 | </TD> |
---|
54 | </TR> |
---|
55 | |
---|
56 | <TR> |
---|
57 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
58 | <A HREF="../../../../org/apache/hadoop/metrics/ContextFactory.html" title="class in org.apache.hadoop.metrics"><B>PREV CLASS</B></A> |
---|
59 | <A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics"><B>NEXT CLASS</B></A></FONT></TD> |
---|
60 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
61 | <A HREF="../../../../index.html?org/apache/hadoop/metrics/MetricsContext.html" target="_top"><B>FRAMES</B></A> |
---|
62 | <A HREF="MetricsContext.html" target="_top"><B>NO FRAMES</B></A> |
---|
63 | <SCRIPT type="text/javascript"> |
---|
64 | <!-- |
---|
65 | if(window==top) { |
---|
66 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
67 | } |
---|
68 | //--> |
---|
69 | </SCRIPT> |
---|
70 | <NOSCRIPT> |
---|
71 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
72 | </NOSCRIPT> |
---|
73 | |
---|
74 | |
---|
75 | </FONT></TD> |
---|
76 | </TR> |
---|
77 | <TR> |
---|
78 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
79 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
80 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
81 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
82 | </TR> |
---|
83 | </TABLE> |
---|
84 | <A NAME="skip-navbar_top"></A> |
---|
85 | <!-- ========= END OF TOP NAVBAR ========= --> |
---|
86 | |
---|
87 | <HR> |
---|
88 | <!-- ======== START OF CLASS DATA ======== --> |
---|
89 | <H2> |
---|
90 | <FONT SIZE="-1"> |
---|
91 | org.apache.hadoop.metrics</FONT> |
---|
92 | <BR> |
---|
93 | Interface MetricsContext</H2> |
---|
94 | <DL> |
---|
95 | <DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/hadoop/metrics/spi/AbstractMetricsContext.html" title="class in org.apache.hadoop.metrics.spi">AbstractMetricsContext</A>, <A HREF="../../../../org/apache/hadoop/metrics/spi/CompositeContext.html" title="class in org.apache.hadoop.metrics.spi">CompositeContext</A>, <A HREF="../../../../org/apache/hadoop/metrics/file/FileContext.html" title="class in org.apache.hadoop.metrics.file">FileContext</A>, <A HREF="../../../../org/apache/hadoop/metrics/ganglia/GangliaContext.html" title="class in org.apache.hadoop.metrics.ganglia">GangliaContext</A>, <A HREF="../../../../org/apache/hadoop/metrics/spi/NullContext.html" title="class in org.apache.hadoop.metrics.spi">NullContext</A>, <A HREF="../../../../org/apache/hadoop/metrics/spi/NullContextWithUpdateThread.html" title="class in org.apache.hadoop.metrics.spi">NullContextWithUpdateThread</A></DD> |
---|
96 | </DL> |
---|
97 | <HR> |
---|
98 | <DL> |
---|
99 | <DT><PRE>public interface <B>MetricsContext</B></DL> |
---|
100 | </PRE> |
---|
101 | |
---|
102 | <P> |
---|
103 | The main interface to the metrics package. |
---|
104 | <P> |
---|
105 | |
---|
106 | <P> |
---|
107 | <HR> |
---|
108 | |
---|
109 | <P> |
---|
110 | <!-- =========== FIELD SUMMARY =========== --> |
---|
111 | |
---|
112 | <A NAME="field_summary"><!-- --></A> |
---|
113 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
114 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
115 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
116 | <B>Field Summary</B></FONT></TH> |
---|
117 | </TR> |
---|
118 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
119 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
120 | <CODE>static int</CODE></FONT></TD> |
---|
121 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#DEFAULT_PERIOD">DEFAULT_PERIOD</A></B></CODE> |
---|
122 | |
---|
123 | <BR> |
---|
124 | Default period in seconds at which data is sent to the metrics system.</TD> |
---|
125 | </TR> |
---|
126 | </TABLE> |
---|
127 | |
---|
128 | <!-- ========== METHOD SUMMARY =========== --> |
---|
129 | |
---|
130 | <A NAME="method_summary"><!-- --></A> |
---|
131 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
132 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
133 | <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
---|
134 | <B>Method Summary</B></FONT></TH> |
---|
135 | </TR> |
---|
136 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
137 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
138 | <CODE> void</CODE></FONT></TD> |
---|
139 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#close()">close</A></B>()</CODE> |
---|
140 | |
---|
141 | <BR> |
---|
142 | Stops monitoring and also frees any buffered data, returning this |
---|
143 | object to its initial state.</TD> |
---|
144 | </TR> |
---|
145 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
146 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
147 | <CODE> <A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html" title="interface in org.apache.hadoop.metrics">MetricsRecord</A></CODE></FONT></TD> |
---|
148 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#createRecord(java.lang.String)">createRecord</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> recordName)</CODE> |
---|
149 | |
---|
150 | <BR> |
---|
151 | Creates a new MetricsRecord instance with the given <code>recordName</code>.</TD> |
---|
152 | </TR> |
---|
153 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
154 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
155 | <CODE> <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A></CODE></FONT></TD> |
---|
156 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#getContextName()">getContextName</A></B>()</CODE> |
---|
157 | |
---|
158 | <BR> |
---|
159 | Returns the context name.</TD> |
---|
160 | </TR> |
---|
161 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
162 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
163 | <CODE> int</CODE></FONT></TD> |
---|
164 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#getPeriod()">getPeriod</A></B>()</CODE> |
---|
165 | |
---|
166 | <BR> |
---|
167 | Returns the timer period.</TD> |
---|
168 | </TR> |
---|
169 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
170 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
171 | <CODE> void</CODE></FONT></TD> |
---|
172 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#init(java.lang.String, org.apache.hadoop.metrics.ContextFactory)">init</A></B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> contextName, |
---|
173 | <A HREF="../../../../org/apache/hadoop/metrics/ContextFactory.html" title="class in org.apache.hadoop.metrics">ContextFactory</A> factory)</CODE> |
---|
174 | |
---|
175 | <BR> |
---|
176 | Initialize this context.</TD> |
---|
177 | </TR> |
---|
178 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
179 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
180 | <CODE> boolean</CODE></FONT></TD> |
---|
181 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#isMonitoring()">isMonitoring</A></B>()</CODE> |
---|
182 | |
---|
183 | <BR> |
---|
184 | Returns true if monitoring is currently in progress.</TD> |
---|
185 | </TR> |
---|
186 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
187 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
188 | <CODE> void</CODE></FONT></TD> |
---|
189 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#registerUpdater(org.apache.hadoop.metrics.Updater)">registerUpdater</A></B>(<A HREF="../../../../org/apache/hadoop/metrics/Updater.html" title="interface in org.apache.hadoop.metrics">Updater</A> updater)</CODE> |
---|
190 | |
---|
191 | <BR> |
---|
192 | Registers a callback to be called at regular time intervals, as |
---|
193 | determined by the implementation-class specific configuration.</TD> |
---|
194 | </TR> |
---|
195 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
196 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
197 | <CODE> void</CODE></FONT></TD> |
---|
198 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#startMonitoring()">startMonitoring</A></B>()</CODE> |
---|
199 | |
---|
200 | <BR> |
---|
201 | Starts or restarts monitoring, the emitting of metrics records as they are |
---|
202 | updated.</TD> |
---|
203 | </TR> |
---|
204 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
205 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
206 | <CODE> void</CODE></FONT></TD> |
---|
207 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#stopMonitoring()">stopMonitoring</A></B>()</CODE> |
---|
208 | |
---|
209 | <BR> |
---|
210 | Stops monitoring.</TD> |
---|
211 | </TR> |
---|
212 | <TR BGCOLOR="white" CLASS="TableRowColor"> |
---|
213 | <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
---|
214 | <CODE> void</CODE></FONT></TD> |
---|
215 | <TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#unregisterUpdater(org.apache.hadoop.metrics.Updater)">unregisterUpdater</A></B>(<A HREF="../../../../org/apache/hadoop/metrics/Updater.html" title="interface in org.apache.hadoop.metrics">Updater</A> updater)</CODE> |
---|
216 | |
---|
217 | <BR> |
---|
218 | Removes a callback, if it exists.</TD> |
---|
219 | </TR> |
---|
220 | </TABLE> |
---|
221 | |
---|
222 | <P> |
---|
223 | |
---|
224 | <!-- ============ FIELD DETAIL =========== --> |
---|
225 | |
---|
226 | <A NAME="field_detail"><!-- --></A> |
---|
227 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
228 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
229 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
230 | <B>Field Detail</B></FONT></TH> |
---|
231 | </TR> |
---|
232 | </TABLE> |
---|
233 | |
---|
234 | <A NAME="DEFAULT_PERIOD"><!-- --></A><H3> |
---|
235 | DEFAULT_PERIOD</H3> |
---|
236 | <PRE> |
---|
237 | static final int <B>DEFAULT_PERIOD</B></PRE> |
---|
238 | <DL> |
---|
239 | <DD>Default period in seconds at which data is sent to the metrics system. |
---|
240 | <P> |
---|
241 | <DL> |
---|
242 | <DT><B>See Also:</B><DD><A HREF="../../../../constant-values.html#org.apache.hadoop.metrics.MetricsContext.DEFAULT_PERIOD">Constant Field Values</A></DL> |
---|
243 | </DL> |
---|
244 | |
---|
245 | <!-- ============ METHOD DETAIL ========== --> |
---|
246 | |
---|
247 | <A NAME="method_detail"><!-- --></A> |
---|
248 | <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
---|
249 | <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
---|
250 | <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
---|
251 | <B>Method Detail</B></FONT></TH> |
---|
252 | </TR> |
---|
253 | </TABLE> |
---|
254 | |
---|
255 | <A NAME="init(java.lang.String, org.apache.hadoop.metrics.ContextFactory)"><!-- --></A><H3> |
---|
256 | init</H3> |
---|
257 | <PRE> |
---|
258 | void <B>init</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> contextName, |
---|
259 | <A HREF="../../../../org/apache/hadoop/metrics/ContextFactory.html" title="class in org.apache.hadoop.metrics">ContextFactory</A> factory)</PRE> |
---|
260 | <DL> |
---|
261 | <DD>Initialize this context. |
---|
262 | <P> |
---|
263 | <DD><DL> |
---|
264 | <DT><B>Parameters:</B><DD><CODE>contextName</CODE> - The given name for this context<DD><CODE>factory</CODE> - The creator of this context</DL> |
---|
265 | </DD> |
---|
266 | </DL> |
---|
267 | <HR> |
---|
268 | |
---|
269 | <A NAME="getContextName()"><!-- --></A><H3> |
---|
270 | getContextName</H3> |
---|
271 | <PRE> |
---|
272 | <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> <B>getContextName</B>()</PRE> |
---|
273 | <DL> |
---|
274 | <DD>Returns the context name. |
---|
275 | <P> |
---|
276 | <DD><DL> |
---|
277 | |
---|
278 | <DT><B>Returns:</B><DD>the context name</DL> |
---|
279 | </DD> |
---|
280 | </DL> |
---|
281 | <HR> |
---|
282 | |
---|
283 | <A NAME="startMonitoring()"><!-- --></A><H3> |
---|
284 | startMonitoring</H3> |
---|
285 | <PRE> |
---|
286 | void <B>startMonitoring</B>() |
---|
287 | throws <A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></PRE> |
---|
288 | <DL> |
---|
289 | <DD>Starts or restarts monitoring, the emitting of metrics records as they are |
---|
290 | updated. |
---|
291 | <P> |
---|
292 | <DD><DL> |
---|
293 | |
---|
294 | <DT><B>Throws:</B> |
---|
295 | <DD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/io/IOException.html?is-external=true" title="class or interface in java.io">IOException</A></CODE></DL> |
---|
296 | </DD> |
---|
297 | </DL> |
---|
298 | <HR> |
---|
299 | |
---|
300 | <A NAME="stopMonitoring()"><!-- --></A><H3> |
---|
301 | stopMonitoring</H3> |
---|
302 | <PRE> |
---|
303 | void <B>stopMonitoring</B>()</PRE> |
---|
304 | <DL> |
---|
305 | <DD>Stops monitoring. This does not free any data that the implementation |
---|
306 | may have buffered for sending at the next timer event. It |
---|
307 | is OK to call <code>startMonitoring()</code> again after calling |
---|
308 | this. |
---|
309 | <P> |
---|
310 | <DD><DL> |
---|
311 | <DT><B>See Also:</B><DD><A HREF="../../../../org/apache/hadoop/metrics/MetricsContext.html#close()"><CODE>close()</CODE></A></DL> |
---|
312 | </DD> |
---|
313 | </DL> |
---|
314 | <HR> |
---|
315 | |
---|
316 | <A NAME="isMonitoring()"><!-- --></A><H3> |
---|
317 | isMonitoring</H3> |
---|
318 | <PRE> |
---|
319 | boolean <B>isMonitoring</B>()</PRE> |
---|
320 | <DL> |
---|
321 | <DD>Returns true if monitoring is currently in progress. |
---|
322 | <P> |
---|
323 | <DD><DL> |
---|
324 | </DL> |
---|
325 | </DD> |
---|
326 | </DL> |
---|
327 | <HR> |
---|
328 | |
---|
329 | <A NAME="close()"><!-- --></A><H3> |
---|
330 | close</H3> |
---|
331 | <PRE> |
---|
332 | void <B>close</B>()</PRE> |
---|
333 | <DL> |
---|
334 | <DD>Stops monitoring and also frees any buffered data, returning this |
---|
335 | object to its initial state. |
---|
336 | <P> |
---|
337 | <DD><DL> |
---|
338 | </DL> |
---|
339 | </DD> |
---|
340 | </DL> |
---|
341 | <HR> |
---|
342 | |
---|
343 | <A NAME="createRecord(java.lang.String)"><!-- --></A><H3> |
---|
344 | createRecord</H3> |
---|
345 | <PRE> |
---|
346 | <A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html" title="interface in org.apache.hadoop.metrics">MetricsRecord</A> <B>createRecord</B>(<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> recordName)</PRE> |
---|
347 | <DL> |
---|
348 | <DD>Creates a new MetricsRecord instance with the given <code>recordName</code>. |
---|
349 | Throws an exception if the metrics implementation is configured with a fixed |
---|
350 | set of record names and <code>recordName</code> is not in that set. |
---|
351 | <P> |
---|
352 | <DD><DL> |
---|
353 | <DT><B>Parameters:</B><DD><CODE>recordName</CODE> - the name of the record |
---|
354 | <DT><B>Throws:</B> |
---|
355 | <DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if recordName conflicts with configuration data</DL> |
---|
356 | </DD> |
---|
357 | </DL> |
---|
358 | <HR> |
---|
359 | |
---|
360 | <A NAME="registerUpdater(org.apache.hadoop.metrics.Updater)"><!-- --></A><H3> |
---|
361 | registerUpdater</H3> |
---|
362 | <PRE> |
---|
363 | void <B>registerUpdater</B>(<A HREF="../../../../org/apache/hadoop/metrics/Updater.html" title="interface in org.apache.hadoop.metrics">Updater</A> updater)</PRE> |
---|
364 | <DL> |
---|
365 | <DD>Registers a callback to be called at regular time intervals, as |
---|
366 | determined by the implementation-class specific configuration. |
---|
367 | <P> |
---|
368 | <DD><DL> |
---|
369 | <DT><B>Parameters:</B><DD><CODE>updater</CODE> - object to be run periodically; it should updated |
---|
370 | some metrics records and then return</DL> |
---|
371 | </DD> |
---|
372 | </DL> |
---|
373 | <HR> |
---|
374 | |
---|
375 | <A NAME="unregisterUpdater(org.apache.hadoop.metrics.Updater)"><!-- --></A><H3> |
---|
376 | unregisterUpdater</H3> |
---|
377 | <PRE> |
---|
378 | void <B>unregisterUpdater</B>(<A HREF="../../../../org/apache/hadoop/metrics/Updater.html" title="interface in org.apache.hadoop.metrics">Updater</A> updater)</PRE> |
---|
379 | <DL> |
---|
380 | <DD>Removes a callback, if it exists. |
---|
381 | <P> |
---|
382 | <DD><DL> |
---|
383 | <DT><B>Parameters:</B><DD><CODE>updater</CODE> - object to be removed from the callback list</DL> |
---|
384 | </DD> |
---|
385 | </DL> |
---|
386 | <HR> |
---|
387 | |
---|
388 | <A NAME="getPeriod()"><!-- --></A><H3> |
---|
389 | getPeriod</H3> |
---|
390 | <PRE> |
---|
391 | int <B>getPeriod</B>()</PRE> |
---|
392 | <DL> |
---|
393 | <DD>Returns the timer period. |
---|
394 | <P> |
---|
395 | <DD><DL> |
---|
396 | </DL> |
---|
397 | </DD> |
---|
398 | </DL> |
---|
399 | <!-- ========= END OF CLASS DATA ========= --> |
---|
400 | <HR> |
---|
401 | |
---|
402 | |
---|
403 | <!-- ======= START OF BOTTOM NAVBAR ====== --> |
---|
404 | <A NAME="navbar_bottom"><!-- --></A> |
---|
405 | <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
---|
406 | <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
---|
407 | <TR> |
---|
408 | <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
---|
409 | <A NAME="navbar_bottom_firstrow"><!-- --></A> |
---|
410 | <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
---|
411 | <TR ALIGN="center" VALIGN="top"> |
---|
412 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
---|
413 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
---|
414 | <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
---|
415 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/MetricsContext.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
---|
416 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
---|
417 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
---|
418 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
---|
419 | <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
---|
420 | </TR> |
---|
421 | </TABLE> |
---|
422 | </TD> |
---|
423 | <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
---|
424 | </EM> |
---|
425 | </TD> |
---|
426 | </TR> |
---|
427 | |
---|
428 | <TR> |
---|
429 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
430 | <A HREF="../../../../org/apache/hadoop/metrics/ContextFactory.html" title="class in org.apache.hadoop.metrics"><B>PREV CLASS</B></A> |
---|
431 | <A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics"><B>NEXT CLASS</B></A></FONT></TD> |
---|
432 | <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
---|
433 | <A HREF="../../../../index.html?org/apache/hadoop/metrics/MetricsContext.html" target="_top"><B>FRAMES</B></A> |
---|
434 | <A HREF="MetricsContext.html" target="_top"><B>NO FRAMES</B></A> |
---|
435 | <SCRIPT type="text/javascript"> |
---|
436 | <!-- |
---|
437 | if(window==top) { |
---|
438 | document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
---|
439 | } |
---|
440 | //--> |
---|
441 | </SCRIPT> |
---|
442 | <NOSCRIPT> |
---|
443 | <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A> |
---|
444 | </NOSCRIPT> |
---|
445 | |
---|
446 | |
---|
447 | </FONT></TD> |
---|
448 | </TR> |
---|
449 | <TR> |
---|
450 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
451 | SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
---|
452 | <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
---|
453 | DETAIL: <A HREF="#field_detail">FIELD</A> | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
---|
454 | </TR> |
---|
455 | </TABLE> |
---|
456 | <A NAME="skip-navbar_bottom"></A> |
---|
457 | <!-- ======== END OF BOTTOM NAVBAR ======= --> |
---|
458 | |
---|
459 | <HR> |
---|
460 | Copyright © 2009 The Apache Software Foundation |
---|
461 | </BODY> |
---|
462 | </HTML> |
---|