Merge pull request #380 from adamretter/disable-lock-table

Add some detail about disabling the Lock Table

Author: duncdrum

src/main/xar-resources/data/configuration/configuration.xml

@@ -5,7 +5,7 @@
     xmlns:xlink="http://www.w3.org/1999/xlink">
     <info>
         <title>Application Server Configuration</title>
-        <date>2Q19</date>
+        <date>3Q19</date>
         <keywordset>
             <keyword>operations</keyword>
         </keywordset>
@@ -34,6 +34,12 @@
                     <para>Configures the storage back-end.</para>
                 </listitem>
             </varlistentry>
+            <varlistentry>
+                <term> <tag>lock-manager</tag> </term>
+                <listitem>
+                    <para>Configures the Lock Manager.</para>
+                </listitem>
+            </varlistentry>
             <varlistentry>
                 <term> <tag>repository</tag> </term>
                 <listitem>
@@ -432,6 +438,27 @@
             </sect3>
         </sect2>
 
+
+        <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+        <sect2 xml:id="lock-manager">
+            <title> <tag>lock-manager</tag> element</title>
+            <para>This element contains settings for eXist-db's Lock Manager and Lock Table. The majority
+                of these Lock Manager settings should not be modified unless otherwise suggested by eXist-db Core Development Team.</para>
+            <variablelist spacing="compact">
+                <varlistentry>
+                    <term> <code>lock-table/@disabled</code> </term>
+                    <listitem>
+                        <para>Disables the database Lock Table which tracks database locks. The Lock Table is enabled by default
+                            and allows reporting on database locking via JMX.</para>
+                        <para>Tracking locks via the Lock Table imposes a small overhead per-Lock. Once users
+                            have finished testing their system to ensure correct operation, they may wish to disable
+                            this in production to ensure the absolute best performance.</para>
+                        <note><para>Unless nessecary, it is recommened to leave this enabled.</para></note>
+                    </listitem>
+                </varlistentry>
+            </variablelist>
+        </sect2>
+
         <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
 
         <sect2 xml:id="indexer">

src/main/xar-resources/data/production_good_practice/production_good_practice.xml

@@ -5,7 +5,7 @@
     xmlns:xlink="http://www.w3.org/1999/xlink">
     <info>
         <title>Production Use - Good Practice</title>
-        <date>2Q19</date>
+        <date>3Q19</date>
         <keywordset>
             <keyword>operations</keyword>
         </keywordset>
@@ -380,6 +380,9 @@
             <para>Keeping the eXist-db application, data and journal on separate disks, connected to
                 different I/O channels, can have a positive impact on performance. The location of
                 the data files and journals can be changed in <literal>etc/conf.xml</literal>.</para>
+			<para>In addition to gain the absolute best performance, for eXist-db 5.0.0 or newer, it
+                may be beneficial to disable Lock Event Tracking in the Lock Table. The Lock Table
+                can be disabled in the <literal>etc/conf.xml</literal> configuration file.</para>
         </sect2>
     </sect1>