List:Commits« Previous MessageNext Message »
From:john.russell Date:January 19 2011 11:10pm
Subject:svn commit - mysqldoc@docsrva: r24853 - trunk/mysql-monitor-2.2
View as plain text  
Author: jrussell
Date: 2011-01-20 00:09:59 +0100 (Thu, 20 Jan 2011)
New Revision: 24853

Log:
Backport more index entries and editorial changes.


Modified:
   trunk/mysql-monitor-2.2/data-items-core.xml
   trunk/mysql-monitor-2.2/faq-core.xml
   trunk/mysql-monitor-2.2/install-postinstall.xml
   trunk/mysql-monitor-2.2/install-upgrades.xml
   trunk/mysql-monitor-2.2/introduction.xml
   trunk/mysql-monitor-2.2/licenses-third-party-core.xml
   trunk/mysql-monitor-2.2/news-core.xml
   trunk/mysql-monitor-2.2/query-analyzer-cj-core.xml
   trunk/mysql-monitor-2.2/query-analyzer-cnet-core.xml
   trunk/mysql-monitor-2.2/query-analyzer-using-consuming.xml
   trunk/mysql-monitor-2.2/query-analyzer-using-feeding-core.xml
   trunk/mysql-monitor-2.2/query-analyzer-using-proxy.xml
   trunk/mysql-monitor-2.2/query-analyzer-using-troubleshooting.xml
   trunk/mysql-monitor-2.2/query-analyzer-using-ui.xml
   trunk/mysql-monitor-2.2/query-analyzer-using.xml


Modified: trunk/mysql-monitor-2.2/data-items-core.xml
===================================================================
--- trunk/mysql-monitor-2.2/data-items-core.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/data-items-core.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 0; 471 bytes

@@ -9,6 +9,10 @@
 
   <title>Data Collection Items</title>
 
+  <indexterm>
+    <primary>data collection items</primary>
+  </indexterm>
+
   <remark role="dynamic-dependency-list"/>
 
   <note>


Modified: trunk/mysql-monitor-2.2/faq-core.xml
===================================================================
--- trunk/mysql-monitor-2.2/faq-core.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/faq-core.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 0; 447 bytes

@@ -9,6 +9,10 @@
 
   <title>&merlin; Frequently Asked Questions</title>
 
+  <indexterm>
+    <primary>FAQs</primary>
+  </indexterm>
+
   <remark role="dynamic-dependency-list"/>
 
   <note>


Modified: trunk/mysql-monitor-2.2/install-postinstall.xml
===================================================================
--- trunk/mysql-monitor-2.2/install-postinstall.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/install-postinstall.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 9, Lines Deleted: 0; 688 bytes

@@ -9,6 +9,15 @@
 
   <title>Postinstallation Considerations</title>
 
+  <indexterm>
+    <primary>postinstall tasks</primary>
+  </indexterm>
+
+  <indexterm>
+    <primary>installation</primary>
+    <secondary>postinstall tasks</secondary>
+  </indexterm>
+
   <para>
     Depending upon how you plan to use the &merlin;, there are some
     tasks you may want to perform after installation. Find some


Modified: trunk/mysql-monitor-2.2/install-upgrades.xml
===================================================================
--- trunk/mysql-monitor-2.2/install-upgrades.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/install-upgrades.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 1, Lines Deleted: 1; 663 bytes

@@ -223,7 +223,7 @@
         <title>Upgrading to &merlin_server; 2.0</title>
 
         <para>
-          Upgrading &merlin_server; requires you to use on of the
+          Upgrading &merlin_server; requires you to use one of the
           <emphasis>update</emphasis> installers. The update installer
           performs a number of operations during installation:
         </para>


Modified: trunk/mysql-monitor-2.2/introduction.xml
===================================================================
--- trunk/mysql-monitor-2.2/introduction.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/introduction.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 10, Lines Added: 41, Lines Deleted: 23; 5577 bytes

@@ -9,6 +9,14 @@
 
   <title>&merlin; Introduction and Architecture</title>
 
+  <indexterm>
+    <primary>architecture</primary>
+  </indexterm>
+
+  <indexterm>
+    <primary>overview</primary>
+  </indexterm>
+
   <para>
     &merlin; is an enterprise monitoring system for MySQL that keeps an
     eye on your MySQL servers, notifies you of potential issues and

@@ -126,14 +134,14 @@
   </para>
 
   <para>
-    You can configure the &merlin_agent; to collect detailed information
-    about the queries executed on your server, including the row counts
-    and performance times for executing each query. You can correlate
-    the detailed query data with the graphical information to identify
-    which queries were executing when you experienced a particularly
-    high load, index or other issue. The query data is supported by a
-    system called Query Analyzer, and the data can be presented in
-    different ways depending on your needs.
+    The &merlin_agent; can also be configured to collect detailed
+    information about the queries executed on your server, including the
+    row counts and performance times for executing each query. You can
+    correlate the detailed query data with the graphical information to
+    identify which queries were executing when you experienced a
+    particularly high load, index or other issue. The query data is
+    supported by a system called Query Analyzer, and the data can be
+    presented in different ways depending on your needs.
   </para>
 
   <section id="mem-introduction-server">

@@ -142,7 +150,7 @@
 
     <para>
       The &merlin_server; is the hub of &merlin;: it collects
-      information, stores the information for display, generating
+      information, stores the information for display, generates
       warnings and alerts, sends emails and other notifications, and
       supports the &merlin_client; as the interface to the system.
     </para>

@@ -167,6 +175,16 @@
     <itemizedlist>
 
       <listitem>
+        <indexterm>
+          <primary>Tomcat</primary>
+          <secondary>role in MySQL Enterprise Service Manager core</secondary>
+        </indexterm>
+
+        <indexterm>
+          <primary>Java VM</primary>
+          <secondary>role in MySQL Enterprise Service Manager core</secondary>
+        </indexterm>
+
         <para>
           The &merlin_server; core, built on top of the Tomcat web
           server, is the server that handles tasks such as collecting

@@ -212,9 +230,9 @@
       <listitem>
         <para>
           The data collected by the &merlin_server; is stored within the
-          &merlin; repository. The repository uses a MySQL database,
-          which enables &merlin; to take advantage of MySQL features
-          such as the InnoDB storage engine and partitioning systems.
+          &merlin; repository. The repository uses a MySQL database, so
+          that &merlin; can take advantage of MySQL features such as the
+          InnoDB storage engine and partitioning systems.
         </para>
 
 <!-- JDR: again, might be too early to get into optimization tasks. -->

@@ -364,9 +382,8 @@
     </para>
 
     <para>
-      All advisors are executed according to a
-      <firstterm>schedule</firstterm> that determines how frequently
-      each advisor is executed.
+      A <firstterm>schedule</firstterm> determines how frequently each
+      advisor is executed.
     </para>
 
   </section>

@@ -376,8 +393,8 @@
     <title>Monitored MySQL Server</title>
 
     <para>
-      &merlin; can monitor any MySQL server from MySQL 4.1 to 6.0. The
-      advisors and rules provide specific support for different
+      &merlin; can monitor any MySQL server running MySQL 4.1 or higher.
+      The advisors and rules provide specific support for different
       versions. For example, there are unique rules and graphs for
       different MySQL versions, and some rules provide advice about
       MySQL upgrades.

@@ -460,8 +477,8 @@
         <para>
           Configure the MySQL server with a user that has the correct
           permissions and rights to be able to monitor the different
-          parameters of the server. The installation guide provides
-          instructions to create a suitable user.
+          parameters of the server. For instructions to create a
+          suitable user, see <xref linkend="mem-agent-rights"/>.
         </para>
       </listitem>
 

@@ -566,9 +583,9 @@
     <para>
       Each &merlin_agent; requires a UUID to uniquely identify the
       &merlin_agent; to the &merlin_server;. This UUID is independent of
-      the UUID assigned to each monitored server. Take care that you do
-      not copy the UUID from one instance of the agent to another, as it
-      will cause duplicate agent UUID exceptions.
+      the UUID assigned to each monitored server. Do not copy the UUID
+      from one instance of the agent to another, as that would cause
+      duplicate agent UUID exceptions.
     </para>
 
     <para>

@@ -694,7 +711,8 @@
         core architecture is to support the connectivity to the MySQL
         server being monitored, and the communication ability with the
         &merlin_server; to collect and send collected information, and
-        receive configuration and other information from &merlin_server;
+        receive configuration and other information from
+        &merlin_server;.
       </para>
 
       <para>


Modified: trunk/mysql-monitor-2.2/licenses-third-party-core.xml
===================================================================
--- trunk/mysql-monitor-2.2/licenses-third-party-core.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/licenses-third-party-core.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 0; 582 bytes

@@ -7,6 +7,10 @@
 
   <title>Licenses for Third-Party Components</title>
 
+  <indexterm>
+    <primary>third-party contributions</primary>
+  </indexterm>
+
   <remark role="dynamic-dependency-list"/>
 
   <para condition="dynamic:licenses:licenselist" role=":monitor-2.2:"/>


Modified: trunk/mysql-monitor-2.2/news-core.xml
===================================================================
--- trunk/mysql-monitor-2.2/news-core.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/news-core.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 0; 450 bytes

@@ -16,6 +16,10 @@
 
   <title>&merlin; Change History</title>
 
+  <indexterm>
+    <primary>change history</primary>
+  </indexterm>
+
   <remark role="dynamic-dependency-list"/>
 
   <para>


Modified: trunk/mysql-monitor-2.2/query-analyzer-cj-core.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-cj-core.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-cj-core.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 16, Lines Added: 80, Lines Deleted: 10; 5905 bytes

@@ -9,6 +9,23 @@
 
   <title>Using the &merlin_plugin_java;</title>
 
+  <indexterm>
+    <primary>query analyzer</primary>
+    <secondary>Java connector</secondary>
+  </indexterm>
+
+  <indexterm>
+    <primary>Java connector plugin</primary>
+  </indexterm>
+
+  <indexterm>
+    <primary>Connector/J</primary>
+  </indexterm>
+
+  <indexterm>
+    <primary>mysqlenterprise.* options</primary>
+  </indexterm>
+
   <remark role="dynamic-dependency-list"/>
 
   <para>

@@ -118,6 +135,10 @@
   <itemizedlist>
 
     <listitem>
+      <indexterm>
+        <primary>statementInterceptors option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-statementinterceptors">
         <literal>statementInterceptors=com.mysql.etools.jdbc.StatementPerformanceCounters</literal>
       </para>

@@ -130,6 +151,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>serviceManagerUrl option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-servicemanagerurl">
         <literal>mysqlenterprise.serviceManagerUrl</literal>
       </para>

@@ -146,6 +171,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>serviceManagerUser option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-servicemanageruser">
         <literal>mysqlenterprise.serviceManagerUser</literal>
       </para>

@@ -159,6 +188,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>serviceManagerPassword option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-servicemanagerpassword">
         <literal>mysqlenterprise.serviceManagerPassword</literal>
       </para>

@@ -178,6 +211,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>httpSocketTimeoutMillis option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-httpsockettimeoutmillis">
         <literal>mysqlenterprise.httpSocketTimeoutMillis</literal>
       </para>

@@ -216,6 +253,10 @@
   <itemizedlist>
 
     <listitem>
+      <indexterm>
+        <primary>verifySslHostnames option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-verifysslhostnames">
         <literal>mysqlenterprise.verifySslHostnames</literal>
       </para>

@@ -232,6 +273,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>verifySslCerts option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-verifysslcerts">
         <literal>mysqlenterprise.verifySslCerts</literal>
       </para>

@@ -246,6 +291,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>trustCertificateKeystoreUrl option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-trustcertificatekeystoreurl">
         <literal>mysqlenterprise.trustCertificateKeystoreUrl</literal>
       </para>

@@ -259,6 +308,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>trustCertificateKeystorePassword option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-trustcertificatekeystorepassword">
         <literal>mysqlenterprise.trustCertificateKeystorePassword</literal>
       </para>

@@ -271,6 +324,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>trustCertificateKeystoreType option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-trustcertificatekeystoretype">
         <literal>mysqlenterprise.trustCertificateKeystoreType</literal>
       </para>

@@ -288,6 +345,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>clientCertificateKeystoreUrl option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-clientcertificatekeystoreurl">
         <literal>mysqlenterprise.clientCertificateKeystoreUrl</literal>
       </para>

@@ -301,6 +362,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>clientCertificateKeystorePassword option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-clientcertificatekeystorepassword">
         <literal>mysqlenterprise.clientCertificateKeystorePassword=[password]</literal>
       </para>

@@ -313,6 +378,10 @@
     </listitem>
 
     <listitem>
+      <indexterm>
+        <primary>clientCertificateKeystoreType option</primary>
+      </indexterm>
+
       <para id="option_mem-plugin-cj-clientcertificatekeystoretype">
         <literal>mysqlenterprise.clientCertificateKeystoreType</literal>
       </para>

@@ -434,13 +503,12 @@
     changes are not immediate.
   </para>
 
-  <para>
-    <emphasis role="bold">Usage Notes</emphasis>
-  </para>
+  <bridgehead>
+    Usage Notes
+  </bridgehead>
 
   <para>
-    You should be aware of the following while using the
-    &merlin_plugin_java;:
+    Be aware of the following while using the &merlin_plugin_java;:
   </para>
 
   <itemizedlist>

@@ -448,14 +516,16 @@
     <listitem>
       <para>
         When a Java application that is reporting queries terminates,
-        you may lose the information about some queries because the
+        you might lose the information about some queries because the
         queued query information has not been sent to &merlin_server;.
-        You can get round this issue by adding a sleep to your
-        application to ensure the normal reporting schedule submits the
-        outstanding queries. For example, you could add:
+        To work around this issue, add a sleep to your application to
+        ensure the normal reporting schedule submits the outstanding
+        queries. For example, you could add:
       </para>
 
-<programlisting>Thread.sleep(60000);</programlisting>
+<programlisting>
+Thread.sleep(60000);
+</programlisting>
 
       <para>
         To your application before the application terminates.


Modified: trunk/mysql-monitor-2.2/query-analyzer-cnet-core.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-cnet-core.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-cnet-core.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 3, Lines Added: 17, Lines Deleted: 4; 1634 bytes

@@ -9,6 +9,19 @@
 
   <title>Using the &merlin_plugin_net;</title>
 
+  <indexterm>
+    <primary>query analyzer</primary>
+    <secondary>.NET connector</secondary>
+  </indexterm>
+
+  <indexterm>
+    <primary>.NET connector plugin</primary>
+  </indexterm>
+
+  <indexterm>
+    <primary>Connector/NET</primary>
+  </indexterm>
+
   <remark role="dynamic-dependency-list"/>
 
   <para>

@@ -154,9 +167,9 @@
       <para>
         The interval in seconds between posts of the collected query
         analyzer information from you application to the
-        &merlin_server;. You should choose the value for this carefully.
-        Too long and it may take some time for queries to appear in the
-        query analyzer.
+        &merlin_server;. Choose the value for this carefully. Too long
+        and it may take some time for queries to appear in the query
+        analyzer.
       </para>
     </listitem>
 

@@ -201,7 +214,7 @@
 
   <para>
     During execution of the application during development within Visual
-    Studio, you should see a significant amount of output in the
+    Studio, a significant amount of output is displayed in the
     <guilabel>Output</guilabel> window. If you are running the
     application standalone and want to monitor the trace output, you
     should configure and additional listener in your configuration file.


Modified: trunk/mysql-monitor-2.2/query-analyzer-using-consuming.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-using-consuming.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-using-consuming.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 2, Lines Added: 8, Lines Deleted: 3; 1205 bytes

@@ -9,6 +9,11 @@
 
   <title>Consuming Query Analyzer Data</title>
 
+  <indexterm>
+    <primary>query analyzer</primary>
+    <secondary>using the data</secondary>
+  </indexterm>
+
   <para>
     Understanding QA data...
   </para>

@@ -43,9 +48,9 @@
           executed very rarely, may indicate that your MySQL client
           application is either running a simple query to frequently, or
           may be running a query multiple times that could otherwise be
-          cached. You should pay particular attention to queries where
-          the execution count increases significantly in a short period
-          of time compared to the normal execution rate.
+          cached. Pay particular attention to queries where the
+          execution count increases significantly in a short period of
+          time compared to the normal execution rate.
         </para>
 
         <para>


Modified: trunk/mysql-monitor-2.2/query-analyzer-using-feeding-core.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-using-feeding-core.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-using-feeding-core.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 5, Lines Deleted: 0; 673 bytes

@@ -9,6 +9,11 @@
 
   <title>Providing Query Analyzer Data</title>
 
+  <indexterm>
+    <primary>query analyzer</primary>
+    <secondary>supplying query data</secondary>
+  </indexterm>
+
   <para>
     The Query Analyzer can be fed information from a number of different
     sources, in each case with the provider supplying the statistical


Modified: trunk/mysql-monitor-2.2/query-analyzer-using-proxy.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-using-proxy.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-using-proxy.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 13, Lines Added: 37, Lines Deleted: 28; 6986 bytes

@@ -9,6 +9,15 @@
 
   <title>Using the Agent Proxy</title>
 
+  <indexterm>
+    <primary>proxy</primary>
+  </indexterm>
+
+  <indexterm>
+    <primary>agent</primary>
+    <secondary>proxy</secondary>
+  </indexterm>
+
   <para>
     There are three different ways of feeding query analyzer using the
     &merlin_proxy;:

@@ -21,7 +30,7 @@
         Change your MySQL client application to talk to the Proxy port
         you configured during installation. This requires changing your
         MySQL client application code, and may require that you stop and
-        restart your MySQL client application , but does not require any
+        restart your MySQL client application, but does not require any
         changes to your MySQL server. For more information, see
         <xref linkend="mem-query-analyzer-enabling-app"/>.
       </para>

@@ -32,7 +41,7 @@
         Change your MySQL server to listen on a different port, and
         configure the Agent/proxy to listen on the original MySQL server
         port. This does not require any changes to your MySQL client
-        application , but will require shutting down and restarting your
+        application, but requires shutting down and restarting your
         MySQL server, which may affect your cache and performance. For
         more information, see
         <xref linkend="mem-query-analyzer-enabling-mysql"/>.

@@ -62,8 +71,8 @@
 
     <listitem>
       <para>
-        Add the <literal>proxy</literal> plugin to the
-        <literal>plugins</literal> parameter:
+        Add the <literal>proxy</literal> keyword to the
+        <literal>plugins</literal> parameter. For example:
       </para>
 
 <programlisting>plugins=proxy,agent</programlisting>

@@ -116,7 +125,7 @@
         connect to the server from the host on which the agent/proxy is
         running. When the user connects to the agent/proxy, and the
         agent/proxy connects to the server the host of the agent/proxy
-        will be used as the identifying client host name during the
+        is used as the identifying client host name during the
         connection.
       </para>
 

@@ -218,10 +227,10 @@
         </para>
 
         <para>
-          Queries will be sent to the host specified in the
+          Queries are sent to the host specified in the
           <literal>proxy-backend-addresses</literal> parameter, and the
-          agent will listen for connections to be redirected to the
-          server on the host name and port configured in the
+          agent listens for connections to be redirected to the server
+          on the host name and port configured in the
           <literal>proxy-address</literal> parameter.
         </para>
       </listitem>

@@ -241,13 +250,13 @@
         </para>
 
         <para>
-          Because connections to the MySQL server will be coming from
-          the agent/proxy, not the original host, the user credentials
-          used must be have a suitable <literal>GRANT</literal>
-          statement for connections from <literal>localhost</literal>,
-          or the host on which the agent/proxy is executing. The user
-          name and password information will be passed on directly
-          through the agent/proxy from the client to the server.
+          Because connections to the MySQL server come from the
+          agent/proxy, not the original host, the user credentials must
+          be have a suitable <literal>GRANT</literal> statement for
+          connections from <literal>localhost</literal>, or the host on
+          which the agent/proxy runs. The user name and password
+          information are passed directly through the agent/proxy from
+          the client to the server.
         </para>
       </listitem>
 

@@ -268,7 +277,7 @@
         to the agent/proxy and your backend servers, make sure that you
         are communicating with the proxy over the right port. By
         default, if you specify <literal>localhost</literal> as the host
-        name, then <command>mysql</command> will connect using the local
+        name, then <command>mysql</command> connects using the local
         Unix domain socket, rather than the TCP/IP socket.
       </para>
 

@@ -276,8 +285,8 @@
         You can enforce <command>mysql</command> to use the right port
         either by explicitly requesting the protocol type, or by using
         the IP address rather than <literal>localhost</literal>. For
-        example, both of these command lines will start the client using
-        the right protocol:
+        example, both of these command lines start the client using the
+        right protocol:
       </para>
 
 <programlisting>shell&gt; mysql --port=6446 --protocol=tcp

@@ -299,11 +308,11 @@
     <title>Enabling Query Analyzer by Changing MySQL Server</title>
 
     <para>
-      When enabling Query Analyzer by changing the MySQL Server, you
-      need to shutdown your server, edit the MySQL configuration file,
-      and then restart MySQL. You will also need to change your
-      Agent/proxy configuration so that the Agent/proxy is listening on
-      the original MySQL TCP/IP port. To use this method:
+      When enabling Query Analyzer by changing the MySQL Server, shut
+      down your server, edit the MySQL configuration file, and then
+      restart MySQL. Also, change your Agent/proxy configuration so that
+      the Agent/proxy listens on the original MySQL TCP/IP port. To use
+      this method, follow these steps:
     </para>
 
     <orderedlist>

@@ -312,7 +321,7 @@
         <para>
           Edit the <filename>/etc/my.cnf</filename> or other MySQL
           configuration file and change or add the
-          <literal>port</literal> setting from it's current value
+          <literal>port</literal> setting from its current value
           (default 3306), to another value. For example:
         </para>
 

@@ -322,20 +331,20 @@
 
       <listitem>
         <para>
-          Shutdown your MySQL Server.
+          Shut down your MySQL Server.
         </para>
       </listitem>
 
       <listitem>
         <para>
-          Startup your MySQL Server and confirm that is running.
+          Start your MySQL Server and confirm that is running.
         </para>
       </listitem>
 
       <listitem>
         <para>
           Edit your &merlin_agent; configuration so that the agent/proxy
-          is listening for connections on the original MySQL port:
+          listens for connections on the original MySQL port:
         </para>
 
 <programlisting>proxy-address=:3306

@@ -351,7 +360,7 @@
     </orderedlist>
 
     <para>
-      You should now be able to connect to your MySQL server through the
+      You can now connect to your MySQL server through the
       &merlin_agent; by connecting on the original port:
     </para>
 


Modified: trunk/mysql-monitor-2.2/query-analyzer-using-troubleshooting.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-using-troubleshooting.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-using-troubleshooting.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 2, Lines Added: 12, Lines Deleted: 3; 1271 bytes

@@ -9,6 +9,16 @@
 
   <title>Troubleshooting Query Analyzer</title>
 
+  <indexterm>
+    <primary>query analyzer</primary>
+    <secondary>troubleshooting</secondary>
+  </indexterm>
+
+  <indexterm>
+    <primary>troubleshooting</primary>
+    <secondary>query analyzer</secondary>
+  </indexterm>
+
   <para>
     If you are having trouble with Query Analyzer, either because the
     information is not being shown or the full range of queries that you

@@ -26,14 +36,13 @@
     <listitem>
       <para>
         Confirm that the agent is running by checking the Agent log and
-        the status of the server within &merlin_server;
+        the status of the server within &merlin_server;.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        Check the configuration of the agent. You must confirm the
-        following:
+        Check the configuration of the agent. Confirm the following:
       </para>
 
       <itemizedlist>


Modified: trunk/mysql-monitor-2.2/query-analyzer-using-ui.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-using-ui.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-using-ui.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 5, Lines Added: 18, Lines Deleted: 14; 3061 bytes

@@ -9,6 +9,10 @@
 
   <title>Query Analyzer User Interface</title>
 
+  <indexterm>
+    <primary>Query Analyzer tab</primary>
+  </indexterm>
+
   <para>
     To analyse the queries captured by the agent/proxy, change to the
     <guilabel>Query Analyzer</guilabel> tab. You can see an example of

@@ -340,10 +344,9 @@
           <guilabel>Execution Time Statistics</guilabel> section
           provides you with more detailed execution time statistics,
           including the minimum time, maximum time, average time, total
-          time and the standard deviation. The standard deviation will
-          enable you to determine whether a particular invocation of a
-          query is outside the normal distribution of times for the
-          given query.
+          time and the standard deviation. The standard deviation lets
+          you determine whether a particular invocation of a query is
+          outside the normal distribution of times for the given query.
         </para>
 
         <para>

@@ -434,8 +437,8 @@
         </figure>
 
         <para>
-          The <guilabel>Explain Query</guilabel> tab lets you view
-          the output from running the query with the
+          The <guilabel>Explain Query</guilabel> tab lets you view the
+          output from running the query with the
           <literal>EXPLAIN</literal> prefix. For more information, see
           <xref linkend="explain"/>.
         </para>

@@ -645,9 +648,9 @@
 
         <para>
           If you have enabled <guilabel>Example Query</guilabel>, then
-          you can additional enable <guilabel>Example
-          Explain</guilabel>, To enable this tab, select the
-          <guilabel>Enable Example Explain</guilabel> checkbox.
+          you can also enable <guilabel>Example Explain</guilabel>. To
+          enable this tab, select the <guilabel>Enable Example
+          Explain</guilabel> checkbox.
         </para>
       </listitem>
 

@@ -831,11 +834,12 @@
         </para>
 
         <para>
-          Using the <guilabel>From/To</guilabel> time range lets you show queries between specific dates and times. Using this
-          mode you can show only the queries received during a specific
-          time span, and you can display the query history for a much
-          longer time period, for as long as you have been recording
-          query analysis information.
+          Using the <guilabel>From/To</guilabel> time range lets you
+          show queries between specific dates and times. Using this mode
+          you can show only the queries received during a specific time
+          span, and you can display the query history for a much longer
+          time period, for as long as you have been recording query
+          analysis information.
         </para>
       </listitem>
 


Modified: trunk/mysql-monitor-2.2/query-analyzer-using.xml
===================================================================
--- trunk/mysql-monitor-2.2/query-analyzer-using.xml	2011-01-19 23:07:28 UTC (rev 24852)
+++ trunk/mysql-monitor-2.2/query-analyzer-using.xml	2011-01-19 23:09:59 UTC (rev 24853)
Changed blocks: 1, Lines Added: 4, Lines Deleted: 0; 575 bytes

@@ -9,6 +9,10 @@
 
   <title>Using the Query Analyzer</title>
 
+  <indexterm>
+    <primary>query analyzer</primary>
+  </indexterm>
+
   <para>
     Query Analyzer lets you monitor SQL statements executed on a MySQL
     server and see details about each query, as well as number of


Thread
svn commit - mysqldoc@docsrva: r24853 - trunk/mysql-monitor-2.2john.russell20 Jan