source: proiecte/HadoopJUnit/hadoop-0.20.1/docs/api/org/apache/hadoop/ipc/metrics/RpcActivityMBean.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: 15.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>
7RpcActivityMBean (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="RpcActivityMBean (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/RpcActivityMBean.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;PREV CLASS&nbsp;
59&nbsp;<A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMetrics.html" title="class in org.apache.hadoop.ipc.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/ipc/metrics/RpcActivityMBean.html" target="_top"><B>FRAMES</B></A>  &nbsp;
62&nbsp;<A HREF="RpcActivityMBean.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;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
80<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
81DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&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>
93Class RpcActivityMBean</H2>
94<PRE>
95<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A>
96  <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html" title="class in org.apache.hadoop.metrics.util">org.apache.hadoop.metrics.util.MetricsDynamicMBeanBase</A>
97      <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>org.apache.hadoop.ipc.metrics.RpcActivityMBean</B>
98</PRE>
99<DL>
100<DT><B>All Implemented Interfaces:</B> <DD><A HREF="http://java.sun.com/javase/6/docs/api/javax/management/DynamicMBean.html?is-external=true" title="class or interface in javax.management">DynamicMBean</A></DD>
101</DL>
102<HR>
103<DL>
104<DT><PRE>public class <B>RpcActivityMBean</B><DT>extends <A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html" title="class in org.apache.hadoop.metrics.util">MetricsDynamicMBeanBase</A></DL>
105</PRE>
106
107<P>
108This is the JMX MBean for reporting the RPC layer Activity.
109 The MBean is register using the name
110        "hadoop:service=<RpcServiceName>,name=RpcActivityForPort<port>"
111 
112 Many of the activity metrics are sampled and averaged on an interval
113 which can be specified in the metrics config file.
114 <p>
115 For the metrics that are sampled and averaged, one must specify
116 a metrics context that does periodic update calls. Most metrics contexts do.
117 The default Null metrics context however does NOT. So if you aren't
118 using any other metrics context then you can turn on the viewing and averaging
119 of sampled metrics by  specifying the following two lines
120  in the hadoop-meterics.properties file:
121  <pre>
122        rpc.class=org.apache.hadoop.metrics.spi.NullContextWithUpdateThread
123        rpc.period=10
124  </pre>
125<p>
126 Note that the metrics are collected regardless of the context used.
127 The context with the update thread is used to average the data periodically
128
129
130
131 Impl details: We use a dynamic mbean that gets the list of the metrics
132 from the metrics registry passed as an argument to the constructor
133<P>
134
135<P>
136<HR>
137
138<P>
139
140<!-- ======== CONSTRUCTOR SUMMARY ======== -->
141
142<A NAME="constructor_summary"><!-- --></A>
143<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
144<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
145<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
146<B>Constructor Summary</B></FONT></TH>
147</TR>
148<TR BGCOLOR="white" CLASS="TableRowColor">
149<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcActivityMBean.html#RpcActivityMBean(org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String, java.lang.String)">RpcActivityMBean</A></B>(<A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsRegistry.html" title="class in org.apache.hadoop.metrics.util">MetricsRegistry</A>&nbsp;mr,
150                 <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;serviceName,
151                 <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;port)</CODE>
152
153<BR>
154&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
155</TR>
156</TABLE>
157&nbsp;
158<!-- ========== METHOD SUMMARY =========== -->
159
160<A NAME="method_summary"><!-- --></A>
161<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
162<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
163<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
164<B>Method Summary</B></FONT></TH>
165</TR>
166<TR BGCOLOR="white" CLASS="TableRowColor">
167<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
168<CODE>&nbsp;void</CODE></FONT></TD>
169<TD><CODE><B><A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcActivityMBean.html#shutdown()">shutdown</A></B>()</CODE>
170
171<BR>
172&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
173</TR>
174</TABLE>
175&nbsp;<A NAME="methods_inherited_from_class_org.apache.hadoop.metrics.util.MetricsDynamicMBeanBase"><!-- --></A>
176<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
177<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
178<TH ALIGN="left"><B>Methods inherited from class org.apache.hadoop.metrics.util.<A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html" title="class in org.apache.hadoop.metrics.util">MetricsDynamicMBeanBase</A></B></TH>
179</TR>
180<TR BGCOLOR="white" CLASS="TableRowColor">
181<TD><CODE><A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html#getAttribute(java.lang.String)">getAttribute</A>, <A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html#getAttributes(java.lang.String[])">getAttributes</A>, <A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html#getMBeanInfo()">getMBeanInfo</A>, <A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html#invoke(java.lang.String, java.lang.Object[], java.lang.String[])">invoke</A>, <A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html#setAttribute(javax.management.Attribute)">setAttribute</A>, <A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsDynamicMBeanBase.html#setAttributes(javax.management.AttributeList)">setAttributes</A></CODE></TD>
182</TR>
183</TABLE>
184&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
185<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
186<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
187<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH>
188</TR>
189<TR BGCOLOR="white" CLASS="TableRowColor">
190<TD><CODE><A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</A>, <A HREF="http://java.sun.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</A></CODE></TD>
191</TR>
192</TABLE>
193&nbsp;
194<P>
195
196<!-- ========= CONSTRUCTOR DETAIL ======== -->
197
198<A NAME="constructor_detail"><!-- --></A>
199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
200<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
201<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
202<B>Constructor Detail</B></FONT></TH>
203</TR>
204</TABLE>
205
206<A NAME="RpcActivityMBean(org.apache.hadoop.metrics.util.MetricsRegistry, java.lang.String, java.lang.String)"><!-- --></A><H3>
207RpcActivityMBean</H3>
208<PRE>
209public <B>RpcActivityMBean</B>(<A HREF="../../../../../org/apache/hadoop/metrics/util/MetricsRegistry.html" title="class in org.apache.hadoop.metrics.util">MetricsRegistry</A>&nbsp;mr,
210                        <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;serviceName,
211                        <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;port)</PRE>
212<DL>
213<DL>
214<DT><B>Parameters:</B><DD><CODE>mr</CODE> - - the metrics registry that has all the metrics<DD><CODE>serviceName</CODE> - - the service name for the rpc service<DD><CODE>port</CODE> - - the rpc port.</DL>
215</DL>
216
217<!-- ============ METHOD DETAIL ========== -->
218
219<A NAME="method_detail"><!-- --></A>
220<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
221<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
222<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
223<B>Method Detail</B></FONT></TH>
224</TR>
225</TABLE>
226
227<A NAME="shutdown()"><!-- --></A><H3>
228shutdown</H3>
229<PRE>
230public void <B>shutdown</B>()</PRE>
231<DL>
232<DD><DL>
233</DL>
234</DD>
235</DL>
236<!-- ========= END OF CLASS DATA ========= -->
237<HR>
238
239
240<!-- ======= START OF BOTTOM NAVBAR ====== -->
241<A NAME="navbar_bottom"><!-- --></A>
242<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
243<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
244<TR>
245<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
246<A NAME="navbar_bottom_firstrow"><!-- --></A>
247<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
248  <TR ALIGN="center" VALIGN="top">
249  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
250  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
251  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
252  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/RpcActivityMBean.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
253  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
254  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
255  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
256  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
257  </TR>
258</TABLE>
259</TD>
260<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
261</EM>
262</TD>
263</TR>
264
265<TR>
266<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
267&nbsp;PREV CLASS&nbsp;
268&nbsp;<A HREF="../../../../../org/apache/hadoop/ipc/metrics/RpcMetrics.html" title="class in org.apache.hadoop.ipc.metrics"><B>NEXT CLASS</B></A></FONT></TD>
269<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
270  <A HREF="../../../../../index.html?org/apache/hadoop/ipc/metrics/RpcActivityMBean.html" target="_top"><B>FRAMES</B></A>  &nbsp;
271&nbsp;<A HREF="RpcActivityMBean.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
272&nbsp;<SCRIPT type="text/javascript">
273  <!--
274  if(window==top) {
275    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
276  }
277  //-->
278</SCRIPT>
279<NOSCRIPT>
280  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
281</NOSCRIPT>
282
283
284</FONT></TD>
285</TR>
286<TR>
287<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
288  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
289<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
290DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
291</TR>
292</TABLE>
293<A NAME="skip-navbar_bottom"></A>
294<!-- ======== END OF BOTTOM NAVBAR ======= -->
295
296<HR>
297Copyright &copy; 2009 The Apache Software Foundation
298</BODY>
299</HTML>
Note: See TracBrowser for help on using the repository browser.