From ef4eb46d9f76080569e8a17471a7df75b8869102 Mon Sep 17 00:00:00 2001
From: Doug Meil <dmeil@apache.org>
Date: Tue, 17 Jan 2012 20:07:35 +0000
Subject: [PATCH] hbase-5220 troubleshooting.xml - zkcli info

git-svn-id: https://svn.apache.org/repos/asf/hbase/trunk@1232559 13f79535-47bb-0310-9956-ffa450edef68
---
 src/docbkx/troubleshooting.xml | 36 +++++++++++++++++++++++++++++++++-
 1 file changed, 35 insertions(+), 1 deletion(-)

diff --git a/src/docbkx/troubleshooting.xml b/src/docbkx/troubleshooting.xml
index 6ffb942bf93..e7517fbf7b2 100644
--- a/src/docbkx/troubleshooting.xml
+++ b/src/docbkx/troubleshooting.xml
@@ -244,6 +244,37 @@ export HBASE_OPTS="-XX:NewSize=64m -XX:MaxNewSize=64m &lt;cms options from above
               <para>See <xref linkend="hbase_metrics"/> for more information in metric definitions.
             </para>
           </section>
+          <section xml:id="trouble.tools.builtin.zkcli">
+             <title>zkcli</title>
+              <para><code>zkcli</code> is a very useful tool for investigating ZooKeeper-related issues.  To invoke:
+<programlisting>
+./hbase zkcli -server host:port &lt;cmd&gt; &lt;args&gt;
+</programlisting>
+              The commands (and arguments) are:
+<programlisting>
+	connect host:port
+	get path [watch]
+	ls path [watch]
+	set path data [version]
+	delquota [-n|-b] path
+	quit 
+	printwatches on|off
+	create [-s] [-e] path data acl
+	stat path [watch]
+	close 
+	ls2 path [watch]
+	history 
+	listquota path
+	setAcl path acl
+	getAcl path
+	sync path
+	redo cmdno
+	addauth scheme auth
+	delete path [version]
+	setquota -n|-b val path
+</programlisting>
+            </para>
+        </section>
        </section>
        <section xml:id="trouble.tools.external">
           <title>External Tools</title>
@@ -541,7 +572,8 @@ hadoop   17789  155 35.2 9067824 8604364 ?     S&lt;l  Mar04 9855:48 /usr/java/j
 </programlisting>
             ... are either due to ZooKeeper being down, or unreachable due to network issues.            
             </para>
-            
+            <para>The utility <xref linkend="trouble.tools.builtin.zkcli"/> may help investigate ZooKeeper issues.
+            </para>
        </section>    
        <section xml:id="trouble.client.oome.directmemory.leak">
             <title>Client running out of memory though heap size seems to be stable (but the off-heap/direct heap keeps growing)</title>
@@ -900,6 +932,8 @@ ERROR org.apache.hadoop.hbase.regionserver.HRegionServer: ZooKeeper session expi
           <para>
           See the <link xlink:href="http://wiki.apache.org/hadoop/ZooKeeper/Troubleshooting">ZooKeeper Operating Environment Troubleshooting</link> page. It has suggestions and tools for checking disk and networking performance; i.e. the operating environment your ZooKeeper and HBase are running in.
           </para>
+         <para>Additionally, the utility <xref linkend="trouble.tools.builtin.zkcli"/> may help investigate ZooKeeper issues.
+         </para>
       </section>  
 
     </section>