QPID-6145: [Java Broker Documentation] Add new operational log messages.

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk@1631193 13f79535-47bb-0310-9956-ffa450edef68

2 files changed, 26 insertions, 3 deletions

diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml b/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
index 90a0b1a35f..7b7928fda0 100644
--- a/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
+++ b/qpid/doc/book/src/java-broker/Java-Broker-Appendix-Operational-Logging-Messages.xml
@@ -344,6 +344,25 @@
             <para>Statistic - messages delivered or received by the Broker.</para>
           </entry>
         </row>
+        <row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1014">
+          <entry morerows="1">BRK-1014</entry>
+          <entry>Message flow to disk active :  Message memory use <replaceable>size of all messages</replaceable> exceeds threshold <replaceable>threshold size</replaceable></entry>
+        </row>
+        <row>
+          <entry>
+            <para>Indicates that the heap memory space occupied by messages has exceeded the threshold so the flow to disk feature has been activated.</para>
+          </entry>
+        </row>
+        
+        <row id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1015">
+          <entry morerows="1">BRK-1015</entry>
+          <entry>Message flow to disk inactive :  Message memory use <replaceable>size of all messages</replaceable> within threshold <replaceable>threshold size</replaceable></entry>
+        </row>
+        <row>
+          <entry>
+            <para>Indicates that the heap memory space occupied by messages has fallen below the threshold so the flow to disk feature has been deactivated.</para>
+          </entry>
+        </row>
       </tbody>
     </tgroup>
   </table>
diff --git a/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Flow-To-Disk.xml b/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Flow-To-Disk.xml
index f2dbb162e1..d22a720a1d 100644
--- a/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Flow-To-Disk.xml
+++ b/qpid/doc/book/src/java-broker/Java-Broker-Runtime-Flow-To-Disk.xml
@@ -28,15 +28,19 @@
     cumulative size of all messages falls below the limit once again.</para>
   <para>By default the Broker makes 40% of the max available memory for messages. This memory is
     divided between all the queues across all virtual hosts defined on the Broker with a percentage
-    calculated according to their current queue size.</para>
+    calculated according to their current queue size. These calulations are refreshed periodically
+    by the housekeeping cycle.</para>
   <para>For example if there are two queues, one containing 75MB and the second 100MB messages
     respectively and the Broker has 1GB heap memory with the default of 40% available for messages.
     The first queue will have a target size of 170MB and the second 230MB. Once 400MB is taken by
     messages, messages will begin to flow to disk. New messages will cease to flow to disk when
     their cumulative size falls beneath 400MB.</para>
-  <para>Target queue sizes are refreshed periodically according to the housekeeping cycle.</para>
   <para>Flow to disk is configured by Broker context variable
       <literal>broker.flowToDiskThreshold</literal>. It is expressed as a size in bytes and defaults
     to 40% of the JVM maximum heap size.</para>
-  <para>TODO: implement log message when flow to disk activates/deactives</para>
+  <para>Log message <link linkend="Java-Broker-Appendix-Operation-Logging-Message-BRK-1014"
+      >BRK-1014</link> is written when the feature activates. Once the total space of all messages
+    decreases below the threshold, the message <link
+      linkend="Java-Broker-Appendix-Operation-Logging-Message-BRK-1015">BRK-1015</link> is written
+    to show that the feature is no longer active.</para>
 </section>