source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/metrics/MetricsRecord.html @ 120

Last change on this file since 120 was 120, checked in by (none), 14 years ago

Added the mail files for the Hadoop JUNit Project

  • Property svn:executable set to *
File size: 33.2 KB
Line 
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>
7MetricsRecord (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">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="MetricsRecord (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>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MetricsRecord.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
47  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</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&nbsp;<A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;<A HREF="../../../../org/apache/hadoop/metrics/MetricsUtil.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/MetricsRecord.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="MetricsRecord.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
63&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<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">
91org.apache.hadoop.metrics</FONT>
92<BR>
93Interface MetricsRecord</H2>
94<DL>
95<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../org/apache/hadoop/metrics/spi/MetricsRecordImpl.html" title="class in org.apache.hadoop.metrics.spi">MetricsRecordImpl</A></DD>
96</DL>
97<HR>
98<DL>
99<DT><PRE>public interface <B>MetricsRecord</B></DL>
100</PRE>
101
102<P>
103A named and optionally tagged set of records to be sent to the metrics
104 system. <p/>
105
106 A record name identifies the kind of data to be reported. For example, a
107 program reporting statistics relating to the disks on a computer might use
108 a record name "diskStats".<p/>
109
110 A record has zero or more <i>tags</i>. A tag has a name and a value. To
111 continue the example, the "diskStats" record might use a tag named
112 "diskName" to identify a particular disk.  Sometimes it is useful to have
113 more than one tag, so there might also be a "diskType" with value "ide" or
114 "scsi" or whatever.<p/>
115
116 A record also has zero or more <i>metrics</i>.  These are the named
117 values that are to be reported to the metrics system.  In the "diskStats"
118 example, possible metric names would be "diskPercentFull", "diskPercentBusy",
119 "kbReadPerSecond", etc.<p/>
120 
121 The general procedure for using a MetricsRecord is to fill in its tag and
122 metric values, and then call <code>update()</code> to pass the record to the
123 client library.
124 Metric data is not immediately sent to the metrics system
125 each time that <code>update()</code> is called.
126 An internal table is maintained, identified by the record name. This
127 table has columns
128 corresponding to the tag and the metric names, and rows
129 corresponding to each unique set of tag values. An update
130 either modifies an existing row in the table, or adds a new row with a set of
131 tag values that are different from all the other rows.  Note that if there
132 are no tags, then there can be at most one row in the table. <p/>
133 
134 Once a row is added to the table, its data will be sent to the metrics system
135 on every timer period, whether or not it has been updated since the previous
136 timer period.  If this is inappropriate, for example if metrics were being
137 reported by some transient object in an application, the <code>remove()</code>
138 method can be used to remove the row and thus stop the data from being
139 sent.<p/>
140
141 Note that the <code>update()</code> method is atomic.  This means that it is
142 safe for different threads to be updating the same metric.  More precisely,
143 it is OK for different threads to call <code>update()</code> on MetricsRecord instances
144 with the same set of tag names and tag values.  Different threads should
145 <b>not</b> use the same MetricsRecord instance at the same time.
146<P>
147
148<P>
149<HR>
150
151<P>
152
153<!-- ========== METHOD SUMMARY =========== -->
154
155<A NAME="method_summary"><!-- --></A>
156<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
157<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
158<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
159<B>Method Summary</B></FONT></TH>
160</TR>
161<TR BGCOLOR="white" CLASS="TableRowColor">
162<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
163<CODE>&nbsp;<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>
164<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#getRecordName()">getRecordName</A></B>()</CODE>
165
166<BR>
167&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the record name.</TD>
168</TR>
169<TR BGCOLOR="white" CLASS="TableRowColor">
170<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
171<CODE>&nbsp;void</CODE></FONT></TD>
172<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#incrMetric(java.lang.String, byte)">incrMetric</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>&nbsp;metricName,
173           byte&nbsp;metricValue)</CODE>
174
175<BR>
176&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increments the named metric by the specified value.</TD>
177</TR>
178<TR BGCOLOR="white" CLASS="TableRowColor">
179<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
180<CODE>&nbsp;void</CODE></FONT></TD>
181<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#incrMetric(java.lang.String, float)">incrMetric</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>&nbsp;metricName,
182           float&nbsp;metricValue)</CODE>
183
184<BR>
185&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increments the named metric by the specified value.</TD>
186</TR>
187<TR BGCOLOR="white" CLASS="TableRowColor">
188<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
189<CODE>&nbsp;void</CODE></FONT></TD>
190<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#incrMetric(java.lang.String, int)">incrMetric</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>&nbsp;metricName,
191           int&nbsp;metricValue)</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increments the named metric by the specified value.</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;void</CODE></FONT></TD>
199<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#incrMetric(java.lang.String, long)">incrMetric</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>&nbsp;metricName,
200           long&nbsp;metricValue)</CODE>
201
202<BR>
203&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increments the named metric by the specified value.</TD>
204</TR>
205<TR BGCOLOR="white" CLASS="TableRowColor">
206<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
207<CODE>&nbsp;void</CODE></FONT></TD>
208<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#incrMetric(java.lang.String, short)">incrMetric</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>&nbsp;metricName,
209           short&nbsp;metricValue)</CODE>
210
211<BR>
212&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increments the named metric by the specified value.</TD>
213</TR>
214<TR BGCOLOR="white" CLASS="TableRowColor">
215<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
216<CODE>&nbsp;void</CODE></FONT></TD>
217<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#remove()">remove</A></B>()</CODE>
218
219<BR>
220&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes, from the buffered data table, all rows having tags
221 that equal the tags that have been set on this record.</TD>
222</TR>
223<TR BGCOLOR="white" CLASS="TableRowColor">
224<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
225<CODE>&nbsp;void</CODE></FONT></TD>
226<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#removeTag(java.lang.String)">removeTag</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>&nbsp;tagName)</CODE>
227
228<BR>
229&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Removes any tag of the specified name.</TD>
230</TR>
231<TR BGCOLOR="white" CLASS="TableRowColor">
232<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
233<CODE>&nbsp;void</CODE></FONT></TD>
234<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setMetric(java.lang.String, byte)">setMetric</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>&nbsp;metricName,
235          byte&nbsp;metricValue)</CODE>
236
237<BR>
238&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named metric to the specified value.</TD>
239</TR>
240<TR BGCOLOR="white" CLASS="TableRowColor">
241<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
242<CODE>&nbsp;void</CODE></FONT></TD>
243<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setMetric(java.lang.String, float)">setMetric</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>&nbsp;metricName,
244          float&nbsp;metricValue)</CODE>
245
246<BR>
247&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named metric to the specified value.</TD>
248</TR>
249<TR BGCOLOR="white" CLASS="TableRowColor">
250<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
251<CODE>&nbsp;void</CODE></FONT></TD>
252<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setMetric(java.lang.String, int)">setMetric</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>&nbsp;metricName,
253          int&nbsp;metricValue)</CODE>
254
255<BR>
256&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named metric to the specified value.</TD>
257</TR>
258<TR BGCOLOR="white" CLASS="TableRowColor">
259<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
260<CODE>&nbsp;void</CODE></FONT></TD>
261<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setMetric(java.lang.String, long)">setMetric</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>&nbsp;metricName,
262          long&nbsp;metricValue)</CODE>
263
264<BR>
265&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named metric to the specified value.</TD>
266</TR>
267<TR BGCOLOR="white" CLASS="TableRowColor">
268<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269<CODE>&nbsp;void</CODE></FONT></TD>
270<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setMetric(java.lang.String, short)">setMetric</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>&nbsp;metricName,
271          short&nbsp;metricValue)</CODE>
272
273<BR>
274&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named metric to the specified value.</TD>
275</TR>
276<TR BGCOLOR="white" CLASS="TableRowColor">
277<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
278<CODE>&nbsp;void</CODE></FONT></TD>
279<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setTag(java.lang.String, byte)">setTag</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>&nbsp;tagName,
280       byte&nbsp;tagValue)</CODE>
281
282<BR>
283&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named tag to the specified value.</TD>
284</TR>
285<TR BGCOLOR="white" CLASS="TableRowColor">
286<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
287<CODE>&nbsp;void</CODE></FONT></TD>
288<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setTag(java.lang.String, int)">setTag</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>&nbsp;tagName,
289       int&nbsp;tagValue)</CODE>
290
291<BR>
292&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named tag to the specified value.</TD>
293</TR>
294<TR BGCOLOR="white" CLASS="TableRowColor">
295<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
296<CODE>&nbsp;void</CODE></FONT></TD>
297<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setTag(java.lang.String, long)">setTag</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>&nbsp;tagName,
298       long&nbsp;tagValue)</CODE>
299
300<BR>
301&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named tag to the specified value.</TD>
302</TR>
303<TR BGCOLOR="white" CLASS="TableRowColor">
304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
305<CODE>&nbsp;void</CODE></FONT></TD>
306<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setTag(java.lang.String, short)">setTag</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>&nbsp;tagName,
307       short&nbsp;tagValue)</CODE>
308
309<BR>
310&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named tag to the specified value.</TD>
311</TR>
312<TR BGCOLOR="white" CLASS="TableRowColor">
313<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
314<CODE>&nbsp;void</CODE></FONT></TD>
315<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#setTag(java.lang.String, java.lang.String)">setTag</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>&nbsp;tagName,
316       <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>&nbsp;tagValue)</CODE>
317
318<BR>
319&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the named tag to the specified value.</TD>
320</TR>
321<TR BGCOLOR="white" CLASS="TableRowColor">
322<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
323<CODE>&nbsp;void</CODE></FONT></TD>
324<TD><CODE><B><A HREF="../../../../org/apache/hadoop/metrics/MetricsRecord.html#update()">update</A></B>()</CODE>
325
326<BR>
327&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Updates the table of buffered data which is to be sent periodically.</TD>
328</TR>
329</TABLE>
330&nbsp;
331<P>
332
333<!-- ============ METHOD DETAIL ========== -->
334
335<A NAME="method_detail"><!-- --></A>
336<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
337<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
338<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
339<B>Method Detail</B></FONT></TH>
340</TR>
341</TABLE>
342
343<A NAME="getRecordName()"><!-- --></A><H3>
344getRecordName</H3>
345<PRE>
346<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>getRecordName</B>()</PRE>
347<DL>
348<DD>Returns the record name.
349<P>
350<DD><DL>
351
352<DT><B>Returns:</B><DD>the record name</DL>
353</DD>
354</DL>
355<HR>
356
357<A NAME="setTag(java.lang.String, java.lang.String)"><!-- --></A><H3>
358setTag</H3>
359<PRE>
360void <B>setTag</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>&nbsp;tagName,
361            <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>&nbsp;tagValue)</PRE>
362<DL>
363<DD>Sets the named tag to the specified value.  The tagValue may be null,
364 which is treated the same as an empty String.
365<P>
366<DD><DL>
367<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - name of the tag<DD><CODE>tagValue</CODE> - new value of the tag
368<DT><B>Throws:</B>
369<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the tagName conflicts with the configuration</DL>
370</DD>
371</DL>
372<HR>
373
374<A NAME="setTag(java.lang.String, int)"><!-- --></A><H3>
375setTag</H3>
376<PRE>
377void <B>setTag</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>&nbsp;tagName,
378            int&nbsp;tagValue)</PRE>
379<DL>
380<DD>Sets the named tag to the specified value.
381<P>
382<DD><DL>
383<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - name of the tag<DD><CODE>tagValue</CODE> - new value of the tag
384<DT><B>Throws:</B>
385<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the tagName conflicts with the configuration</DL>
386</DD>
387</DL>
388<HR>
389
390<A NAME="setTag(java.lang.String, long)"><!-- --></A><H3>
391setTag</H3>
392<PRE>
393void <B>setTag</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>&nbsp;tagName,
394            long&nbsp;tagValue)</PRE>
395<DL>
396<DD>Sets the named tag to the specified value.
397<P>
398<DD><DL>
399<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - name of the tag<DD><CODE>tagValue</CODE> - new value of the tag
400<DT><B>Throws:</B>
401<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the tagName conflicts with the configuration</DL>
402</DD>
403</DL>
404<HR>
405
406<A NAME="setTag(java.lang.String, short)"><!-- --></A><H3>
407setTag</H3>
408<PRE>
409void <B>setTag</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>&nbsp;tagName,
410            short&nbsp;tagValue)</PRE>
411<DL>
412<DD>Sets the named tag to the specified value.
413<P>
414<DD><DL>
415<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - name of the tag<DD><CODE>tagValue</CODE> - new value of the tag
416<DT><B>Throws:</B>
417<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the tagName conflicts with the configuration</DL>
418</DD>
419</DL>
420<HR>
421
422<A NAME="setTag(java.lang.String, byte)"><!-- --></A><H3>
423setTag</H3>
424<PRE>
425void <B>setTag</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>&nbsp;tagName,
426            byte&nbsp;tagValue)</PRE>
427<DL>
428<DD>Sets the named tag to the specified value.
429<P>
430<DD><DL>
431<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - name of the tag<DD><CODE>tagValue</CODE> - new value of the tag
432<DT><B>Throws:</B>
433<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the tagName conflicts with the configuration</DL>
434</DD>
435</DL>
436<HR>
437
438<A NAME="removeTag(java.lang.String)"><!-- --></A><H3>
439removeTag</H3>
440<PRE>
441void <B>removeTag</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>&nbsp;tagName)</PRE>
442<DL>
443<DD>Removes any tag of the specified name.
444<P>
445<DD><DL>
446<DT><B>Parameters:</B><DD><CODE>tagName</CODE> - name of a tag</DL>
447</DD>
448</DL>
449<HR>
450
451<A NAME="setMetric(java.lang.String, int)"><!-- --></A><H3>
452setMetric</H3>
453<PRE>
454void <B>setMetric</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>&nbsp;metricName,
455               int&nbsp;metricValue)</PRE>
456<DL>
457<DD>Sets the named metric to the specified value.
458<P>
459<DD><DL>
460<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - new value of the metric
461<DT><B>Throws:</B>
462<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
463 conflicts with the configuration</DL>
464</DD>
465</DL>
466<HR>
467
468<A NAME="setMetric(java.lang.String, long)"><!-- --></A><H3>
469setMetric</H3>
470<PRE>
471void <B>setMetric</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>&nbsp;metricName,
472               long&nbsp;metricValue)</PRE>
473<DL>
474<DD>Sets the named metric to the specified value.
475<P>
476<DD><DL>
477<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - new value of the metric
478<DT><B>Throws:</B>
479<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
480 conflicts with the configuration</DL>
481</DD>
482</DL>
483<HR>
484
485<A NAME="setMetric(java.lang.String, short)"><!-- --></A><H3>
486setMetric</H3>
487<PRE>
488void <B>setMetric</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>&nbsp;metricName,
489               short&nbsp;metricValue)</PRE>
490<DL>
491<DD>Sets the named metric to the specified value.
492<P>
493<DD><DL>
494<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - new value of the metric
495<DT><B>Throws:</B>
496<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
497 conflicts with the configuration</DL>
498</DD>
499</DL>
500<HR>
501
502<A NAME="setMetric(java.lang.String, byte)"><!-- --></A><H3>
503setMetric</H3>
504<PRE>
505void <B>setMetric</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>&nbsp;metricName,
506               byte&nbsp;metricValue)</PRE>
507<DL>
508<DD>Sets the named metric to the specified value.
509<P>
510<DD><DL>
511<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - new value of the metric
512<DT><B>Throws:</B>
513<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
514 conflicts with the configuration</DL>
515</DD>
516</DL>
517<HR>
518
519<A NAME="setMetric(java.lang.String, float)"><!-- --></A><H3>
520setMetric</H3>
521<PRE>
522void <B>setMetric</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>&nbsp;metricName,
523               float&nbsp;metricValue)</PRE>
524<DL>
525<DD>Sets the named metric to the specified value.
526<P>
527<DD><DL>
528<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - new value of the metric
529<DT><B>Throws:</B>
530<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
531 conflicts with the configuration</DL>
532</DD>
533</DL>
534<HR>
535
536<A NAME="incrMetric(java.lang.String, int)"><!-- --></A><H3>
537incrMetric</H3>
538<PRE>
539void <B>incrMetric</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>&nbsp;metricName,
540                int&nbsp;metricValue)</PRE>
541<DL>
542<DD>Increments the named metric by the specified value.
543<P>
544<DD><DL>
545<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - incremental value
546<DT><B>Throws:</B>
547<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
548 conflicts with the configuration</DL>
549</DD>
550</DL>
551<HR>
552
553<A NAME="incrMetric(java.lang.String, long)"><!-- --></A><H3>
554incrMetric</H3>
555<PRE>
556void <B>incrMetric</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>&nbsp;metricName,
557                long&nbsp;metricValue)</PRE>
558<DL>
559<DD>Increments the named metric by the specified value.
560<P>
561<DD><DL>
562<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - incremental value
563<DT><B>Throws:</B>
564<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
565 conflicts with the configuration</DL>
566</DD>
567</DL>
568<HR>
569
570<A NAME="incrMetric(java.lang.String, short)"><!-- --></A><H3>
571incrMetric</H3>
572<PRE>
573void <B>incrMetric</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>&nbsp;metricName,
574                short&nbsp;metricValue)</PRE>
575<DL>
576<DD>Increments the named metric by the specified value.
577<P>
578<DD><DL>
579<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - incremental value
580<DT><B>Throws:</B>
581<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
582 conflicts with the configuration</DL>
583</DD>
584</DL>
585<HR>
586
587<A NAME="incrMetric(java.lang.String, byte)"><!-- --></A><H3>
588incrMetric</H3>
589<PRE>
590void <B>incrMetric</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>&nbsp;metricName,
591                byte&nbsp;metricValue)</PRE>
592<DL>
593<DD>Increments the named metric by the specified value.
594<P>
595<DD><DL>
596<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - incremental value
597<DT><B>Throws:</B>
598<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
599 conflicts with the configuration</DL>
600</DD>
601</DL>
602<HR>
603
604<A NAME="incrMetric(java.lang.String, float)"><!-- --></A><H3>
605incrMetric</H3>
606<PRE>
607void <B>incrMetric</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>&nbsp;metricName,
608                float&nbsp;metricValue)</PRE>
609<DL>
610<DD>Increments the named metric by the specified value.
611<P>
612<DD><DL>
613<DT><B>Parameters:</B><DD><CODE>metricName</CODE> - name of the metric<DD><CODE>metricValue</CODE> - incremental value
614<DT><B>Throws:</B>
615<DD><CODE><A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics">MetricsException</A></CODE> - if the metricName or the type of the metricValue
616 conflicts with the configuration</DL>
617</DD>
618</DL>
619<HR>
620
621<A NAME="update()"><!-- --></A><H3>
622update</H3>
623<PRE>
624void <B>update</B>()</PRE>
625<DL>
626<DD>Updates the table of buffered data which is to be sent periodically.
627 If the tag values match an existing row, that row is updated;
628 otherwise, a new row is added.
629<P>
630<DD><DL>
631</DL>
632</DD>
633</DL>
634<HR>
635
636<A NAME="remove()"><!-- --></A><H3>
637remove</H3>
638<PRE>
639void <B>remove</B>()</PRE>
640<DL>
641<DD>Removes, from the buffered data table, all rows having tags
642 that equal the tags that have been set on this record. For example,
643 if there are no tags on this record, all rows for this record name
644 would be removed.  Or, if there is a single tag on this record, then
645 just rows containing a tag with the same name and value would be removed.
646<P>
647<DD><DL>
648</DL>
649</DD>
650</DL>
651<!-- ========= END OF CLASS DATA ========= -->
652<HR>
653
654
655<!-- ======= START OF BOTTOM NAVBAR ====== -->
656<A NAME="navbar_bottom"><!-- --></A>
657<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
658<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
659<TR>
660<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
661<A NAME="navbar_bottom_firstrow"><!-- --></A>
662<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
663  <TR ALIGN="center" VALIGN="top">
664  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
665  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
666  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
667  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/MetricsRecord.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
668  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
669  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
670  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
671  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
672  </TR>
673</TABLE>
674</TD>
675<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
676</EM>
677</TD>
678</TR>
679
680<TR>
681<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
682&nbsp;<A HREF="../../../../org/apache/hadoop/metrics/MetricsException.html" title="class in org.apache.hadoop.metrics"><B>PREV CLASS</B></A>&nbsp;
683&nbsp;<A HREF="../../../../org/apache/hadoop/metrics/MetricsUtil.html" title="class in org.apache.hadoop.metrics"><B>NEXT CLASS</B></A></FONT></TD>
684<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
685  <A HREF="../../../../index.html?org/apache/hadoop/metrics/MetricsRecord.html" target="_top"><B>FRAMES</B></A>  &nbsp;
686&nbsp;<A HREF="MetricsRecord.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
687&nbsp;<SCRIPT type="text/javascript">
688  <!--
689  if(window==top) {
690    document.writeln('<A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>');
691  }
692  //-->
693</SCRIPT>
694<NOSCRIPT>
695  <A HREF="../../../../allclasses-noframe.html"><B>All Classes</B></A>
696</NOSCRIPT>
697
698
699</FONT></TD>
700</TR>
701<TR>
702<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
703  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
704<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
705DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
706</TR>
707</TABLE>
708<A NAME="skip-navbar_bottom"></A>
709<!-- ======== END OF BOTTOM NAVBAR ======= -->
710
711<HR>
712Copyright &copy; 2009 The Apache Software Foundation
713</BODY>
714</HTML>
Note: See TracBrowser for help on using the repository browser.