svn commit - mysqldoc@docsrva: r4338 - branches/telcos/refman-5.1

[jon]

Author: jstephens
Date: 2006-12-23 15:49:37 +0100 (Sat, 23 Dec 2006)
New Revision: 4338

Log:

Documenting new MemReportFrequency config parameter for Telco builds.



Modified:
   branches/telcos/refman-5.1/mysql-cluster.xml


Modified: branches/telcos/refman-5.1/mysql-cluster.xml
===================================================================
--- branches/telcos/refman-5.1/mysql-cluster.xml	2006-12-23 06:52:41 UTC (rev 4337)
+++ branches/telcos/refman-5.1/mysql-cluster.xml	2006-12-23 14:49:37 UTC (rev 4338)
Changed blocks: 2, Lines Added: 60, Lines Deleted: 0; 3541 bytes

@@ -5693,6 +5693,58 @@
             </para>
           </listitem>
 
+          <listitem>
+            <indexterm>
+             
<primary><literal>MemReportFrequency</literal></primary>
+            </indexterm>
+
+            <para id="mysql-cluster-param-ndbd-definition-memreportfrequency">
+              <literal>MemReportFrequency</literal>
+            </para>
+
+            <para>
+              This parameter controls how often data node memory usage
+              reports are recorded in the cluster log; it is an integer
+              value representing the number of seconds between reports.
+            </para>
+            
+            <para>
+              Each data node's data memory and index memory usage is
+              logged as both a percentage and a number of 32 KB pages of
+              the <literal>DataMemory</literal> and
+              <literal>IndexMemory</literal>, respectively, set in the 
+              <filename>config.ini</filename> file. For example, if
+              <literal>DataMemory</literal> is equal to 100 MB, and a
+              given data node is using 50 MB for data memory storage,
+              the corresponding line in the cluster log might look like
+              this:   
+            </para>
+
+<programlisting>
[phone]:18:16 [MgmSrvr] INFO -- Node 2: Data usage is 50%(1280 32K pages of total
2560)
+</programlisting>
+            
+            <para>
+              <literal>MemReportFrequency</literal> is not a required
+              parameter. If used, it can be set for all cluster data
+              nodes in the <literal>[NDBD DEFAULT]</literal> section of
+              <filename>config.ini</filename>, and can also be set or
+              overridden for individual data nodes in the corresponding
+              <literal>[NDBD]</literal> sections of the configuration
+              file. The minimum value &mdash; which is also the default
+              value &mdash; is 0, in which case memory reports are
+              logged only when memory usage reaches certain percentages
+              (80%, 90%, and 100%), as mentioned in the discussion of
+              statistics events in 
+              <xref linkend="mysql-cluster-log-events"/>.
+            </para>
+            
+            <para>
+              This parameter was added in MySQL Cluster
+              5.1.14/NDB-6.1.0-beta.
+            </para>
+          </listitem>
+
         </itemizedlist>
 
         <para id="mysql-cluster-backup-parameters">

@@ -7268,6 +7320,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>