zookeeperJMX.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <html>
  3. <head>
  4. <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <meta content="Apache Forrest" name="Generator">
  6. <meta name="Forrest-version" content="0.8">
  7. <meta name="Forrest-skin-name" content="pelt">
  8. <title>ZooKeeper JMX</title>
  9. <link type="text/css" href="skin/basic.css" rel="stylesheet">
  10. <link media="screen" type="text/css" href="skin/screen.css" rel="stylesheet">
  11. <link media="print" type="text/css" href="skin/print.css" rel="stylesheet">
  12. <link type="text/css" href="skin/profile.css" rel="stylesheet">
  13. <script src="skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="skin/fontsize.js" language="javascript" type="text/javascript"></script>
  14. <link rel="shortcut icon" href="images/favicon.ico">
  15. </head>
  16. <body onload="init()">
  17. <script type="text/javascript">ndeSetTextSize();</script>
  18. <div id="top">
  19. <!--+
  20. |breadtrail
  21. +-->
  22. <div class="breadtrail">
  23. <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://hadoop.apache.org/">Hadoop</a> &gt; <a href="http://hadoop.apache.org/zookeeper/">ZooKeeper</a><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
  24. </div>
  25. <!--+
  26. |header
  27. +-->
  28. <div class="header">
  29. <!--+
  30. |start group logo
  31. +-->
  32. <div class="grouplogo">
  33. <a href="http://hadoop.apache.org/"><img class="logoImage" alt="Hadoop" src="images/hadoop-logo.jpg" title="Apache Hadoop"></a>
  34. </div>
  35. <!--+
  36. |end group logo
  37. +-->
  38. <!--+
  39. |start Project Logo
  40. +-->
  41. <div class="projectlogo">
  42. <a href="http://hadoop.apache.org/zookeeper/"><img class="logoImage" alt="ZooKeeper" src="images/zookeeper_small.gif" title="ZooKeeper: distributed coordination"></a>
  43. </div>
  44. <!--+
  45. |end Project Logo
  46. +-->
  47. <!--+
  48. |start Search
  49. +-->
  50. <div class="searchbox">
  51. <form action="http://www.google.com/search" method="get" class="roundtopsmall">
  52. <input value="hadoop.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp;
  53. <input name="Search" value="Search" type="submit">
  54. </form>
  55. </div>
  56. <!--+
  57. |end search
  58. +-->
  59. <!--+
  60. |start Tabs
  61. +-->
  62. <ul id="tabs">
  63. <li>
  64. <a class="unselected" href="http://hadoop.apache.org/zookeeper/">Project</a>
  65. </li>
  66. <li>
  67. <a class="unselected" href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a>
  68. </li>
  69. <li class="current">
  70. <a class="selected" href="index.html">ZooKeeper 3.1 Documentation</a>
  71. </li>
  72. </ul>
  73. <!--+
  74. |end Tabs
  75. +-->
  76. </div>
  77. </div>
  78. <div id="main">
  79. <div id="publishedStrip">
  80. <!--+
  81. |start Subtabs
  82. +-->
  83. <div id="level2tabs"></div>
  84. <!--+
  85. |end Endtabs
  86. +-->
  87. <script type="text/javascript"><!--
  88. document.write("Last Published: " + document.lastModified);
  89. // --></script>
  90. </div>
  91. <!--+
  92. |breadtrail
  93. +-->
  94. <div class="breadtrail">
  95. &nbsp;
  96. </div>
  97. <!--+
  98. |start Menu, mainarea
  99. +-->
  100. <!--+
  101. |start Menu
  102. +-->
  103. <div id="menu">
  104. <div onclick="SwitchMenu('menu_1.1', 'skin/')" id="menu_1.1Title" class="menutitle">Overview</div>
  105. <div id="menu_1.1" class="menuitemgroup">
  106. <div class="menuitem">
  107. <a href="index.html">Welcome</a>
  108. </div>
  109. <div class="menuitem">
  110. <a href="zookeeperOver.html">Overview</a>
  111. </div>
  112. <div class="menuitem">
  113. <a href="zookeeperStarted.html">Getting Started</a>
  114. </div>
  115. <div class="menuitem">
  116. <a href="releasenotes.html">Release Notes</a>
  117. </div>
  118. </div>
  119. <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Developer</div>
  120. <div id="menu_1.2" class="menuitemgroup">
  121. <div class="menuitem">
  122. <a href="api/index.html">API Docs</a>
  123. </div>
  124. <div class="menuitem">
  125. <a href="zookeeperProgrammers.html">Programmer's Guide</a>
  126. </div>
  127. <div class="menuitem">
  128. <a href="javaExample.html">Java Example</a>
  129. </div>
  130. <div class="menuitem">
  131. <a href="zookeeperTutorial.html">Barrier and Queue Tutorial</a>
  132. </div>
  133. <div class="menuitem">
  134. <a href="recipes.html">Recipes</a>
  135. </div>
  136. </div>
  137. <div onclick="SwitchMenu('menu_selected_1.3', 'skin/')" id="menu_selected_1.3Title" class="menutitle" style="background-image: url('skin/images/chapter_open.gif');">Admin &amp; Ops</div>
  138. <div id="menu_selected_1.3" class="selectedmenuitemgroup" style="display: block;">
  139. <div class="menuitem">
  140. <a href="zookeeperAdmin.html">Administrator's Guide</a>
  141. </div>
  142. <div class="menupage">
  143. <div class="menupagetitle">JMX</div>
  144. </div>
  145. </div>
  146. <div onclick="SwitchMenu('menu_1.4', 'skin/')" id="menu_1.4Title" class="menutitle">Contributor</div>
  147. <div id="menu_1.4" class="menuitemgroup">
  148. <div class="menuitem">
  149. <a href="zookeeperInternals.html">ZooKeeper Internals</a>
  150. </div>
  151. </div>
  152. <div onclick="SwitchMenu('menu_1.5', 'skin/')" id="menu_1.5Title" class="menutitle">Miscellaneous</div>
  153. <div id="menu_1.5" class="menuitemgroup">
  154. <div class="menuitem">
  155. <a href="http://wiki.apache.org/hadoop/ZooKeeper">Wiki</a>
  156. </div>
  157. <div class="menuitem">
  158. <a href="http://wiki.apache.org/hadoop/ZooKeeper/FAQ">FAQ</a>
  159. </div>
  160. <div class="menuitem">
  161. <a href="http://hadoop.apache.org/zookeeper/mailing_lists.html">Mailing Lists</a>
  162. </div>
  163. </div>
  164. <div id="credit"></div>
  165. <div id="roundbottom">
  166. <img style="display: none" class="corner" height="15" width="15" alt="" src="skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
  167. <!--+
  168. |alternative credits
  169. +-->
  170. <div id="credit2"></div>
  171. </div>
  172. <!--+
  173. |end Menu
  174. +-->
  175. <!--+
  176. |start content
  177. +-->
  178. <div id="content">
  179. <div title="Portable Document Format" class="pdflink">
  180. <a class="dida" href="zookeeperJMX.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
  181. PDF</a>
  182. </div>
  183. <h1>ZooKeeper JMX</h1>
  184. <div id="minitoc-area">
  185. <ul class="minitoc">
  186. <li>
  187. <a href="#ch_jmx">JMX</a>
  188. </li>
  189. <li>
  190. <a href="#ch_starting">Starting ZooKeeper with JMX enabled</a>
  191. </li>
  192. <li>
  193. <a href="#ch_console">Run a JMX console</a>
  194. </li>
  195. <li>
  196. <a href="#ch_reference">ZooKeeper MBean Reference</a>
  197. </li>
  198. </ul>
  199. </div>
  200. <a name="N10009"></a><a name="ch_jmx"></a>
  201. <h2 class="h3">JMX</h2>
  202. <div class="section">
  203. <p>Apache ZooKeeper has extensive support for JMX, allowing you
  204. to view and manage a ZooKeeper serving ensemble.</p>
  205. <p>This document assumes that you have basic knowledge of
  206. JMX. See <a href="http://java.sun.com/javase/technologies/core/mntr-mgmt/javamanagement/">
  207. Sun JMX Technology</a> page to get started with JMX.
  208. </p>
  209. <p>See the <a href="http://java.sun.com/javase/6/docs/technotes/guides/management/agent.html">
  210. JMX Management Guide</a> for details on setting up local and
  211. remote management of VM instances. By default the included
  212. <em>zkServer.sh</em> supports only local management -
  213. review the linked document to enable support for remote management
  214. (beyond the scope of this document).
  215. </p>
  216. </div>
  217. <a name="N10024"></a><a name="ch_starting"></a>
  218. <h2 class="h3">Starting ZooKeeper with JMX enabled</h2>
  219. <div class="section">
  220. <p>The class
  221. <em>org.apache.zookeeper.server.quorum.QuorumPeerMain</em>
  222. will start a JMX manageable ZooKeeper server. This class
  223. registers the proper MBeans during initalization to support JMX
  224. monitoring and management of the
  225. instance. See <em>bin/zkServer.sh</em> for one
  226. example of starting ZooKeeper using QuorumPeerMain.</p>
  227. </div>
  228. <a name="N10034"></a><a name="ch_console"></a>
  229. <h2 class="h3">Run a JMX console</h2>
  230. <div class="section">
  231. <p>There are a number of JMX consoles available which can connect
  232. to the running server. For this example we will use Sun's
  233. <em>jconsole</em>.</p>
  234. <p>The Java JDK ships with a simple JMX console
  235. named <a href="http://java.sun.com/developer/technicalArticles/J2SE/jconsole.html">jconsole</a>
  236. which can be used to connect to ZooKeeper and inspect a running
  237. server. Once you've started ZooKeeper using QuorumPeerMain
  238. start <em>jconsole</em>, which typically resides in
  239. <em>JDK_HOME/bin/jconsole</em>
  240. </p>
  241. <p>When the "new connection" window is displayed either connect
  242. to local process (if jconsole started on same host as Server) or
  243. use the remote process connection.</p>
  244. <p>By default the "overview" tab for the VM is displayed (this
  245. is a great way to get insight into the VM btw). Select
  246. the "MBeans" tab.</p>
  247. <p>You should now see <em>org.apache.ZooKeeperService</em>
  248. on the left hand side. Expand this item and depending on how you've
  249. started the server you will be able to monitor and manage various
  250. service related features.</p>
  251. <p>Also note that ZooKeeper will register log4j MBeans as
  252. well. In the same section along the left hand side you will see
  253. "log4j". Expand that to manage log4j through JMX. Of particular
  254. interest is the ability to dynamically change the logging levels
  255. used by editing the appender and root thresholds. Log4j MBean
  256. registration can be disabled by passing
  257. <em>-Dzookeeper.jmx.log4j.disable=true</em> to the JVM
  258. when starting ZooKeeper.
  259. </p>
  260. </div>
  261. <a name="N1005F"></a><a name="ch_reference"></a>
  262. <h2 class="h3">ZooKeeper MBean Reference</h2>
  263. <div class="section">
  264. <p>This table details JMX for a server participating in a
  265. replicated ZooKeeper ensemble (ie not standalone). This is the
  266. typical case for a production environment.</p>
  267. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  268. <caption>MBeans, their names and description</caption>
  269. <title>MBeans, their names and description</title>
  270. <tr>
  271. <th>MBean</th>
  272. <th>MBean Object Name</th>
  273. <th>Description</th>
  274. </tr>
  275. <tr>
  276. <td>Quorum</td>
  277. <td>ReplicatedServer_id&lt;#&gt;</td>
  278. <td>Represents the Quorum, or Ensemble - parent of all
  279. cluster members. Note that the object name includes the
  280. "myid" of the server (name suffix) that your JMX agent has
  281. connected to.</td>
  282. </tr>
  283. <tr>
  284. <td>LocalPeer|RemotePeer</td>
  285. <td>replica.&lt;#&gt;</td>
  286. <td>Represents a local or remote peer (ie server
  287. participating in the ensemble). Note that the object name
  288. includes the "myid" of the server (name suffix).</td>
  289. </tr>
  290. <tr>
  291. <td>LeaderElection</td>
  292. <td>LeaderElection</td>
  293. <td>Represents a ZooKeeper cluster leader election which is
  294. in progress. Provides information about the election, such as
  295. when it started.</td>
  296. </tr>
  297. <tr>
  298. <td>Leader</td>
  299. <td>Leader</td>
  300. <td>Indicates that the parent replica is the leader and
  301. provides attributes/operations for that server. Note that
  302. Leader is a subclass of ZooKeeperServer, so it provides
  303. all of the information normally associated with a
  304. ZooKeeperServer node.</td>
  305. </tr>
  306. <tr>
  307. <td>Follower</td>
  308. <td>Follower</td>
  309. <td>Indicates that the parent replica is a follower and
  310. provides attributes/operations for that server. Note that
  311. Follower is a subclass of ZooKeeperServer, so it provides
  312. all of the information normally associated with a
  313. ZooKeeperServer node.</td>
  314. </tr>
  315. <tr>
  316. <td>DataTree</td>
  317. <td>InMemoryDataTree</td>
  318. <td>Statistics on the in memory znode database, also
  319. operations to access finer (and more computationally
  320. intensive) statistics on the data (such as ephemeral
  321. count). InMemoryDataTrees are children of ZooKeeperServer
  322. nodes.</td>
  323. </tr>
  324. <tr>
  325. <td>ServerCnxn</td>
  326. <td>&lt;session_id&gt;</td>
  327. <td>Statistics on each client connection, also
  328. operations on those connections (such as
  329. termination). Note the object name is the session id of
  330. the connection in hex form.</td>
  331. </tr>
  332. </table>
  333. <p>This table details JMX for a standalone server. Typically
  334. standalone is only used in development situations.</p>
  335. <table class="ForrestTable" cellspacing="1" cellpadding="4">
  336. <caption>MBeans, their names and description</caption>
  337. <title>MBeans, their names and description</title>
  338. <tr>
  339. <th>MBean</th>
  340. <th>MBean Object Name</th>
  341. <th>Description</th>
  342. </tr>
  343. <tr>
  344. <td>ZooKeeperServer</td>
  345. <td>StandaloneServer_port&lt;#&gt;</td>
  346. <td>Statistics on the running server, also operations
  347. to reset these attributes. Note that the object name
  348. includes the client port of the server (name
  349. suffix).</td>
  350. </tr>
  351. <tr>
  352. <td>DataTree</td>
  353. <td>InMemoryDataTree</td>
  354. <td>Statistics on the in memory znode database, also
  355. operations to access finer (and more computationally
  356. intensive) statistics on the data (such as ephemeral
  357. count).</td>
  358. </tr>
  359. <tr>
  360. <td>ServerCnxn</td>
  361. <td>&lt;session_id&gt;</td>
  362. <td>Statistics on each client connection, also
  363. operations on those connections (such as
  364. termination). Note the object name is the session id of
  365. the connection in hex form.</td>
  366. </tr>
  367. </table>
  368. </div>
  369. <p align="right">
  370. <font size="-2"></font>
  371. </p>
  372. </div>
  373. <!--+
  374. |end content
  375. +-->
  376. <div class="clearboth">&nbsp;</div>
  377. </div>
  378. <div id="footer">
  379. <!--+
  380. |start bottomstrip
  381. +-->
  382. <div class="lastmodified">
  383. <script type="text/javascript"><!--
  384. document.write("Last Published: " + document.lastModified);
  385. // --></script>
  386. </div>
  387. <div class="copyright">
  388. Copyright &copy;
  389. 2008 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
  390. </div>
  391. <!--+
  392. |end bottomstrip
  393. +-->
  394. </div>
  395. </body>
  396. </html>