blob: cb8b64746962aa310a9bee2dffb092d38e5f80ea [file] [log] [blame]
<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Appendix&#160;D.&#160;Statistics Reporting</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Appendix-Operation-Logging.html">Prev</a>&#160;</td><th align="center" width="60%">&#160;</th><td align="right" width="20%">&#160;<a accesskey="n" href="apds02.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Appendix-Statistics-Reporting"></a>Appendix&#160;D.&#160;Statistics Reporting</h1></div></div></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="Java-Broker-Appendix-Statistics-Reporting.html#d0e9629">D.1. Statistics Report Period</a></span></dt><dt><span class="section"><a href="apds02.html">D.2. Statistic Report Patterns</a></span></dt><dt><span class="section"><a href="apds03.html">D.3. Examples</a></span></dt></dl></div><p>The Broker has the ability to periodically write statistics of any entity within the system to
the log. Statistics reporting can be configured for a single entity (e.g. a queue) or for all entities of a
particular category (e.g. for all queues). The system can be configured dynamically at runtime without the need
for the system to be restarted.</p><p>This feature helps allow the behaviour of the overall system to be understood and can aid real-time problem
diagnosis.</p><p>It can be configured Broker-wide or separately for each virtual host.</p><p>The format of the statistics report is configurable.</p><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="d0e9629"></a>D.1.&#160;Statistics Report Period</h2></div></div></div><p>This governs the period with which statistics reports will be written to the log. The period is defined
in seconds. By default the statistics report period is zero, meaning the system is disabled. To enable the
statistics report set the <span class="emphasis"><em>statistics reporting period</em></span> on either the Broker or virtualhost to
a non-zero value.</p><p>Once the period is defined, the system will respond to the statistic report patterns defined described next.</p></div></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Appendix-Operation-Logging.html">Prev</a>&#160;</td><td align="center" width="20%">&#160;</td><td align="right" width="40%">&#160;<a accesskey="n" href="apds02.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Appendix&#160;C.&#160;Operational Logging&#160;</td><td align="center" width="20%"><a accesskey="h" href="Apache-Qpid-Broker-J-Book.html">Home</a></td><td align="right" valign="top" width="40%">&#160;D.2.&#160;Statistic Report Patterns</td></tr></table></div></div>