Author: jstephens
Date: 2007-01-27 04:43:48 +0100 (Sat, 27 Jan 2007)
New Revision: 4673
Log:
Reformat.
Modified:
branches/telcos/refman-5.1/mysql-cluster.xml
trunk/refman-4.1/mysql-cluster.xml
trunk/refman-5.0/mysql-cluster.xml
trunk/refman-5.1/mysql-cluster.xml
Modified: branches/telcos/refman-5.1/mysql-cluster.xml
===================================================================
--- branches/telcos/refman-5.1/mysql-cluster.xml 2007-01-27 03:42:39 UTC (rev 4672)
+++ branches/telcos/refman-5.1/mysql-cluster.xml 2007-01-27 03:43:48 UTC (rev 4673)
Changed blocks: 14, Lines Added: 44, Lines Deleted: 41; 9836 bytes
@@ -7851,8 +7851,7 @@
<row>
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-datadir">DataDir</link></literal></entry>
<entry>string</entry>
- <entry><filename>./</filename>
- (<command>ndb_mgmd</command> directory)</entry>
+ <entry><filename>./</filename> (<command>ndb_mgmd</command> directory)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>IN</entry>
@@ -7885,7 +7884,8 @@
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-logdestination">LogDestination</link></literal></entry>
<entry><literal>CONSOLE</literal>, <literal>SYSLOG</literal>, or
<literal>FILE</literal></entry>
- <entry><literal>FILE</literal> (see <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
+ <entry><literal>FILE</literal> (see
+ <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>N</entry>
@@ -10813,8 +10813,9 @@
<para>
MySQL Cluster provides two types of event log:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
The <firstterm>cluster log</firstterm>, which includes
@@ -10823,7 +10824,7 @@
logging information for an entire cluster in a single
location.
</para>
-
+
<para>
By default, the cluster log is saved to a file named
<filename>ndb_<replaceable>node_id</replaceable>_cluster.log</filename>,
@@ -10831,38 +10832,39 @@
the management server) in the same directory where the
<command>ndb_mgm</command> binary resides.
</para>
-
+
<para>
Cluster logging information can also be sent to
<literal>stdout</literal> or a <literal>syslog</literal>
facility in addition to or instead of being saved to a file,
as determined by the values set for the
<literal>DataDir</literal> and
- <literal>LogDestination</literal> configuration parameters.
- See <xref linkend="mysql-cluster-mgm-definition"/>, for
- more information about these parameters.
+ <literal>LogDestination</literal> configuration parameters.
+ See <xref linkend="mysql-cluster-mgm-definition"/>, for more
+ information about these parameters.
</para>
</listitem>
-
+
<listitem>
<para>
<firstterm>Node logs</firstterm> are local to each node.
</para>
-
+
<para>
Output generated by node event logging is written to the
file
<filename>ndb_<replaceable>node_id</replaceable>_out.log</filename>
(where <replaceable>node_id</replaceable> is the node's node
ID) in the node's <literal>DataDir</literal>. Node event
- logs are generated for both management nodes and data nodes.
+ logs are generated for both management nodes and data nodes.
</para>
-
+
<para>
Node logs are intended to be used only during application
development, or for debugging application code.
</para>
</listitem>
+
</itemizedlist>
<para>
@@ -10923,11 +10925,11 @@
Both the cluster log and the node log can be filtered on these
properties.
</para>
-
+
<para>
The format used in the cluster log is as shown here:
</para>
-
+
<programlisting>
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Data usage is 2%(60 32K pages of total 2560)
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Index usage is 1%(24 8K pages of total 2336)
@@ -10952,52 +10954,53 @@
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
</programlisting>
-
+
<para>
Each line in the cluster log contains the following information:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
A timestamp in
<literal><replaceable>YYYY</replaceable>-<replaceable>MM</replaceable>-<replaceable>DD</replaceable>
- <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
- format.
+ <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
+ format.
</para>
</listitem>
-
+
<listitem>
<para>
The type of node which is performing the logging. In the
- cluster log, this is always <literal>[MgmSrvr]</literal>.
+ cluster log, this is always <literal>[MgmSrvr]</literal>.
</para>
</listitem>
-
+
<listitem>
<para>
The severity of the event.
</para>
</listitem>
-
+
<listitem>
<para>
The ID of the node reporting the event.
</para>
</listitem>
-
+
<listitem>
<para>
A description of the event. The most common types of events
- to appear in the log are connections and disconnections
+ to appear in the log are connections and disconnections
between different nodes in the cluster, and when checkpoints
occur. In some cases, the description may contain status
information.
</para>
</listitem>
+
</itemizedlist>
-
-
+
<section id="mysql-cluster-logging-management-commands">
<title>Logging Management Commands</title>
@@ -11167,10 +11170,10 @@
</tbody>
</tgroup>
</informaltable>
-
+
<para>
The <literal>STATISTICS</literal> category can provide a great
- deal of useful data. See
+ deal of useful data. See
<xref linkend="mysql-cluster-log-statistics"/>, for more
information.
</para>
@@ -12162,13 +12165,13 @@
<para>
To cause all cluster log statistics to be logged, you can use
the following command in the <literal>NDB</literal> management
- client:
+ client:
</para>
<programlisting>
ndb_mgm> <userinput>ALL CLUSTERLOG STATISTICS=15</userinput>
</programlisting>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Setting the threshold
for <literal>STATISTICS</literal> to 15 causes the cluster log
@@ -12201,7 +12204,7 @@
instance of <command>ndb_restore</command>. When entering single
user mode, connections to all other API nodes are closed
gracefully and all running transactions are aborted. No new
- transactions are permitted to start.
+ transactions are permitted to start.
</para>
<para>
@@ -12692,7 +12695,7 @@
<indexterm>
<primary><command>ndb_restore</command></primary>
</indexterm>
-
+
<para>
The cluster restoration program is implemented as a separate
command-line utility <command>ndb_restore</command>, which can
@@ -12700,17 +12703,17 @@
directory. This program reads the files created as a result of
the backup and inserts the stored information into the database.
</para>
-
+
<para>
<command>ndb_restore</command> must be executed
<literal><replaceable>N</replaceable> + 1</literal> times, where
<replaceable>N</replaceable> is the number of backup files that
were created by the <literal>START BACKUP</literal> command used
- to create the backup (see
+ to create the backup (see
<xref linkend="mysql-cluster-backup-using-management-client"/>).
This is equal to once for restoring cluster metadata (table
- schemas), plus once for each data node in the cluster at
- the time that the backup was created.
+ schemas), plus once for each data node in the cluster at the
+ time that the backup was created.
</para>
<indexterm>
@@ -12750,8 +12753,8 @@
that can be used by it in the cluster
<filename>config.ini</filename> file. It is a good idea to keep
at least one empty <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in
- <filename>config.ini</filename> that is not being used for a
+ <literal>[MYSQLD]</literal> section in
+ <filename>config.ini</filename> that is not being used for a
MySQL server or other application for this reason (see
<xref linkend="mysql-cluster-api-definition"/>).
</para>
@@ -12823,11 +12826,11 @@
restoration, the data may be restored in parallel, provided that
there is a sufficient number of cluster connections available.
That is, when restoring to multiple nodes in parallel, you must
- have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
section in the cluster <filename>config.ini</filename> file
available for each concurrent <command>ndb_restore</command>
process. However, the data files must always be applied before
- the logs.
+ the logs.
</para>
<para>
Modified: trunk/refman-4.1/mysql-cluster.xml
===================================================================
--- trunk/refman-4.1/mysql-cluster.xml 2007-01-27 03:42:39 UTC (rev 4672)
+++ trunk/refman-4.1/mysql-cluster.xml 2007-01-27 03:43:48 UTC (rev 4673)
Changed blocks: 17, Lines Added: 74, Lines Deleted: 71; 14515 bytes
@@ -7741,8 +7741,7 @@
<row>
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-datadir">DataDir</link></literal></entry>
<entry>string</entry>
- <entry><filename>./</filename>
- (<command>ndb_mgmd</command> directory)</entry>
+ <entry><filename>./</filename> (<command>ndb_mgmd</command> directory)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>IN</entry>
@@ -7775,7 +7774,8 @@
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-logdestination">LogDestination</link></literal></entry>
<entry><literal>CONSOLE</literal>, <literal>SYSLOG</literal>, or
<literal>FILE</literal></entry>
- <entry><literal>FILE</literal> (see <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
+ <entry><literal>FILE</literal> (see
+ <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>N</entry>
@@ -10582,17 +10582,18 @@
<primary>MySQL Cluster</primary>
<secondary>node logs</secondary>
</indexterm>
-
+
<para>
In this section, we discuss the types of event logs provided by
MySQL Cluster, and the types of events that are logged.
</para>
-
+
<para>
MySQL Cluster provides two types of event log:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
The <firstterm>cluster log</firstterm>, which includes
@@ -10601,7 +10602,7 @@
logging information for an entire cluster in a single
location.
</para>
-
+
<para>
By default, the cluster log is saved to a file named
<filename>ndb_<replaceable>node_id</replaceable>_cluster.log</filename>,
@@ -10609,61 +10610,62 @@
the management server) in the same directory where the
<command>ndb_mgm</command> binary resides.
</para>
-
+
<para>
Cluster logging information can also be sent to
<literal>stdout</literal> or a <literal>syslog</literal>
facility in addition to or instead of being saved to a file,
as determined by the values set for the
<literal>DataDir</literal> and
- <literal>LogDestination</literal> configuration parameters.
- See <xref linkend="mysql-cluster-mgm-definition"/>, for
- more information about these parameters.
+ <literal>LogDestination</literal> configuration parameters.
+ See <xref linkend="mysql-cluster-mgm-definition"/>, for more
+ information about these parameters.
</para>
</listitem>
-
+
<listitem>
<para>
<firstterm>Node logs</firstterm> are local to each node.
</para>
-
+
<para>
Output generated by node event logging is written to the
file
<filename>ndb_<replaceable>node_id</replaceable>_out.log</filename>
(where <replaceable>node_id</replaceable> is the node's node
ID) in the node's <literal>DataDir</literal>. Node event
- logs are generated for both management nodes and data nodes.
+ logs are generated for both management nodes and data nodes.
</para>
-
+
<para>
Node logs are intended to be used only during application
development, or for debugging application code.
</para>
</listitem>
+
</itemizedlist>
-
+
<para>
Both types of event logs can be set to log different subsets of
events.
</para>
-
+
<para>
Each reportable event can be distinguished according to three
different criteria:
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>event types</secondary>
</indexterm>
-
+
<indexterm>
<primary>event types (MySQL Cluster)</primary>
</indexterm>
-
+
<itemizedlist>
-
+
<listitem>
<para>
<emphasis>Category</emphasis>: This can be any one of the
@@ -10675,16 +10677,16 @@
<literal>INFO</literal>.
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis>Priority</emphasis>: This is represented by one of
the numbers from 1 to 15 inclusive, where 1 indicates
<quote>most important</quote> and 15 <quote>least
- important.</quote>
+ important.</quote>
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis>Severity Level</emphasis>: This can be any one of
@@ -10694,19 +10696,19 @@
<literal>DEBUG</literal>.
</para>
</listitem>
-
+
</itemizedlist>
-
+
<para>
Both the cluster log and the node log can be filtered on these
properties.
</para>
-
+
<para>
The format used in the cluster log is as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Data usage is 2%(60 32K pages of total 2560)
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Index usage is 1%(24 8K pages of total 2336)
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Resource 0 min: 0 max: 639 curr: 0
@@ -10730,49 +10732,51 @@
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
</programlisting>
-
+
<para>
Each line in the cluster log contains the following information:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
A timestamp in
<literal><replaceable>YYYY</replaceable>-<replaceable>MM</replaceable>-<replaceable>DD</replaceable>
- <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
- format.
+ <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
+ format.
</para>
</listitem>
-
+
<listitem>
<para>
The type of node which is performing the logging. In the
- cluster log, this is always <literal>[MgmSrvr]</literal>.
+ cluster log, this is always <literal>[MgmSrvr]</literal>.
</para>
</listitem>
-
+
<listitem>
<para>
The severity of the event.
</para>
</listitem>
-
+
<listitem>
<para>
The ID of the node reporting the event.
</para>
</listitem>
-
+
<listitem>
<para>
A description of the event. The most common types of events
- to appear in the log are connections and disconnections
+ to appear in the log are connections and disconnections
between different nodes in the cluster, and when checkpoints
occur. In some cases, the description may contain status
information.
</para>
</listitem>
+
</itemizedlist>
<section id="mysql-cluster-logging-management-commands">
@@ -10878,10 +10882,10 @@
</listitem>
</itemizedlist>
-
+
<para>
The <literal>STATISTICS</literal> category can provide a great
- deal of useful data. See
+ deal of useful data. See
<xref linkend="mysql-cluster-log-statistics"/>, for more
information.
</para>
@@ -11935,17 +11939,17 @@
These values are given in bytes. Higher values mean a lower
cost per byte sent or received; the maximum is 64k.
</para>
-
+
<para>
To cause all cluster log statistics to be logged, you can use
the following command in the <literal>NDB</literal> management
- client:
+ client:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>ALL CLUSTERLOG STATISTICS=15</userinput>
</programlisting>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Setting the threshold
for <literal>STATISTICS</literal> to 15 causes the cluster log
@@ -11970,7 +11974,7 @@
<indexterm>
<primary>single user mode (MySQL Cluster)</primary>
</indexterm>
-
+
<para>
<firstterm>Single user mode</firstterm> allows the database
administrator to restrict access to the database system to a
@@ -11978,45 +11982,45 @@
instance of <command>ndb_restore</command>. When entering single
user mode, connections to all other API nodes are closed
gracefully and all running transactions are aborted. No new
- transactions are permitted to start.
+ transactions are permitted to start.
</para>
-
+
<para>
Once the cluster has entered single user mode, only the
designated API node is granted access to the database.
</para>
-
+
<para>
You can use the <command>ALL STATUS</command> command to see
when the cluster has entered single user mode.
</para>
-
+
<para>
Example:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>ENTER SINGLE USER MODE 5</userinput>
</programlisting>
-
+
<para>
After this command has executed and the cluster has entered
single user mode, the API node whose node ID is
<literal>5</literal> becomes the cluster's only permitted user.
</para>
-
+
<para>
The node specified in the preceding command must be an API node;
attempting to specify any other type of node will be rejected.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: When the preceding
commmand is invoked, all transactions running on the designated
node are aborted, the connection is closed, and the server must
be restarted.
</para>
-
+
<para>
The command <command>EXIT SINGLE USER MODE</command> changes the
state of the cluster's data nodes from single user mode to
@@ -12026,15 +12030,14 @@
API node denoted as the single-user node continues to run (if
still connected) during and after the state change.
</para>
-
+
<para>
Example:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>EXIT SINGLE USER MODE</userinput>
</programlisting>
-
<indexterm>
<primary>MySQL Cluster</primary>
@@ -12470,32 +12473,32 @@
<indexterm>
<primary><command>ndb_restore</command></primary>
</indexterm>
-
+
<para>
The cluster restoration program is implemented as a separate
command-line utility <command>ndb_restore</command>, which can
normally be found in the MySQL <filename>bin</filename>
directory. This program reads the files created as a result of
the backup and inserts the stored information into the database.
- </para>
-
+ </para>
+
<para>
<command>ndb_restore</command> must be executed
<literal><replaceable>N</replaceable> + 1</literal> times, where
<replaceable>N</replaceable> is the number of backup files that
were created by the <literal>START BACKUP</literal> command used
- to create the backup (see
+ to create the backup (see
<xref linkend="mysql-cluster-backup-using-management-client"/>).
This is equal to once for restoring cluster metadata (table
- schemas), plus once for each data node in the cluster at
- the time that the backup was created.
+ schemas), plus once for each data node in the cluster at the
+ time that the backup was created.
</para>
<indexterm>
<primary>single user mode (MySQL Cluster)</primary>
<secondary>and <command>ndb_restore</command></secondary>
</indexterm>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Before using
<command>ndb_restore</command>, it is recommended that the
@@ -12512,7 +12515,7 @@
<programlisting>
ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-m] -b <replaceable>backup_id</replaceable> -r <replaceable>/path/to/backup/files</replaceable>
</programlisting>
-
+
<para>
The <option>-c</option> option is used to specify a
connectstring which tells <literal>ndb_restore</literal> where
@@ -12528,8 +12531,8 @@
that can be used by it in the cluster
<filename>config.ini</filename> file. It is a good idea to keep
at least one empty <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in
- <filename>config.ini</filename> that is not being used for a
+ <literal>[MYSQLD]</literal> section in
+ <filename>config.ini</filename> that is not being used for a
MySQL server or other application for this reason (see
<xref linkend="mysql-cluster-api-definition"/>).
</para>
@@ -12593,17 +12596,17 @@
<xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
for more information.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: For more rapid
restoration, the data may be restored in parallel, provided that
there is a sufficient number of cluster connections available.
That is, when restoring to multiple nodes in parallel, you must
- have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
section in the cluster <filename>config.ini</filename> file
available for each concurrent <command>ndb_restore</command>
process. However, the data files must always be applied before
- the logs.
+ the logs.
</para>
<para>
Modified: trunk/refman-5.0/mysql-cluster.xml
===================================================================
--- trunk/refman-5.0/mysql-cluster.xml 2007-01-27 03:42:39 UTC (rev 4672)
+++ trunk/refman-5.0/mysql-cluster.xml 2007-01-27 03:43:48 UTC (rev 4673)
Changed blocks: 18, Lines Added: 73, Lines Deleted: 70; 14473 bytes
@@ -7773,8 +7773,7 @@
<row>
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-datadir">DataDir</link></literal></entry>
<entry>string</entry>
- <entry><filename>./</filename>
- (<command>ndb_mgmd</command> directory)</entry>
+ <entry><filename>./</filename> (<command>ndb_mgmd</command> directory)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>IN</entry>
@@ -7807,7 +7806,8 @@
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-logdestination">LogDestination</link></literal></entry>
<entry><literal>CONSOLE</literal>, <literal>SYSLOG</literal>, or
<literal>FILE</literal></entry>
- <entry><literal>FILE</literal> (see <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
+ <entry><literal>FILE</literal> (see
+ <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>N</entry>
@@ -10695,17 +10695,18 @@
<primary>MySQL Cluster</primary>
<secondary>node logs</secondary>
</indexterm>
-
+
<para>
In this section, we discuss the types of event logs provided by
MySQL Cluster, and the types of events that are logged.
</para>
-
+
<para>
MySQL Cluster provides two types of event log:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
The <firstterm>cluster log</firstterm>, which includes
@@ -10714,7 +10715,7 @@
logging information for an entire cluster in a single
location.
</para>
-
+
<para>
By default, the cluster log is saved to a file named
<filename>ndb_<replaceable>node_id</replaceable>_cluster.log</filename>,
@@ -10722,61 +10723,62 @@
the management server) in the same directory where the
<command>ndb_mgm</command> binary resides.
</para>
-
+
<para>
Cluster logging information can also be sent to
<literal>stdout</literal> or a <literal>syslog</literal>
facility in addition to or instead of being saved to a file,
as determined by the values set for the
<literal>DataDir</literal> and
- <literal>LogDestination</literal> configuration parameters.
- See <xref linkend="mysql-cluster-mgm-definition"/>, for
- more information about these parameters.
+ <literal>LogDestination</literal> configuration parameters.
+ See <xref linkend="mysql-cluster-mgm-definition"/>, for more
+ information about these parameters.
</para>
</listitem>
-
+
<listitem>
<para>
<firstterm>Node logs</firstterm> are local to each node.
</para>
-
+
<para>
Output generated by node event logging is written to the
file
<filename>ndb_<replaceable>node_id</replaceable>_out.log</filename>
(where <replaceable>node_id</replaceable> is the node's node
ID) in the node's <literal>DataDir</literal>. Node event
- logs are generated for both management nodes and data nodes.
+ logs are generated for both management nodes and data nodes.
</para>
-
+
<para>
Node logs are intended to be used only during application
development, or for debugging application code.
</para>
</listitem>
+
</itemizedlist>
-
+
<para>
Both types of event logs can be set to log different subsets of
events.
</para>
-
+
<para>
Each reportable event can be distinguished according to three
different criteria:
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>event types</secondary>
</indexterm>
-
+
<indexterm>
<primary>event types (MySQL Cluster)</primary>
</indexterm>
-
+
<itemizedlist>
-
+
<listitem>
<para>
<emphasis>Category</emphasis>: This can be any one of the
@@ -10788,16 +10790,16 @@
<literal>INFO</literal>.
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis>Priority</emphasis>: This is represented by one of
the numbers from 1 to 15 inclusive, where 1 indicates
<quote>most important</quote> and 15 <quote>least
- important.</quote>
+ important.</quote>
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis>Severity Level</emphasis>: This can be any one of
@@ -10807,19 +10809,19 @@
<literal>DEBUG</literal>.
</para>
</listitem>
-
+
</itemizedlist>
-
+
<para>
Both the cluster log and the node log can be filtered on these
properties.
</para>
-
+
<para>
The format used in the cluster log is as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Data usage is 2%(60 32K pages of total 2560)
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Index usage is 1%(24 8K pages of total 2336)
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Resource 0 min: 0 max: 639 curr: 0
@@ -10843,49 +10845,51 @@
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
</programlisting>
-
+
<para>
Each line in the cluster log contains the following information:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
A timestamp in
<literal><replaceable>YYYY</replaceable>-<replaceable>MM</replaceable>-<replaceable>DD</replaceable>
- <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
- format.
+ <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
+ format.
</para>
</listitem>
-
+
<listitem>
<para>
The type of node which is performing the logging. In the
- cluster log, this is always <literal>[MgmSrvr]</literal>.
+ cluster log, this is always <literal>[MgmSrvr]</literal>.
</para>
</listitem>
-
+
<listitem>
<para>
The severity of the event.
</para>
</listitem>
-
+
<listitem>
<para>
The ID of the node reporting the event.
</para>
</listitem>
-
+
<listitem>
<para>
A description of the event. The most common types of events
- to appear in the log are connections and disconnections
+ to appear in the log are connections and disconnections
between different nodes in the cluster, and when checkpoints
occur. In some cases, the description may contain status
information.
</para>
</listitem>
+
</itemizedlist>
<section id="mysql-cluster-logging-management-commands">
@@ -11057,10 +11061,10 @@
</tbody>
</tgroup>
</informaltable>
-
+
<para>
The <literal>STATISTICS</literal> category can provide a great
- deal of useful data. See
+ deal of useful data. See
<xref linkend="mysql-cluster-log-statistics"/>, for more
information.
</para>
@@ -12048,17 +12052,17 @@
These values are given in bytes. Higher values mean a lower
cost per byte sent or received; the maximum is 64k.
</para>
-
+
<para>
To cause all cluster log statistics to be logged, you can use
the following command in the <literal>NDB</literal> management
- client:
+ client:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>ALL CLUSTERLOG STATISTICS=15</userinput>
</programlisting>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Setting the threshold
for <literal>STATISTICS</literal> to 15 causes the cluster log
@@ -12083,7 +12087,7 @@
<indexterm>
<primary>single user mode (MySQL Cluster)</primary>
</indexterm>
-
+
<para>
<firstterm>Single user mode</firstterm> allows the database
administrator to restrict access to the database system to a
@@ -12091,45 +12095,45 @@
instance of <command>ndb_restore</command>. When entering single
user mode, connections to all other API nodes are closed
gracefully and all running transactions are aborted. No new
- transactions are permitted to start.
+ transactions are permitted to start.
</para>
-
+
<para>
Once the cluster has entered single user mode, only the
designated API node is granted access to the database.
</para>
-
+
<para>
You can use the <command>ALL STATUS</command> command to see
when the cluster has entered single user mode.
</para>
-
+
<para>
Example:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>ENTER SINGLE USER MODE 5</userinput>
</programlisting>
-
+
<para>
After this command has executed and the cluster has entered
single user mode, the API node whose node ID is
<literal>5</literal> becomes the cluster's only permitted user.
</para>
-
+
<para>
The node specified in the preceding command must be an API node;
attempting to specify any other type of node will be rejected.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: When the preceding
commmand is invoked, all transactions running on the designated
node are aborted, the connection is closed, and the server must
be restarted.
</para>
-
+
<para>
The command <command>EXIT SINGLE USER MODE</command> changes the
state of the cluster's data nodes from single user mode to
@@ -12139,15 +12143,14 @@
API node denoted as the single-user node continues to run (if
still connected) during and after the state change.
</para>
-
+
<para>
Example:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>EXIT SINGLE USER MODE</userinput>
</programlisting>
-
<indexterm>
<primary>MySQL Cluster</primary>
@@ -12583,7 +12586,7 @@
<indexterm>
<primary><command>ndb_restore</command></primary>
</indexterm>
-
+
<para>
The cluster restoration program is implemented as a separate
command-line utility <command>ndb_restore</command>, which can
@@ -12591,24 +12594,24 @@
directory. This program reads the files created as a result of
the backup and inserts the stored information into the database.
</para>
-
+
<para>
<command>ndb_restore</command> must be executed
<literal><replaceable>N</replaceable> + 1</literal> times, where
<replaceable>N</replaceable> is the number of backup files that
were created by the <literal>START BACKUP</literal> command used
- to create the backup (see
+ to create the backup (see
<xref linkend="mysql-cluster-backup-using-management-client"/>).
This is equal to once for restoring cluster metadata (table
- schemas), plus once for each data node in the cluster at
- the time that the backup was created.
+ schemas), plus once for each data node in the cluster at the
+ time that the backup was created.
</para>
<indexterm>
<primary>single user mode (MySQL Cluster)</primary>
<secondary>and <command>ndb_restore</command></secondary>
</indexterm>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Before using
<command>ndb_restore</command>, it is recommended that the
@@ -12625,7 +12628,7 @@
<programlisting>
ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-m] -b <replaceable>backup_id</replaceable> -r <replaceable>/path/to/backup/files</replaceable>
</programlisting>
-
+
<para>
The <option>-c</option> option is used to specify a
connectstring which tells <literal>ndb_restore</literal> where
@@ -12641,8 +12644,8 @@
that can be used by it in the cluster
<filename>config.ini</filename> file. It is a good idea to keep
at least one empty <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in
- <filename>config.ini</filename> that is not being used for a
+ <literal>[MYSQLD]</literal> section in
+ <filename>config.ini</filename> that is not being used for a
MySQL server or other application for this reason (see
<xref linkend="mysql-cluster-api-definition"/>).
</para>
@@ -12706,17 +12709,17 @@
<xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
for more information.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: For more rapid
restoration, the data may be restored in parallel, provided that
there is a sufficient number of cluster connections available.
That is, when restoring to multiple nodes in parallel, you must
- have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
section in the cluster <filename>config.ini</filename> file
available for each concurrent <command>ndb_restore</command>
process. However, the data files must always be applied before
- the logs.
+ the logs.
</para>
<para>
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-01-27 03:42:39 UTC (rev 4672)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-01-27 03:43:48 UTC (rev 4673)
Changed blocks: 18, Lines Added: 74, Lines Deleted: 70; 14536 bytes
@@ -7795,8 +7795,7 @@
<row>
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-datadir">DataDir</link></literal></entry>
<entry>string</entry>
- <entry><filename>./</filename>
- (<command>ndb_mgmd</command> directory)</entry>
+ <entry><filename>./</filename> (<command>ndb_mgmd</command> directory)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>IN</entry>
@@ -7829,7 +7828,8 @@
<entry><literal><link linkend="mysql-cluster-param-mgm-definition-logdestination">LogDestination</link></literal></entry>
<entry><literal>CONSOLE</literal>, <literal>SYSLOG</literal>, or
<literal>FILE</literal></entry>
- <entry><literal>FILE</literal> (see <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
+ <entry><literal>FILE</literal> (see
+ <xref linkend="mysql-cluster-mgm-definition"/>)</entry>
<entry>N/A</entry>
<entry>N/A</entry>
<entry>N</entry>
@@ -10748,17 +10748,18 @@
<primary>MySQL Cluster</primary>
<secondary>node logs</secondary>
</indexterm>
-
+
<para>
In this section, we discuss the types of event logs provided by
MySQL Cluster, and the types of events that are logged.
</para>
-
+
<para>
MySQL Cluster provides two types of event log:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
The <firstterm>cluster log</firstterm>, which includes
@@ -10767,7 +10768,7 @@
logging information for an entire cluster in a single
location.
</para>
-
+
<para>
By default, the cluster log is saved to a file named
<filename>ndb_<replaceable>node_id</replaceable>_cluster.log</filename>,
@@ -10775,61 +10776,62 @@
the management server) in the same directory where the
<command>ndb_mgm</command> binary resides.
</para>
-
+
<para>
Cluster logging information can also be sent to
<literal>stdout</literal> or a <literal>syslog</literal>
facility in addition to or instead of being saved to a file,
as determined by the values set for the
<literal>DataDir</literal> and
- <literal>LogDestination</literal> configuration parameters.
- See <xref linkend="mysql-cluster-mgm-definition"/>, for
- more information about these parameters.
+ <literal>LogDestination</literal> configuration parameters.
+ See <xref linkend="mysql-cluster-mgm-definition"/>, for more
+ information about these parameters.
</para>
</listitem>
-
+
<listitem>
<para>
<firstterm>Node logs</firstterm> are local to each node.
</para>
-
+
<para>
Output generated by node event logging is written to the
file
<filename>ndb_<replaceable>node_id</replaceable>_out.log</filename>
(where <replaceable>node_id</replaceable> is the node's node
ID) in the node's <literal>DataDir</literal>. Node event
- logs are generated for both management nodes and data nodes.
+ logs are generated for both management nodes and data nodes.
</para>
-
+
<para>
Node logs are intended to be used only during application
development, or for debugging application code.
</para>
</listitem>
+
</itemizedlist>
-
+
<para>
Both types of event logs can be set to log different subsets of
events.
</para>
-
+
<para>
Each reportable event can be distinguished according to three
different criteria:
</para>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>event types</secondary>
</indexterm>
-
+
<indexterm>
<primary>event types (MySQL Cluster)</primary>
</indexterm>
-
+
<itemizedlist>
-
+
<listitem>
<para>
<emphasis>Category</emphasis>: This can be any one of the
@@ -10841,16 +10843,16 @@
<literal>INFO</literal>.
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis>Priority</emphasis>: This is represented by one of
the numbers from 1 to 15 inclusive, where 1 indicates
<quote>most important</quote> and 15 <quote>least
- important.</quote>
+ important.</quote>
</para>
</listitem>
-
+
<listitem>
<para>
<emphasis>Severity Level</emphasis>: This can be any one of
@@ -10860,19 +10862,19 @@
<literal>DEBUG</literal>.
</para>
</listitem>
-
+
</itemizedlist>
-
+
<para>
Both the cluster log and the node log can be filtered on these
properties.
</para>
-
+
<para>
The format used in the cluster log is as shown here:
</para>
-
- <programlisting>
+
+<programlisting>
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Data usage is 2%(60 32K pages of total 2560)
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Index usage is 1%(24 8K pages of total 2336)
2007-01-26 19:35:55 [MgmSrvr] INFO -- Node 1: Resource 0 min: 0 max: 639 curr: 0
@@ -10896,49 +10898,51 @@
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
2007-01-26 19:59:22 [MgmSrvr] ALERT -- Node 2: Node 7 Disconnected
</programlisting>
-
+
<para>
Each line in the cluster log contains the following information:
</para>
-
+
<itemizedlist>
+
<listitem>
<para>
A timestamp in
<literal><replaceable>YYYY</replaceable>-<replaceable>MM</replaceable>-<replaceable>DD</replaceable>
- <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
- format.
+ <replaceable>HH</replaceable>:<replaceable>MM</replaceable>:<replaceable>SS</replaceable></literal>
+ format.
</para>
</listitem>
-
+
<listitem>
<para>
The type of node which is performing the logging. In the
- cluster log, this is always <literal>[MgmSrvr]</literal>.
+ cluster log, this is always <literal>[MgmSrvr]</literal>.
</para>
</listitem>
-
+
<listitem>
<para>
The severity of the event.
</para>
</listitem>
-
+
<listitem>
<para>
The ID of the node reporting the event.
</para>
</listitem>
-
+
<listitem>
<para>
A description of the event. The most common types of events
- to appear in the log are connections and disconnections
+ to appear in the log are connections and disconnections
between different nodes in the cluster, and when checkpoints
occur. In some cases, the description may contain status
information.
</para>
</listitem>
+
</itemizedlist>
<section id="mysql-cluster-logging-management-commands">
@@ -11110,10 +11114,10 @@
</tbody>
</tgroup>
</informaltable>
-
+
<para>
The <literal>STATISTICS</literal> category can provide a great
- deal of useful data. See
+ deal of useful data. See
<xref linkend="mysql-cluster-log-statistics"/>, for more
information.
</para>
@@ -12101,17 +12105,17 @@
These values are given in bytes. Higher values mean a lower
cost per byte sent or received; the maximum is 64k.
</para>
-
+
<para>
To cause all cluster log statistics to be logged, you can use
the following command in the <literal>NDB</literal> management
- client:
+ client:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>ALL CLUSTERLOG STATISTICS=15</userinput>
</programlisting>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Setting the threshold
for <literal>STATISTICS</literal> to 15 causes the cluster log
@@ -12136,7 +12140,7 @@
<indexterm>
<primary>single user mode (MySQL Cluster)</primary>
</indexterm>
-
+
<para>
<firstterm>Single user mode</firstterm> allows the database
administrator to restrict access to the database system to a
@@ -12144,45 +12148,45 @@
instance of <command>ndb_restore</command>. When entering single
user mode, connections to all other API nodes are closed
gracefully and all running transactions are aborted. No new
- transactions are permitted to start.
+ transactions are permitted to start.
</para>
-
+
<para>
Once the cluster has entered single user mode, only the
designated API node is granted access to the database.
</para>
-
+
<para>
You can use the <command>ALL STATUS</command> command to see
when the cluster has entered single user mode.
</para>
-
+
<para>
Example:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>ENTER SINGLE USER MODE 5</userinput>
</programlisting>
-
+
<para>
After this command has executed and the cluster has entered
single user mode, the API node whose node ID is
<literal>5</literal> becomes the cluster's only permitted user.
</para>
-
+
<para>
The node specified in the preceding command must be an API node;
attempting to specify any other type of node will be rejected.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: When the preceding
commmand is invoked, all transactions running on the designated
node are aborted, the connection is closed, and the server must
be restarted.
</para>
-
+
<para>
The command <command>EXIT SINGLE USER MODE</command> changes the
state of the cluster's data nodes from single user mode to
@@ -12192,15 +12196,15 @@
API node denoted as the single-user node continues to run (if
still connected) during and after the state change.
</para>
-
+
<para>
Example:
</para>
-
+
<programlisting>
ndb_mgm> <userinput>EXIT SINGLE USER MODE</userinput>
</programlisting>
-
+
<indexterm>
<primary>MySQL Cluster</primary>
<secondary>node failure (single user mode)</secondary>
@@ -12635,7 +12639,7 @@
<indexterm>
<primary><command>ndb_restore</command></primary>
</indexterm>
-
+
<para>
The cluster restoration program is implemented as a separate
command-line utility <command>ndb_restore</command>, which can
@@ -12643,24 +12647,24 @@
directory. This program reads the files created as a result of
the backup and inserts the stored information into the database.
</para>
-
+
<para>
<command>ndb_restore</command> must be executed
<literal><replaceable>N</replaceable> + 1</literal> times, where
<replaceable>N</replaceable> is the number of backup files that
were created by the <literal>START BACKUP</literal> command used
- to create the backup (see
+ to create the backup (see
<xref linkend="mysql-cluster-backup-using-management-client"/>).
This is equal to once for restoring cluster metadata (table
- schemas), plus once for each data node in the cluster at
- the time that the backup was created.
+ schemas), plus once for each data node in the cluster at the
+ time that the backup was created.
</para>
<indexterm>
<primary>single user mode (MySQL Cluster)</primary>
<secondary>and <command>ndb_restore</command></secondary>
</indexterm>
-
+
<para>
<emphasis role="bold">Note</emphasis>: Before using
<command>ndb_restore</command>, it is recommended that the
@@ -12677,7 +12681,7 @@
<programlisting>
ndb_restore [-c <replaceable>connectstring</replaceable>] -n <replaceable>node_id</replaceable> [-m] -b <replaceable>backup_id</replaceable> -r <replaceable>/path/to/backup/files</replaceable>
</programlisting>
-
+
<para>
The <option>-c</option> option is used to specify a
connectstring which tells <literal>ndb_restore</literal> where
@@ -12693,8 +12697,8 @@
that can be used by it in the cluster
<filename>config.ini</filename> file. It is a good idea to keep
at least one empty <literal>[API]</literal> or
- <literal>[MYSQLD]</literal> section in
- <filename>config.ini</filename> that is not being used for a
+ <literal>[MYSQLD]</literal> section in
+ <filename>config.ini</filename> that is not being used for a
MySQL server or other application for this reason (see
<xref linkend="mysql-cluster-api-definition"/>).
</para>
@@ -12760,17 +12764,17 @@
<xref linkend="mysql-cluster-upgrade-downgrade-compatibility"/>,
for more information.
</para>
-
+
<para>
<emphasis role="bold">Note</emphasis>: For more rapid
restoration, the data may be restored in parallel, provided that
there is a sufficient number of cluster connections available.
That is, when restoring to multiple nodes in parallel, you must
- have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
+ have an <literal>[API]</literal> or <literal>[MYSQLD]</literal>
section in the cluster <filename>config.ini</filename> file
available for each concurrent <command>ndb_restore</command>
process. However, the data files must always be applied before
- the logs.
+ the logs.
</para>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r4673 - branches/telcos/refman-5.1 trunk/refman-4.1 trunk/refman-5.0 trunk/refman-5.1 | jon | 27 Jan |
