List:Commits« Previous MessageNext Message »
From:tony.bedford Date:January 12 2011 12:26pm
Subject:svn commit - mysqldoc@docsrva: r24779 - trunk/mysql-monitor-2.3
View as plain text  
Author: tbedford
Date: 2011-01-12 13:26:54 +0100 (Wed, 12 Jan 2011)
New Revision: 24779

Log:
Synchronized with updated README.

Modified:
   trunk/mysql-monitor-2.3/query-analyzer-cc.xml


Modified: trunk/mysql-monitor-2.3/query-analyzer-cc.xml
===================================================================
--- trunk/mysql-monitor-2.3/query-analyzer-cc.xml	2011-01-12 01:12:11 UTC (rev 24778)
+++ trunk/mysql-monitor-2.3/query-analyzer-cc.xml	2011-01-12 12:26:54 UTC (rev 24779)
Changed blocks: 17, Lines Added: 116, Lines Deleted: 78; 11093 bytes

@@ -51,12 +51,6 @@
         </para>
       </listitem>
 
-      <listitem>
-        <para>
-          <command>CMake</command> 2.6.1 or newer
-        </para>
-      </listitem>
-
     </itemizedlist>
   </para>
 

@@ -65,65 +59,39 @@
   </para>
 
   <para>
-    &merlin_plugin_c; can be installed using the following procedure:
+    &merlin_plugin_c; is installed as follows:
   </para>
 
-  <itemizedlist>
+  <orderedlist>
 
     <listitem>
       <para>
-        Copy the &merlin_plugin_c; source into the
-        <filename>plugins</filename> directory of your Connector/C
-        source code installation.
+        Download the binary.
       </para>
     </listitem>
 
     <listitem>
       <para>
-        Before executing <literal>cmake</literal> commands make sure
-        that you delete the <filename>CMakeCache.txt</filename> file.
+        Locate the binary in a suitable directory (anywhere convenient
+        can be used).
       </para>
     </listitem>
 
     <listitem>
       <para>
-        Create the Connector/C <literal>make</literal> files. This can
-        be done on Unix with the following command:
+        Set the <literal>LIBMYSQL_PLUGINS</literal> and
+        <literal>LIBMYSQL_PLUGINDIR</literal> environment variables
+        according to the plugin name and directory selected.
       </para>
-
-<programlisting>
-shell&gt; cmake -G "Unix Makefiles"
-</programlisting>
-
-      <para>
-        On Windows systems the command is:
-      </para>
-
-<programlisting>
-shell&gt; cmake -G "NMake Makefiles"
-</programlisting>
     </listitem>
 
     <listitem>
       <para>
-        Build Connector/C and &merlin_plugin_c; with the following
-        command for Unix:
+        The plugin is now ready to use.
       </para>
-
-<programlisting>
-shell&gt; make
-</programlisting>
-
-      <para>
-        On Windows systems the command is:
-      </para>
-
-<programlisting>
-shell&gt; nmake
-</programlisting>
     </listitem>
 
-  </itemizedlist>
+  </orderedlist>
 
   <para>
     <emphasis role="bold">Loading the &merlin_plugin_c;</emphasis>

@@ -186,7 +154,7 @@
 
     <listitem>
       <para>
-        <literal role="cfunc">mysql_load_client plugin(MYSQL *mysql,
+        <literal role="cfunc">mysql_load_client_plugin(MYSQL *mysql,
         const char *plugin, int argc, ...)</literal>
       </para>
 

@@ -199,7 +167,7 @@
         <listitem>
           <para>
             <literal>MYSQL *mysql</literal> - The plugin api does not
-            need a valid connection to a MySql server, the
+            need a valid connection to a MySQL server, the
             <literal>mysql</literal> pointer will be used for error
             reporting only.
           </para>

@@ -265,8 +233,8 @@
   <para>
     The &merlin_plugin_c; does not send version information to the
     aggregator. To check the &merlin_plugin_c; version information you
-    can use the <literal>libmysql_plugin_info</literal> program or you
-    can obtain the version information by accessing the plugin
+    can use the <literal>mysql_client_plugin_info</literal> program or
+    you can obtain the version information by accessing the plugin
     description structure.
   </para>
 

@@ -274,8 +242,8 @@
 
     <listitem>
       <para>
-        Using the <literal>libmysql_plugin_info</literal> tool to obtain
-        version information.
+        Using the <literal>mysql_client_plugin_info</literal> tool to
+        obtain version information.
       </para>
 
       <para>

@@ -283,7 +251,7 @@
       </para>
 
 <programlisting>
-shell&gt; ./libmysql_plugin_info [plugin_type]
+shell&gt; ./mysql_client_plugin_info [plugin_type]
 </programlisting>
 
       <para>

@@ -291,12 +259,13 @@
       </para>
 
 <programlisting>
-shell&gt; ./libmysql_plugin_info cta_plugin/libmysql_trace_plugin.so
+shell&gt; ./mysql_client_plugin_info cta_plugin/c-c-mysql-enterprise-plugin.so
 Plugin type:        Trace API
 Plugin name:        c-c-mysql-enterprise-plugin
-Version:            1.0.4
+Version:            1.0.6
 Plugin description: Connector/C Plugin for MySQL Enterprise
 Plugin author:      Oracle Corporation
+Plugin license:     Proprietary
 </programlisting>
     </listitem>
 

@@ -437,8 +406,9 @@
 
         <listitem>
           <para>
-            <literal>timeout</literal> - specifies the maximum time in
-            seconds allowed for the aggregator transfer operation.
+            <literal>response_timeout</literal> - specifies the maximum
+            time in seconds allowed for the aggregator transfer
+            operation.
           </para>
         </listitem>
 

@@ -451,9 +421,9 @@
 
         <listitem>
           <para>
-            <literal>memory_limit</literal> - specifies the maximum size
-            of memory for the internal aggregator queue. The default
-            value of zero disables the memory limit.
+            <literal>backlog</literal> - specifies the maximum size of
+            memory for the internal aggregator queue. The default value
+            of zero disables the memory limit.
           </para>
         </listitem>
 

@@ -484,7 +454,7 @@
 <programlisting language="c">
 <![CDATA[
 mysql= mysql_init(NULL);
-if ((p =mysql_load_client_plugin(&mysql, "c-c-mysql-enterprise-plugin"))) {
+if ((p =mysql_load_client_plugin(&mysql, "c-c-mysql-enterprise-plugin", 0))) {
   int value, rc;
   rc= mysql_plugin_options(p, "url", "http://192.168.1.1:14000/cta/aggregate")
   value= 3;

@@ -529,7 +499,7 @@
 password=secret
 logfile=/logs/enterprise_plugin/test.log
 loglevel=4
-timeout=3000
+response_timeout=3000
 disable_backtrace=1
 </programlisting>
     </listitem>

@@ -549,35 +519,35 @@
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_URL</literal> - Aggregator
-            URL.
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_URL</literal> -
+            Aggregator URL.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_USER</literal> - user for
-            aggregator authentication
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_USER</literal> - user
+            for aggregator authentication
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>MYSQL-ENTERPRISE_AGGR_PASSWD</literal> - password
-            for aggregator authentication
+            <literal>MYSQL-ENTERPRISE_AGGREGATOR_PASSWORD</literal> -
+            password for aggregator authentication
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_LOGFILE</literal> - name of
-            the local logfile.
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_LOGFILE</literal> -
+            name of the local logfile.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRSE_AGGR_LOGLEVEL</literal> - Log
+            <literal>MYSQL_ENTERPRSE_AGGREGATOR_LOGLEVEL</literal> - Log
             level, which can take the following values:
 
             <itemizedlist>

@@ -612,9 +582,9 @@
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_CONNECT_TIMEOUT</literal> -
-            specifies the maximum time in seconds allowed for making the
-            connection to the aggregator. This only applies to the
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_CONNECT_TIMEOUT</literal>
+            - specifies the maximum time in seconds allowed for making
+            the connection to the aggregator. This only applies to the
             connection phase, once the connection has been made, this
             option no longer applies.
           </para>

@@ -622,23 +592,23 @@
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_TIMEOUT</literal> - specifies
-            the maximum time in seconds allowed for the aggregator
-            transfer operation.
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_RESPONSE_TIMEOUT</literal>
+            - specifies the maximum time in seconds allowed for the
+            aggregator transfer operation.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_DNS_CACHE_TIMEOUT</literal> -
-            specifies the timeout in seconds. Name resolutions will be
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_DNS_CACHE_TIMEOUT</literal>
+            - specifies the timeout in seconds. Name resolutions will be
             kept in memory for this period of time.
           </para>
         </listitem>
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_MEMORY_LIMIT</literal> -
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_BACKLOG</literal> -
             specifies the maximum size of memory for the internal
             aggregator queue. The default value of zero disables the
             memory limit.

@@ -647,8 +617,8 @@
 
         <listitem>
           <para>
-            <literal>MYSQL_ENTERPRISE_AGGR_DISABLE_BACKTRACE</literal> -
-            setting to 1 disables backtrace information.
+            <literal>MYSQL_ENTERPRISE_AGGREGATOR_DISABLE_BACKTRACE</literal>
+            - setting to 1 disables backtrace information.
           </para>
         </listitem>
 

@@ -657,4 +627,72 @@
 
   </orderedlist>
 
+  <para>
+    <emphasis role="bold">Order of evaluation of configuration
+    parameters during startup </emphasis>
+  </para>
+
+  <para>
+    During startup, configuration parameters can be set by a
+    configuration file, or environment variables. These settings are
+    evaluated in the following order:
+  </para>
+
+  <orderedlist>
+
+    <listitem>
+      <para>
+        Configuration file
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        Environment variables
+      </para>
+    </listitem>
+
+  </orderedlist>
+
+  <para>
+    This means that configuration file parameters are loaded first, and
+    can be subsequently overridden by environment variables.
+  </para>
+
+  <para>
+    Configuration parameters can then be overridden again via the C API
+    as described previously.
+  </para>
+
+  <para>
+    <emphasis role="bold">Configuration parameter defaults</emphasis>
+  </para>
+
+  <para>
+    If not otherwise stated, configuration defaults are set to NULL or 0
+    or '' by default.
+  </para>
+
+  <itemizedlist>
+
+    <listitem>
+      <para>
+        <literal>MYSQL_ENTERPRISE_AGGREGATOR_LOGLEVEL</literal> - if a
+        logfile is set but the loglevel is not given, the default of
+        NULL will casue the plugin to record all log entries. Using the
+        default value, not setting the loglevel has the same effect as
+        setting the loglevel to the most verbose setting.
+      </para>
+    </listitem>
+
+    <listitem>
+      <para>
+        <literal>MYSQL_ENTERPRISE_AGGREGATOR_CONNECT_TIMEOUT</literal> -
+        the default is 10 seconds. If a value of 0 is specified, this
+        will be converted into the default value of 10 seconds.
+      </para>
+    </listitem>
+
+  </itemizedlist>
+
 </section>


Thread
svn commit - mysqldoc@docsrva: r24779 - trunk/mysql-monitor-2.3tony.bedford12 Jan