svn commit - mysqldoc@docsrva: r3213 - trunk/refman-5.1

[jon]

Author: jstephens
Date: 2006-09-04 17:34:26 +0200 (Mon, 04 Sep 2006)
New Revision: 3213

Log:
Basic documention for ndb_error_reporter (Thanks, Geert!)

Modified:
   trunk/refman-5.1/ndb-utilities.xml


Modified: trunk/refman-5.1/ndb-utilities.xml
===================================================================
--- trunk/refman-5.1/ndb-utilities.xml	2006-09-04 15:19:58 UTC (rev 3212)
+++ trunk/refman-5.1/ndb-utilities.xml	2006-09-04 15:34:26 UTC (rev 3213)
Changed blocks: 5, Lines Added: 41, Lines Deleted: 11; 4010 bytes

@@ -13,10 +13,11 @@
   <para>
     This section discusses the Cluster utility programs that can be
     found in the <filename>mysql/bin</filename> directory. Each of these
-    &mdash; except for <filename>ndb_size.pl</filename> &mdash; is a
-    standalone binary that can be used from a system shell, and that
-    does not need to connect to a MySQL server (nor even requires that a
-    MySQL server be connected to the cluster).
+    &mdash; except for <filename>ndb_size.pl</filename> and
+    <command>ndb_error_reporter</command> &mdash; is a standalone binary
+    that can be used from a system shell, and that does not need to
+    connect to a MySQL server (nor even requires that a MySQL server be
+    connected to the cluster).
   </para>
 
   <remark role="todo">

@@ -79,8 +80,8 @@
 
     <listitem>
       <para>
-        <command>ndb_error_reporter</command>: Can be used to generate
-        an error report in the event of problems with the cluster.
+        <command>ndb_error_reporter</command>: Can be used to gather
+        information useful for diagnosing problems with the cluster.
       </para>
     </listitem>
 

@@ -206,6 +207,14 @@
   </para>
 
   <para>
+    <command>ndb_error_reporter</command> is also a Perl script. It is
+    used to gather cluster data node and management node logs together
+    in a tarball to submit along with a bug report. It can use
+    <command>ssh</command> or <command>scp</command> to access the node
+    filesystems remotely.
+  </para>
+
+  <para>
     Additional information about each of these utilities (except for
     <command>ndb_mgm</command> and <command>ndb_restore</command>) can
     be found in the sections that follow.

@@ -552,9 +561,11 @@
     <title><command>ndb_error_reporter</command></title>
 
     <para>
-      <emphasis role="bold">Description</emphasis>: Generates an error
-      report that can be used to help diagnose bugs or other problems
-      with a cluster.
+      <emphasis role="bold">Description</emphasis>: Creates an archive
+      from data node and management node logfiles that can be used to
+      help diagnose bugs or other problems with a cluster. <emphasis>It
+      is highly recommended that you make use of this utility when
+      filing reports of bugs in MySQL Cluster</emphasis>.
     </para>
 
     <para>

@@ -562,13 +573,32 @@
     </para>
 
 <programlisting>
-
+ndb_error_reporter <replaceable>path/to/config-file</replaceable> [<replaceable>username</replaceable>] [--fs]
 </programlisting>
 
     <para>
-      <emphasis role="bold">Additional Options</emphasis>:
+      This utility is intended for use on a management node host, and
+      requires the path to the management host configuration file
+      (<filename>config.ini</filename>). Optionally, you can supply the
+      name of a user that is able to access the cluster's data nodes via
+      SSH, in order to copy the data node logfiles. ndb_error_reporter
+      then includes all of these files in archive that is created in the
+      same directory in which it is run. The archive is named
+      <filename>ndb_error_report_<replaceable>YYYYMMDDHHMMSS</replaceable>.tar.bz2</filename>,
+      where <replaceable>YYYYMMDDHHMMSS</replaceable> is a datetime
+      string.
     </para>
 
+    <para>
+      If the <option>--fs</option> is used, then the data node
+      filesystems are also copied to the management host and included in
+      the archive that is produced by this script. As data node
+      filesystems can be extremely large even after being compressed, we
+      ask that you please do <emphasis>not</emphasis> send archives
+      created using this option to MySQL AB unless you are specifically
+      requested to do so.
+    </para>
+
   </section>
 
   <section id="mysql-cluster-utility-programs-ndb-print-backup-file">