source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/ipc/metrics/RpcMgtMBean.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: 14.7 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>
7RpcMgtMBean (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="RpcMgtMBean (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/RpcMgtMBean.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/ipc/metrics/RpcMetrics.html" title="class in org.apache.hadoop.ipc.metrics"><B>PREV CLASS</B></A>&nbsp;
59&nbsp;NEXT CLASS</FONT></TD>
60<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
61  <A HREF="../../../../../index.html?org/apache/hadoop/ipc/metrics/RpcMgtMBean.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RpcMgtMBean.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.ipc.metrics</FONT>
92<BR>
93Interface RpcMgtMBean</H2>
94<HR>
95<DL>
96<DT><PRE>public interface <B>RpcMgtMBean</B></DL>
97</PRE>
98
99<P>
100This is the JMX management interface for the RPC layer.
101 Many of the statistics are sampled and averaged on an interval
102 which can be specified in the metrics config file.
103 <p>
104 For the statistics that are sampled and averaged, one must specify
105 a metrics context that does periodic update calls. Most do.
106 The default Null metrics context however does NOT. So if you aren't
107 using any other metrics context then you can turn on the viewing and averaging
108 of sampled metrics by  specifying the following two lines
109  in the hadoop-meterics.properties file:
110  <pre>
111        rpc.class=org.apache.hadoop.metrics.spi.NullContextWithUpdateThread
112        rpc.period=10
113  </pre>
114<p>
115 Note that the metrics are collected regardless of the context used.
116 The context with the update thread is used to average the data periodically
117<P>
118
119<P>
120<HR>
121
122<P>
123
124<!-- ========== METHOD SUMMARY =========== -->
125
126<A NAME="method_summary"><!-- --></A>
127<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
128<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
129<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
130<B>Method Summary</B></FONT></TH>
131</TR>
132<TR BGCOLOR="white" CLASS="TableRowColor">
133<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
134<CODE>&nbsp;int</CODE></FONT></TD>
135<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getCallQueueLen()">getCallQueueLen</A></B>()</CODE>
136
137<BR>
138&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of rpc calls in the queue.</TD>
139</TR>
140<TR BGCOLOR="white" CLASS="TableRowColor">
141<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
142<CODE>&nbsp;int</CODE></FONT></TD>
143<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getNumOpenConnections()">getNumOpenConnections</A></B>()</CODE>
144
145<BR>
146&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The number of open RPC conections</TD>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
150<CODE>&nbsp;long</CODE></FONT></TD>
151<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getRpcOpsAvgProcessingTime()">getRpcOpsAvgProcessingTime</A></B>()</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Average time for RPC Operations in last interval</TD>
155</TR>
156<TR BGCOLOR="white" CLASS="TableRowColor">
157<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
158<CODE>&nbsp;long</CODE></FONT></TD>
159<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getRpcOpsAvgProcessingTimeMax()">getRpcOpsAvgProcessingTimeMax</A></B>()</CODE>
160
161<BR>
162&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Maximum RPC Operation Processing Time since reset was called</TD>
163</TR>
164<TR BGCOLOR="white" CLASS="TableRowColor">
165<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
166<CODE>&nbsp;long</CODE></FONT></TD>
167<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getRpcOpsAvgProcessingTimeMin()">getRpcOpsAvgProcessingTimeMin</A></B>()</CODE>
168
169<BR>
170&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Minimum RPC Operation Processing Time since reset was called</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>&nbsp;long</CODE></FONT></TD>
175<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getRpcOpsAvgQueueTime()">getRpcOpsAvgQueueTime</A></B>()</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Average RPC Operation Queued Time in the last interval</TD>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
182<CODE>&nbsp;long</CODE></FONT></TD>
183<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getRpcOpsAvgQueueTimeMax()">getRpcOpsAvgQueueTimeMax</A></B>()</CODE>
184
185<BR>
186&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Maximum RPC Operation Queued Time since reset was called</TD>
187</TR>
188<TR BGCOLOR="white" CLASS="TableRowColor">
189<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
190<CODE>&nbsp;long</CODE></FONT></TD>
191<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getRpcOpsAvgQueueTimeMin()">getRpcOpsAvgQueueTimeMin</A></B>()</CODE>
192
193<BR>
194&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The Minimum RPC Operation Queued Time since reset was called</TD>
195</TR>
196<TR BGCOLOR="white" CLASS="TableRowColor">
197<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
198<CODE>&nbsp;int</CODE></FONT></TD>
199<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#getRpcOpsNumber()">getRpcOpsNumber</A></B>()</CODE>
200
201<BR>
202&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Number of RPC Operations in the last interval</TD>
203</TR>
204<TR BGCOLOR="white" CLASS="TableRowColor">
205<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
206<CODE>&nbsp;void</CODE></FONT></TD>
207<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMgtMBean.html#resetAllMinMax()">resetAllMinMax</A></B>()</CODE>
208
209<BR>
210&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reset all min max times</TD>
211</TR>
212</TABLE>
213&nbsp;
214<P>
215
216<!-- ============ METHOD DETAIL ========== -->
217
218<A NAME="method_detail"><!-- --></A>
219<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
220<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
221<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
222<B>Method Detail</B></FONT></TH>
223</TR>
224</TABLE>
225
226<A NAME="getRpcOpsNumber()"><!-- --></A><H3>
227getRpcOpsNumber</H3>
228<PRE>
229int <B>getRpcOpsNumber</B>()</PRE>
230<DL>
231<DD>Number of RPC Operations in the last interval
232<P>
233<DD><DL>
234
235<DT><B>Returns:</B><DD>number of operations</DL>
236</DD>
237</DL>
238<HR>
239
240<A NAME="getRpcOpsAvgProcessingTime()"><!-- --></A><H3>
241getRpcOpsAvgProcessingTime</H3>
242<PRE>
243long <B>getRpcOpsAvgProcessingTime</B>()</PRE>
244<DL>
245<DD>Average time for RPC Operations in last interval
246<P>
247<DD><DL>
248
249<DT><B>Returns:</B><DD>time in msec</DL>
250</DD>
251</DL>
252<HR>
253
254<A NAME="getRpcOpsAvgProcessingTimeMin()"><!-- --></A><H3>
255getRpcOpsAvgProcessingTimeMin</H3>
256<PRE>
257long <B>getRpcOpsAvgProcessingTimeMin</B>()</PRE>
258<DL>
259<DD>The Minimum RPC Operation Processing Time since reset was called
260<P>
261<DD><DL>
262
263<DT><B>Returns:</B><DD>time in msec</DL>
264</DD>
265</DL>
266<HR>
267
268<A NAME="getRpcOpsAvgProcessingTimeMax()"><!-- --></A><H3>
269getRpcOpsAvgProcessingTimeMax</H3>
270<PRE>
271long <B>getRpcOpsAvgProcessingTimeMax</B>()</PRE>
272<DL>
273<DD>The Maximum RPC Operation Processing Time since reset was called
274<P>
275<DD><DL>
276
277<DT><B>Returns:</B><DD>time in msec</DL>
278</DD>
279</DL>
280<HR>
281
282<A NAME="getRpcOpsAvgQueueTime()"><!-- --></A><H3>
283getRpcOpsAvgQueueTime</H3>
284<PRE>
285long <B>getRpcOpsAvgQueueTime</B>()</PRE>
286<DL>
287<DD>The Average RPC Operation Queued Time in the last interval
288<P>
289<DD><DL>
290
291<DT><B>Returns:</B><DD>time in msec</DL>
292</DD>
293</DL>
294<HR>
295
296<A NAME="getRpcOpsAvgQueueTimeMin()"><!-- --></A><H3>
297getRpcOpsAvgQueueTimeMin</H3>
298<PRE>
299long <B>getRpcOpsAvgQueueTimeMin</B>()</PRE>
300<DL>
301<DD>The Minimum RPC Operation Queued Time since reset was called
302<P>
303<DD><DL>
304
305<DT><B>Returns:</B><DD>time in msec</DL>
306</DD>
307</DL>
308<HR>
309
310<A NAME="getRpcOpsAvgQueueTimeMax()"><!-- --></A><H3>
311getRpcOpsAvgQueueTimeMax</H3>
312<PRE>
313long <B>getRpcOpsAvgQueueTimeMax</B>()</PRE>
314<DL>
315<DD>The Maximum RPC Operation Queued Time since reset was called
316<P>
317<DD><DL>
318
319<DT><B>Returns:</B><DD>time in msec</DL>
320</DD>
321</DL>
322<HR>
323
324<A NAME="resetAllMinMax()"><!-- --></A><H3>
325resetAllMinMax</H3>
326<PRE>
327void <B>resetAllMinMax</B>()</PRE>
328<DL>
329<DD>Reset all min max times
330<P>
331<DD><DL>
332</DL>
333</DD>
334</DL>
335<HR>
336
337<A NAME="getNumOpenConnections()"><!-- --></A><H3>
338getNumOpenConnections</H3>
339<PRE>
340int <B>getNumOpenConnections</B>()</PRE>
341<DL>
342<DD>The number of open RPC conections
343<P>
344<DD><DL>
345
346<DT><B>Returns:</B><DD>the number of open rpc connections</DL>
347</DD>
348</DL>
349<HR>
350
351<A NAME="getCallQueueLen()"><!-- --></A><H3>
352getCallQueueLen</H3>
353<PRE>
354int <B>getCallQueueLen</B>()</PRE>
355<DL>
356<DD>The number of rpc calls in the queue.
357<P>
358<DD><DL>
359
360<DT><B>Returns:</B><DD>The number of rpc calls in the queue.</DL>
361</DD>
362</DL>
363<!-- ========= END OF CLASS DATA ========= -->
364<HR>
365
366
367<!-- ======= START OF BOTTOM NAVBAR ====== -->
368<A NAME="navbar_bottom"><!-- --></A>
369<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
370<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
371<TR>
372<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
373<A NAME="navbar_bottom_firstrow"><!-- --></A>
374<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
375  <TR ALIGN="center" VALIGN="top">
376  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
377  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
378  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
379  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RpcMgtMBean.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
380  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
381  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
382  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
383  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
384  </TR>
385</TABLE>
386</TD>
387<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
388</EM>
389</TD>
390</TR>
391
392<TR>
393<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
394&nbsp;<A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMetrics.html" title="class in org.apache.hadoop.ipc.metrics"><B>PREV CLASS</B></A>&nbsp;
395&nbsp;NEXT CLASS</FONT></TD>
396<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
397  <A HREF="../../../../../index.html?org/apache/hadoop/ipc/metrics/RpcMgtMBean.html" target="_top"><B>FRAMES</B></A>  &nbsp;
398&nbsp;<A HREF="RpcMgtMBean.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
399&nbsp;<SCRIPT type="text/javascript">
400  <!--
401  if(window==top) {
402    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
403  }
404  //-->
405</SCRIPT>
406<NOSCRIPT>
407  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
408</NOSCRIPT>
409
410
411</FONT></TD>
412</TR>
413<TR>
414<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
415  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
416<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
417DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
418</TR>
419</TABLE>
420<A NAME="skip-navbar_bottom"></A>
421<!-- ======== END OF BOTTOM NAVBAR ======= -->
422
423<HR>
424Copyright &copy; 2009 The Apache Software Foundation
425</BODY>
426</HTML>
Note: See TracBrowser for help on using the repository browser.