Author: jstephens
Date: 2007-03-04 07:37:41 +0100 (Sun, 04 Mar 2007)
New Revision: 5162
Log:
Fixes for Docs Bug #26636 (missing/outdated info on data node
configuration parameters)
Modified:
trunk/refman-5.1/mysql-cluster.xml
trunk/refman-5.1/news-5.1.xml
Modified: trunk/refman-5.1/mysql-cluster.xml
===================================================================
--- trunk/refman-5.1/mysql-cluster.xml 2007-03-03 18:55:57 UTC (rev 5161)
+++ trunk/refman-5.1/mysql-cluster.xml 2007-03-04 06:37:41 UTC (rev 5162)
Changed blocks: 21, Lines Added: 197, Lines Deleted: 51; 17425 bytes
@@ -4537,16 +4537,16 @@
in the SQL nodes.
</para>
</listitem>
-
+
<listitem>
<indexterm>
<primary><literal>LongMessageBuffer</literal></primary>
</indexterm>
-
+
<para id="mysql-cluster-param-ndbd-definition-longmessagebuffer">
<literal>LongMessageBuffer</literal>
</para>
-
+
<para>
This is an internal buffer used for passing messages
within individual nodes and between nodes. Although it is
@@ -4554,7 +4554,7 @@
configurable. By default, it is set to 1MB.
</para>
</listitem>
-
+
</itemizedlist>
<para id="mysql-cluster-logging-and-checkpointing">
@@ -4633,35 +4633,55 @@
do so via a rolling node restart.
</para>
</listitem>
-
+
<listitem>
<indexterm>
<primary><literal>MaxNoOfOpenFiles</literal></primary>
</indexterm>
-
+
<remark role="todo">
If this doesn't ever need to be changed, then why is it
even mentioned? [js]
</remark>
-
+
<para id="mysql-cluster-param-ndbd-definition-maxnoofopenfiles">
<literal>MaxNoOfOpenFiles</literal>
</para>
-
+
<para>
This parameter sets a ceiling on how many internal threads
to allocate for open files. <emphasis>Any situation
- requiring a change in this parameter should be reported as
- a bug</emphasis>.
+ requiring a change in this parameter should be reported as
+ a bug</emphasis>.
</para>
-
+
<para>
The default value is 40.
</para>
</listitem>
-
+
+
<listitem>
<indexterm>
+ <primary><literal>InitialNoOfOpenFiles</literal></primary>
+ </indexterm>
+
+ <para id="mysql-cluster-param-ndbd-definition-initialnoofopenfiles">
+ <literal>InitialNoOfOpenFiles</literal>
+ </para>
+
+ <para>
+ This parameter sets the initial number of internal threads
+ to allocate for open files.
+ </para>
+
+ <para>
+ The default value is 27.
+ </para>
+ </listitem>
+
+ <listitem>
+ <indexterm>
<primary><literal>MaxNoOfSavedMessages</literal></primary>
</indexterm>
@@ -4679,6 +4699,33 @@
The default is 25 trace files.
</para>
</listitem>
+
+
+ <listitem>
+ <indexterm>
+ <primary><literal>MemReportFrequency</literal></primary>
+ </indexterm>
+
+ <para id="mysql-cluster-param-ndbd-definition-memreportfrequency">
+ <literal>MemReportFrequency</literal>
+ </para>
+
+ <para>
+ By default, warnings are written to the cluster only when
+ high levels of data node
+ memory usage are reached. Beginning with MySQL 5.1.16, it
+ is possible — by setting this configuration
+ parameter to a non-zero value <replaceable>N</replaceable>
+ — to cause a memory usage report to be written to the
+ cluster each <replaceable>N</replaceable> seconds instead.
+ </para>
+
+ <para>
+ The default value is 0, in which case memory warnings are
+ logged only when the thresholds of 80%, 85%, 90%, 95%, and
+ 100% of data node memory usage are reached.
+ </para>
+ </listitem>
</itemizedlist>
@@ -5722,8 +5769,8 @@
<emphasis role="bold">Note</emphasis>: The
<literal>UndoIndexBuffer</literal> and
<literal>UndoDataBuffer</literal> parameters which appeared in
- earlier versions of MySQL Cluster are no longer necessary (or
- even present) in MySQL 5.1.
+ earlier versions of MySQL Cluster are no longer necessary in
+ MySQL 5.1.
</para>
<para id="mysql-cluster-controlling-log-messages">
@@ -5877,27 +5924,47 @@
The default level is 0.
</para>
</listitem>
-
+
<listitem>
<indexterm>
<primary><literal>LogLevelError</literal></primary>
</indexterm>
-
+
<para id="mysql-cluster-param-ndbd-definition-loglevelerror">
<literal>LogLevelError</literal>
</para>
-
+
<para>
The reporting level for events generated by errors and
warnings by the cluster as a whole. These errors do not
cause any node failure but are still considered worth
reporting.
</para>
-
+
<para>
The default level is 0.
</para>
</listitem>
+
+ <listitem>
+ <indexterm>
+ <primary><literal>LogLevelCongestion</literal></primary>
+ </indexterm>
+
+ <para id="mysql-cluster-param-ndbd-definition-loglevelcongestion">
+ <literal>LogLevelCongestion</literal>
+ </para>
+
+ <para>
+ The reporting level for events generated by congestion.
+ These errors do not cause node failure but are still
+ considered worth reporting.
+ </para>
+
+ <para>
+ The default level is 0.
+ </para>
+ </listitem>
<listitem>
<indexterm>
@@ -7154,7 +7221,7 @@
<row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-arbitrationtimeout">ArbitrationTimeout</link></literal></entry>
<entry>milliseconds</entry>
- <entry>1000</entry>
+ <entry>3000</entry>
<entry>10</entry>
<entry>4294967039</entry>
<entry>N</entry>
@@ -7233,6 +7300,24 @@
<entry>N</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-diskcheckpointspeed">DiskCheckpointSpeed</link></literal>
+ (added in MySQL 5.1.12)</entry>
+ <entry>integer (number of bytes per second)</entry>
+ <entry>10M</entry>
+ <entry>1M</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
+ <row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-diskcheckpointspeedinrestart">DiskCheckpointSpeedInRestart</link></literal>
+ (added in MySQL 5.1.12)</entry>
+ <entry>integer (number of bytes per second)</entry>
+ <entry>100M</entry>
+ <entry>1M</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-diskless">Diskless</link></literal></entry>
<entry>true|false (<literal>1</literal>|<literal>0</literal>)</entry>
<entry>0</entry>
@@ -7241,6 +7326,23 @@
<entry>IS</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-disk-data-diskpagebuffermemory">DiskPageBufferMemory</link></literal></entry>
+ <entry>bytes</entry>
+ <entry>64M</entry>
+ <entry>4M</entry>
+ <entry>1024G</entry>
+ <entry>IS</entry>
+ </row>
+ <row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-disksyncsize">DiskSyncSize</link></literal>
+ (added in MySQL 5.1.12)</entry>
+ <entry>integer (number of bytes)</entry>
+ <entry>4M</entry>
+ <entry>32K</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-executeoncomputer">ExecuteOnComputer</link></literal></entry>
<entry>integer</entry>
<entry/>
@@ -7298,6 +7400,14 @@
<entry>N</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-initialnoofopenfiles">InitialNoOfOpenFiles</link></literal></entry>
+ <entry>integer</entry>
+ <entry>27</entry>
+ <entry>20</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-lockpagesinmainmemory">LockPagesInMainMemory</link></literal></entry>
<entry><emphasis>As of MySQL 5.1.15</emphasis>: integer;
<emphasis>previously</emphasis>: true|false
@@ -7316,6 +7426,14 @@
<entry>IN</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-loglevelcongestion">LogLevelCongestion</link></literal></entry>
+ <entry>integer</entry>
+ <entry>0</entry>
+ <entry>0</entry>
+ <entry>15</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-loglevelconnection">LogLevelConnection</link></literal></entry>
<entry>integer</entry>
<entry>0</entry>
@@ -7455,6 +7573,14 @@
<entry>N</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-maxnoofopenfiles">MaxNoOfOpenFiles</link></literal></entry>
+ <entry>integer</entry>
+ <entry>40</entry>
+ <entry>20</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-maxnooforderedindexes">MaxNoOfOrderedIndexes</link></literal></entry>
<entry>integer</entry>
<entry>128</entry>
@@ -7495,6 +7621,14 @@
<entry>N</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-memreportfrequency">MemReportFrequency</link></literal></entry>
+ <entry>integer</entry>
+ <entry>0</entry>
+ <entry>0</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-noofdiskpagestodiskafterrestartacc">NoOfDiskPagesToDiskAfterRestartACC</link></literal>
(<emphasis>DEPRECATED</emphasis> as of MySQL 5.1.6)</entry>
<entry>integer (number of 8KB pages per 100 milliseconds)</entry>
@@ -7531,37 +7665,10 @@
<entry>N</entry>
</row>
<row>
- <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-diskcheckpointspeed">DiskCheckpointSpeed</link></literal>
- (added in MySQL 5.1.12)</entry>
- <entry>integer (number of bytes per second)</entry>
- <entry>10M</entry>
- <entry>1M</entry>
- <entry>4294967039</entry>
- <entry>N</entry>
- </row>
- <row>
- <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-diskcheckpointspeedinrestart">DiskCheckpointSpeedInRestart</link></literal>
- (added in MySQL 5.1.12)</entry>
- <entry>integer (number of bytes per second)</entry>
- <entry>100M</entry>
- <entry>1M</entry>
- <entry>4294967039</entry>
- <entry>N</entry>
- </row>
- <row>
- <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-disksyncsize">DiskSyncSize</link></literal>
- (added in MySQL 5.1.12)</entry>
- <entry>integer (number of bytes)</entry>
- <entry>4M</entry>
- <entry>32K</entry>
- <entry>4294967039</entry>
- <entry>N</entry>
- </row>
- <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-nooffragmentlogfiles">NoOfFragmentLogFiles</link></literal></entry>
<entry>integer</entry>
- <entry>8</entry>
- <entry>1</entry>
+ <entry>16</entry>
+ <entry>3</entry>
<entry>4294967039</entry>
<entry>IN</entry>
</row>
@@ -7600,6 +7707,15 @@
<entry>N</entry>
</row>
<row>
+ <entry><literal><link
+ linkend="mysql-cluster-param-disk-data-sharedglobalmemory">SharedGlobalmemory</link></literal></entry>
+ <entry>bytes</entry>
+ <entry>20M</entry>
+ <entry>0</entry>
+ <entry>65536G</entry>
+ <entry>N</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-startfailuretimeout">StartFailureTimeout</link></literal></entry>
<entry>milliseconds</entry>
<entry>0</entry>
@@ -7632,6 +7748,16 @@
<entry>N</entry>
</row>
<row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-stringmemory">StringMemory</link></literal></entry>
+ <entry>integer or percentage (see <link
+ linkend="mysql-cluster-param-ndbd-definition-stringmemory">description</link>
+ for details)</entry>
+ <entry>0</entry>
+ <entry>0</entry>
+ <entry>4294967039</entry>
+ <entry>S</entry>
+ </row>
+ <row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-timebetweenglobalcheckpoints">TimeBetweenGlobalCheckpoints</link></literal></entry>
<entry>milliseconds</entry>
<entry>2000</entry>
@@ -7659,7 +7785,7 @@
<row>
<entry><literal><link linkend="mysql-cluster-param-ndbd-definition-timebetweenwatchdogcheck">TimeBetweenWatchDogCheck</link></literal></entry>
<entry>milliseconds</entry>
- <entry>4000</entry>
+ <entry>6000</entry>
<entry>70</entry>
<entry>4294967039</entry>
<entry>N</entry>
@@ -7688,6 +7814,22 @@
<entry>4294967039</entry>
<entry>N</entry>
</row>
+ <row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-undodatabuffer">UndoDataBuffer</link></literal> (<emphasis>OBSOLETE</emphasis>)</entry>
+ <entry>bytes</entry>
+ <entry>2M</entry>
+ <entry>1M</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
+ <row>
+ <entry><literal><link linkend="mysql-cluster-param-ndbd-definition-undodatabuffer">UndoDataBuffer</link></literal> (<emphasis>OBSOLETE</emphasis>)</entry>
+ <entry>bytes</entry>
+ <entry>2M</entry>
+ <entry>1M</entry>
+ <entry>4294967039</entry>
+ <entry>N</entry>
+ </row>
</tbody>
</tgroup>
</informaltable>
@@ -18341,7 +18483,7 @@
<primary><literal>DiskPageBufferMemory</literal></primary>
</indexterm>
- <para>
+ <para id="mysql-cluster-param-disk-data-diskpagebuffermemory">
<literal>DiskPageBufferMemory</literal>
</para>
@@ -18362,7 +18504,7 @@
<primary><literal>SharedGlobalMemory</literal></primary>
</indexterm>
- <para>
+ <para id="mysql-cluster-param-disk-data-sharedglobalmemory">
<literal>SharedGlobalMemory</literal>
</para>
@@ -18376,6 +18518,10 @@
<filename>config.ini</filename> configuration file, and is
measured in bytes.
</para>
+
+ <para>
+ The default value is 20M.
+ </para>
</listitem>
</itemizedlist>
Modified: trunk/refman-5.1/news-5.1.xml
===================================================================
--- trunk/refman-5.1/news-5.1.xml 2007-03-03 18:55:57 UTC (rev 5161)
+++ trunk/refman-5.1/news-5.1.xml 2007-03-04 06:37:41 UTC (rev 5162)
Changed blocks: 1, Lines Added: 12, Lines Deleted: 0; 882 bytes
@@ -171,6 +171,18 @@
information.
</para>
</listitem>
+
+ <listitem>
+ <para>
+ <literal>NDB Cluster</literal>: A new configuration parameter
+ <literal>MemReportFrequency</literal> allows for additional
+ control of data node memory usage. Previously, only warnings
+ at predetermined percentages of memory allocation were given;
+ setting this parameter allows for that behavior to be
+ overridden. For more information, see
+ <xref linkend="mysql-cluster-ndbd-definition"/>.
+ </para>
+ </listitem>
<listitem>
<para>
| Thread |
|---|
| • svn commit - mysqldoc@docsrva: r5162 - trunk/refman-5.1 | jon | 4 Mar |
