svn commit - mysqldoc@docsrva: r10172 - in trunk: ndbapi refman-5.1

[jon]

Author: jstephens
Date: 2008-03-08 14:34:15 +0100 (Sat, 08 Mar 2008)
New Revision: 10172

Log:

Added descriptions for Ndb_log_event_type values (Thanks, MontyT!)



Modified:
   trunk/ndbapi/mgm-api.xml
   trunk/refman-5.1/mysql-cluster-log-messages-tmp.xml


Modified: trunk/ndbapi/mgm-api.xml
===================================================================
--- trunk/ndbapi/mgm-api.xml	2008-03-08 03:46:56 UTC (rev 10171)
+++ trunk/ndbapi/mgm-api.xml	2008-03-08 13:34:15 UTC (rev 10172)
Changed blocks: 4, Lines Added: 117, Lines Deleted: 70; 20628 bytes

@@ -4884,13 +4884,26 @@
         <title>Description</title>
 
         <para>
-          These are the types of log event events available in the MGM
-          API, grouped by event category. (See
+          These are the types of log events available in the MGM API,
+          grouped by event category. (See
           <xref linkend="ndb-mgm-event-category"/>.)
         </para>
 
       </formalpara>
 
+      <remark role="TODO">
+        [js] Uncomment the following paragraph when Cluster Log Messages
+        goes live.
+      </remark>
+
+<!--
+      <para>
+        Most of these log event types have one or more corresponding log event
+        messages; these are listed in 
+        <xref linkend="mysql-cluster-log-messages"/>.
+      </para>
+-->
+
       <formalpara>
 
         <title>Enumeration Values</title>

@@ -4912,112 +4925,124 @@
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_CONNECTION</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Connection events)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_Connected</literal></entry>
-                  <entry/>
+                  <entry>The node has connected</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_Disconnected</literal></entry>
-                  <entry/>
+                  <entry>The node was disconnected</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_CommunicationClosed</literal></entry>
-                  <entry/>
+                  <entry>Communication with the node has been closed</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_CommunicationOpened</literal></entry>
-                  <entry/>
+                  <entry>Communication with the node has been started</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_ConnectedApiVersion</literal></entry>
-                  <entry/>
+                  <entry>The API version used by an API node; in the case of a
MySQL server (SQL
+                    node), this is the same as displayed by
+                    <literal>SELECT VERSION()</literal></entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_CHECKPOINT</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Checkpoint events)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_GlobalCheckpointStarted</literal></entry>
-                  <entry/>
+                  <entry>A global checkpoint has been started</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_GlobalCheckpointCompleted</literal></entry>
-                  <entry/>
+                  <entry>A global checkpoint has been completed</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_LocalCheckpointStarted</literal></entry>
-                  <entry/>
+                  <entry>The node has begun a local checkpoint</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_LocalCheckpointCompleted</literal></entry>
-                  <entry/>
+                  <entry>The node has completed a local checkpoint</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_LCPStoppedInCalcKeepGci</literal></entry>
-                  <entry/>
+                  <entry>The lcoal checkpoint was aborted, but the last global
checkpoint was
+                    preserved</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_LCPFragmentCompleted</literal></entry>
-                  <entry/>
+                  <entry>Copying of a table fragment was completed</entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_STARTUP</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Startup events)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NDBStartStarted</literal></entry>
-                  <entry/>
+                  <entry>The node has begun to start</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NDBStartCompleted</literal></entry>
-                  <entry/>
+                  <entry>The node has completed the startup process</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_STTORRYRecieved</literal></entry>
-                  <entry/>
+                  <entry>The node received an
<literal>STTORRY</literal> signal, indicating that
+                    the reading of configuration data is underway; see
+                    <xref linkend="ndb-internals-start-phases-sttor-config-read"/>,
+                    and
+                    <xref linkend="ndb-internals-start-phases-sttor-0"/>,
+                    for more information</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_StartPhaseCompleted</literal></entry>
-                  <entry/>
+                  <entry>A node start phase has been completed</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_CM_REGCONF</literal></entry>
-                  <entry/>
+                  <entry>The node has received a
<literal>CM_REGCONF</literal> signal; see
+                    <xref linkend="ndb-internals-start-phases-sttor-1"/>,
+                    for more information</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_CM_REGREF</literal></entry>
-                  <entry/>
+                  <entry>The node has received a
<literal>CM_REGREF</literal> signal; see
+                    <xref linkend="ndb-internals-start-phases-sttor-1"/>,
+                    for more information</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_FIND_NEIGHBOURS</literal></entry>
-                  <entry/>
+                  <entry>The node has discovered its neighboring nodes in the
cluster</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NDBStopStarted</literal></entry>
-                  <entry/>
+                  <entry>The node is begiining to shut down</entry>
                 </row>
                 <row>
                   <entry/>

@@ -5027,132 +5052,143 @@
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NDBStopForced</literal></entry>
-                  <entry/>
+                  <entry>The node is being forced to shut down (usually indicates a
severe
+                    problem in the cluster)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NDBStopAborted</literal></entry>
-                  <entry/>
+                  <entry>The started to shut down, but was forced to continue
running; this
+                    happens, for example, when a <literal>STOP</literal>
+                    command was issued in the management client for a
+                    node such that the cluster would no longer be able
+                    to keep all data available if the node were shut
+                    down</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_StartREDOLog</literal></entry>
-                  <entry/>
+                  <entry>Redo logging has been started</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_StartLog</literal></entry>
-                  <entry/>
+                  <entry>Logging has started</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_UNDORecordsExecuted</literal></entry>
-                  <entry/>
+                  <entry>The node has read and executed all records from the redo
log</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_StartReport</literal></entry>
-                  <entry/>
+                  <entry>The node is issuing a start report</entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_NODE_RESTART</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Restart events)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NR_CopyDict</literal></entry>
-                  <entry/>
+                  <entry>The node is copying the data dictionary</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NR_CopyDistr</literal></entry>
-                  <entry/>
+                  <entry>The node is copying data distribution
information</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NR_CopyFragsStarted</literal></entry>
-                  <entry/>
+                  <entry>The node is copying table fragments</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NR_CopyFragDone</literal></entry>
-                  <entry/>
+                  <entry>The node has completed copying a table
fragment</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NR_CopyFragsCompleted</literal></entry>
-                  <entry/>
+                  <entry>The node has completed copying all necessary table
fragments</entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_NODE_RESTART</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Node failure and arbitration)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NodeFailCompleted</literal></entry>
-                  <entry/>
+                  <entry>All (remaining) nodes has been notified of the failure of
a data node</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_NODE_FAILREP</literal></entry>
-                  <entry/>
+                  <entry>A data node has failed</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_ArbitState</literal></entry>
-                  <entry/>
+                  <entry>This event is used to report on the current state of
arbitration in the
+                    cluster</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_ArbitResult</literal></entry>
-                  <entry/>
+                  <entry>This event is used to report on the outcome of node
arbitration</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_GCP_TakeoverStarted</literal></entry>
-                  <entry/>
+                  <entry>The node is attempting to become the master node (to
assume
+                    responsibility for GCPs)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_GCP_TakeoverCompleted</literal></entry>
-                  <entry/>
+                  <entry>The node has become the master (and assumed responsibility
for GCPs)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_LCP_TakeoverStarted</literal></entry>
-                  <entry/>
+                  <entry>The node is attempting to become the master node (to
assume
+                    responsibility for LCPs)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_LCP_TakeoverCompleted</literal></entry>
-                  <entry/>
+                  <entry>The node has become the master (and assumed responsibility
for LCPs)</entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_STATISTIC</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Statistics events)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_TransReportCounters</literal></entry>
-                  <entry/>
+                  <entry>This indicates a report of transaction activity, which is
given
+                    approximately once every 10 seconds</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_OperationReportCounters</literal></entry>
-                  <entry/>
+                  <entry>Indicates a report on the number of operations performed
by this node
+                    (also provided approximately once every 10 seconds)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_TableCreated</literal></entry>
-                  <entry/>
+                  <entry>A new table has been created</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_UndoLogBlocked</literal></entry>
-                  <entry/>
+                  <entry>Undo logging is blocked because the log buffer is close to
overflowing</entry>
                 </row>
                 <row>
                   <entry/>

@@ -5162,102 +5198,113 @@
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_SendBytesStatistic</literal></entry>
-                  <entry/>
+                  <entry>Indicates a report of the average number of bytes
transmitted per send
+                    operation by this node</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_ReceiveBytesStatistic</literal></entry>
-                  <entry/>
+                  <entry>Indicates a report of the average number of bytes received
per send
+                    operation to this node</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_MemoryUsage</literal></entry>
-                  <entry/>
+                  <entry>A <literal>DUMP 1000</literal> command has
been issued to this node, and
+                    it is reporting its memory usage in turn</entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_ERROR</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Errors and warnings)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_TransporterError</literal></entry>
-                  <entry/>
+                  <entry>A transporter error has occurred; see
+                    <xref linkend="transporter-errors"/>, for
+                    transporter error codes and messages</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_TransporterWarning</literal></entry>
-                  <entry/>
+                  <entry>A potential problem is occurring in the transporter; see
+                    <xref linkend="transporter-errors"/>, for
+                    transporter error codes and messages</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_MissedHeartbeat</literal></entry>
-                  <entry/>
+                  <entry>Indicates a data node has missed a hreatbeat expected from
another data
+                    node</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_DeadDueToHeartbeat</literal></entry>
-                  <entry/>
+                  <entry>A data node has missed at least 3 heartbeats in succssion
from another
+                    data node, and is reporting that it can no longer
+                    communicate with that data node</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_WarningEvent</literal></entry>
-                  <entry/>
+                  <entry>Indicates a warning message</entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_INFO</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Information events)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_SentHeartbeat</literal></entry>
-                  <entry/>
+                  <entry>A node heartbeat has been sent</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_CreateLogBytes</literal></entry>
-                  <entry/>
+                  <entry></entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_InfoEvent</literal></entry>
-                  <entry/>
+                  <entry>Indicates an informational message</entry>
                 </row>
                 <row>
                   <entry><emphasis>[Single-User
Mode]</emphasis></entry>
                  
<entry><literal>NDB_LE_SingleUser</literal></entry>
-                  <entry/>
+                  <entry>The cluster has entered or exited single user
mode</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_EventBufferStatus</literal></entry>
-                  <entry/>
+                  <entry>This type of event indicates potentially excessive usage
of the event
+                    buffer</entry>
                 </row>
                 <row>
                  
<entry><emphasis><literal>NDB_MGM_EVENT_CATEGORY_BACKUP</literal></emphasis></entry>
                   <entry/>
-                  <entry/>
+                  <entry>(Backups)</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_BackupStarted</literal></entry>
-                  <entry/>
+                  <entry>A backup has been started</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_BackupFailedToStart</literal></entry>
-                  <entry/>
+                  <entry>A backup has failed to start</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_BackupCompleted</literal></entry>
-                  <entry/>
+                  <entry>A backup has been completed successfully</entry>
                 </row>
                 <row>
                   <entry/>
                  
<entry><literal>NDB_LE_BackupAborted</literal></entry>
-                  <entry/>
+                  <entry>A backup in progress was terminated by the
user</entry>
                 </row>
               </tbody>
             </tgroup>


Modified: trunk/refman-5.1/mysql-cluster-log-messages-tmp.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster-log-messages-tmp.xml	2008-03-08 03:46:56 UTC (rev
10171)
+++ trunk/refman-5.1/mysql-cluster-log-messages-tmp.xml	2008-03-08 13:34:15 UTC (rev
10172)
Changed blocks: 1, Lines Added: 6, Lines Deleted: 3; 931 bytes

@@ -6,9 +6,12 @@
 
   <para>
     The following table lists the most common <literal>NDB</literal>
-    cluster log messages. For more information about the cluster log,
-    log events, and event types, see
-    <xref linkend="mysql-cluster-event-reports"/>.
+    cluster log messages. For information about the cluster log, log
+    events, and event types, see
+    <xref linkend="mysql-cluster-event-reports"/>. These log messages
+    also correspond to log event types in the MGM API; see
+    <xref linkend="ndb-logevent-type"/>, for related information of
+    interest to Cluster API developers.
   </para>
 
   <informaltable>