http://git-wip-us.apache.org/repos/asf/qpid-site/blob/32dce6b5/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Operation-Logging.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Operation-Logging.html.in b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Operation-Logging.html.in new file mode 100644 index 0000000..24e1ea6 --- /dev/null +++ b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Operation-Logging.html.in @@ -0,0 +1,422 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Appendix C. Operational Logging</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Appendix-System-Properties.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Appendix-Queue-Alerts.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Appendix-Operation-Logging"></a>Appendix C. Operational Logging</h1></div></div></div><p>The Broker will, by default, produce structured log messages in response to key events in + the lives of objects within the Broker. These concise messages are designed to allow the user to + understand the actions of the Broker in retrospect. This is valuable for problem diagnosis and + provides a useful audit trail.</p><p>Each log message includes details of the entity causing the action (e.g. a management user + or messaging client connection), the entity receiving the action (e.g. a queue or connection) + and a description of operation itself.</p><p>The log messages have the following format:</p><pre class="screen"> + [<code class="literal">Actor</code>] {[<code class="literal">Subject</code>]} [<code class="literal">Message Id</code>] [<code class="literal">Message Text</code>] + </pre><p>Where:</p><div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="literal">Actor</code> is the entity within the Broker that is + <span class="emphasis"><em>performing</em></span> the action. There are actors corresponding to the Broker + itself, Management, Connection, and Channels. Their format is described in the <a class="link" href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Actor-Format" title="Table C.1. Actors Entities">table</a> below.</p></li><li class="listitem"><p><code class="literal">Subject</code> (optional) is the entity within the Broker that is + <span class="emphasis"><em>receiving</em></span> the action. There are subjects corresponding to the + Connections, Channels, Queues, Exchanges, Subscriptions, and Message Stores. Their format is + described in the <a class="link" href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Subject-Format" title="Table C.2. Subject Entities">table</a> below.</p><p>Some actions are reflexive, in these cases the Actor and Subject will be equal.</p></li><li class="listitem"><p><code class="literal">Message Id</code> is an identifier for the type of message. It has the form + three alphas and four digits separated by a hyphen <code class="literal">AAA-9999</code>.</p></li><li class="listitem"><p><code class="literal">Message Text</code> is a textual description</p></li></ul></div><p>To illustrate, let's look at two examples.</p><p><code class="literal"><a class="link" href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-CON-1001">CON-1001</a></code> is used when a messages client makes an AMQP connection. The + connection actor (<code class="literal">con</code>) provides us with details of the peer's connection: the + user id used by the client (myapp1), their IP, ephemeral port number and the name of the virtual + host. The message text itself gives us further details about the connection: the client id, the + protocol version in used, and details of the client's qpid library.</p><pre class="screen">[con:8(myapp1@/127.0.0.1:52851/default)] CON-1001 : Open : Destination : AMQP(127.0.0.1:5672) : + Protocol Version : 0-10 : Client ID : myapp1 : Client Version : 7.0.0-SNAPSHOT : Client Product : qpid</pre><p><code class="literal"><a class="link" href="Java-Broker-Appendix-Operation-Logging.html#Java-Broker-Appendix-Operation-Logging-Message-QUE-1001">QUE-1001</a></code> is used when a queue is created. The connection actor + <code class="literal">con</code> tells us details of the connection performing the queue creation: the + user id used by the client (myapp1), the IP, ephemeral port number and the name of the virtual + host. The queue subject tells use the queue's name (myqueue) and the virtualhost. The message + itself tells us more information about the queue that is being created. </p><pre class="screen">[con:8(myapp1@/127.0.0.1:52851/default)/ch:0] [vh(/default)/qu(myqueue)] QUE-1001 : Create : Owner: myapp1 Transient</pre><p>The first two tables that follow describe the actor and subject entities, then the later + provide a complete catalogue of all supported messages.</p><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Actor-Format"></a><p class="title"><strong>Table C.1. Actors Entities</strong></p><div class="table-contents"><table border="1" summary="Actors Entities" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Actor Type</th><th>Format and Purpose</th></tr></thead><tbody><tr><td rowspan="2">Broker</td><td>[Broker]</td></tr><tr><td> + <p>Used during startup and shutdown</p> + </td></tr><tr><td rowspan="2">Management</td><td> + [mng:<em class="replaceable"><code>userid</code></em>(<em class="replaceable"><code>clientip</code></em>:<em class="replaceable"><code>ephemeralport</code></em>)] </td></tr><tr><td> + <p>Used for operations performed by the Web Management interfaces.</p> + </td></tr><tr><td rowspan="2">Connection</td><td> + [con:<em class="replaceable"><code>connectionnumber</code></em>(<em class="replaceable"><code>userid</code></em>@/<em class="replaceable"><code>clientip</code></em>:<em class="replaceable"><code>ephemeralport</code></em>/<em class="replaceable"><code>virtualhostname</code></em>)]</td></tr><tr><td> + <p>Used for operations performed by a client connection. Note that connections are + numbered by a sequence number that begins at 1.</p> + </td></tr><tr><td rowspan="2">Channel</td><td> + [con:<em class="replaceable"><code>connectionnumber</code></em>(<em class="replaceable"><code>userid</code></em>@/<em class="replaceable"><code>clientip</code></em>:<em class="replaceable"><code>ephemeralport</code></em>/<em class="replaceable"><code>virtualhostname</code></em>/ch:<em class="replaceable"><code>channelnumber</code></em>)]</td></tr><tr><td> + <p>Used for operations performed by a client's channel (corresponds to the JMS + concept of Session). Note that channels are numbered by a sequence number that is + scoped by the owning connection.</p> + </td></tr><tr><td rowspan="2">Group</td><td> [grp(/<em class="replaceable"><code>groupname</code></em>)/vhn(/<em class="replaceable"><code>virtualhostnode + name</code></em>)]</td></tr><tr><td> + <p>Used for HA. Used for operations performed by the system itself often as a result + of actions performed on another node..</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Subject-Format"></a><p class="title"><strong>Table C.2. Subject Entities</strong></p><div class="table-contents"><table border="1" summary="Subject Entities" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Subject Type</th><th>Format and Purpose</th></tr></thead><tbody><tr><td rowspan="2">Connection</td><td> + [con:<em class="replaceable"><code>connectionnumber</code></em>(<em class="replaceable"><code>userid</code></em>@/<em class="replaceable"><code>clientip</code></em>:<em class="replaceable"><code>ephemeralport</code></em>/<em class="replaceable"><code>virtualhostname</code></em>)]</td></tr><tr><td> + <p>A connection to the Broker.</p> + </td></tr><tr><td rowspan="2">Channel</td><td> + [con:<em class="replaceable"><code>connectionnumber</code></em>(<em class="replaceable"><code>userid</code></em>@/<em class="replaceable"><code>clientip</code></em>:<em class="replaceable"><code>ephemeralport</code></em>/<em class="replaceable"><code>virtualhostname</code></em>/ch:<em class="replaceable"><code>channelnumber</code></em>)]</td></tr><tr><td> + <p>A client's channel within a connection.</p> + </td></tr><tr><td rowspan="2">Subscription</td><td> + [sub:<em class="replaceable"><code>subscriptionnumber</code></em>(vh(/<em class="replaceable"><code>virtualhostname</code></em>)/qu(<em class="replaceable"><code>queuename</code></em>)]</td></tr><tr><td> + <p>A subscription to a queue. This corresponds to the JMS concept of a + Consumer.</p> + </td></tr><tr><td rowspan="2">Queue</td><td>[vh(/<em class="replaceable"><code>virtualhostname</code></em>)/qu(<em class="replaceable"><code>queuename</code></em>)]</td></tr><tr><td> + <p>A queue on a virtualhost</p> + </td></tr><tr><td rowspan="2">Exchange</td><td>[vh(/<em class="replaceable"><code>virtualhostname</code></em>)/ex(<em class="replaceable"><code>exchangetype</code></em>/<em class="replaceable"><code>exchangename</code></em>)]</td></tr><tr><td> + <p>An exchange on a virtualhost</p> + </td></tr><tr><td rowspan="2">Binding</td><td> + [vh(/<em class="replaceable"><code>virtualhostname</code></em>)/ex(<em class="replaceable"><code>exchangetype</code></em>/<em class="replaceable"><code>exchangename</code></em>)/qu(<em class="replaceable"><code>queuename</code></em>)/rk(<em class="replaceable"><code>bindingkey</code></em>)]</td></tr><tr><td> + <p>A binding between a queue and exchange with the giving binding key.</p> + </td></tr><tr><td rowspan="2">Message Store</td><td> + [vh(/<em class="replaceable"><code>virtualhostname</code></em>)/ms(<em class="replaceable"><code>messagestorename</code></em>)]</td></tr><tr><td> + <p>A virtualhost/message store on the Broker.</p> + </td></tr><tr><td rowspan="2">HA Group</td><td> [grp(/<em class="replaceable"><code>group name</code></em>)]</td></tr><tr><td> + <p>A HA group</p> + </td></tr></tbody></table></div></div><br class="table-break" /><p>The following tables lists all the operation log messages that can be produced by the + Broker, and the describes the circumstances under which each may be seen.</p><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Broker"></a><p class="title"><strong>Table C.3. Broker Log Messages</strong></p><div class="table-contents"><table border="1" summary="Broker Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1001"></a>BRK-1001</td><td>Startup : Version: <em class="replaceable"><code>version</code></em> Build: + <em class="replaceable"><code>build</code></em> + </td></tr><tr><td> + <p>Indicates that the Broker is starting up</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1002"></a>BRK-1002</td><td>Starting : Listening on <em class="replaceable"><code>transporttype</code></em> port + <em class="replaceable"><code>portnumber</code></em> + </td></tr><tr><td> + <p>Indicates that the Broker has begun listening on a port.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1003"></a>BRK-1003</td><td>Shutting down : <em class="replaceable"><code>transporttype</code></em> port + <em class="replaceable"><code>portnumber</code></em> + </td></tr><tr><td> + <p>Indicates that the Broker has stopped listening on a port.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1004"></a>BRK-1004</td><td>Qpid Broker Ready</td></tr><tr><td> + <p>Indicates that the Broker is ready for normal operations.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1005"></a>BRK-1005</td><td>Stopped</td></tr><tr><td> + <p>Indicates that the Broker is stopped.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1006"></a>BRK-1006</td><td>Using configuration : <em class="replaceable"><code>file</code></em> + </td></tr><tr><td> + <p>Indicates the name of the configuration store in use by the Broker.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1008"></a>BRK-1008</td><td><em class="replaceable"><code>delivered|received</code></em> : <em class="replaceable"><code>size</code></em> + kB/s peak : <em class="replaceable"><code>size</code></em> bytes total</td></tr><tr><td> + <p>Statistic - bytes delivered or received by the Broker.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1009"></a>BRK-1009</td><td><em class="replaceable"><code>delivered|received</code></em> : <em class="replaceable"><code>size</code></em> + msg/s peak : <em class="replaceable"><code>size</code></em> msgs total</td></tr><tr><td> + <p>Statistic - messages delivered or received by the Broker.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1010"></a>BRK-1010</td><td>Platform : JVM : <em class="replaceable"><code>vendor</code></em> version: <em class="replaceable"><code>version + </code></em> OS : <em class="replaceable"><code>operating system vendor</code></em> version: + <em class="replaceable"><code>operating system version</code></em>} arch: <em class="replaceable"><code>processor + architecture</code></em> cores: <em class="replaceable"><code>number of CPU cores</code></em></td></tr><tr><td> + <p>Key information about the environment hosting the Broker</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1011"></a>BRK-1011</td><td>Maximum Memory : Heap : <em class="replaceable"><code>size</code></em> bytes Direct : <em class="replaceable"><code> + bytes</code></em> size</td></tr><tr><td> + <p>Configured memory paramters for the Broker.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1012"></a>BRK-1012</td><td>Management Mode : User Details : <em class="replaceable"><code>management node user id</code></em> / + <em class="replaceable"><code>management mode password</code></em></td></tr><tr><td> + <p>Used when Broker is started in management mode to indicate the + management credentials that may be used connect to the Broker.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1014"></a>BRK-1014</td><td>Message flow to disk active : Message memory use <em class="replaceable"><code>size of all + messages</code></em> exceeds threshold <em class="replaceable"><code>threshold + size</code></em></td></tr><tr><td> + <p>Indicates that the memory space occupied by messages has exceeded the + threshold so the flow to disk feature has been activated.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1015"></a>BRK-1015</td><td>Message flow to disk inactive : Message memory use <em class="replaceable"><code>size of all + messages</code></em> within threshold <em class="replaceable"><code>threshold + size</code></em></td></tr><tr><td> + <p>Indicates that the memory space occupied by messages has fallen below the + threshold so the flow to disk feature has been deactivated.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1016"></a>BRK-1016</td><td>Fatal error : <em class="replaceable"><code>root cause</code></em> : See log file for more information</td></tr><tr><td> + <p>Indicates that broker was shut down due to fatal error.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BRK-1017"></a>BRK-1017</td><td>Process : PID <em class="replaceable"><code>process identifier</code></em></td></tr><tr><td> + <p>Process identifier (PID) of the Broker process.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Management"></a><p class="title"><strong>Table C.4. Management Log Messages</strong></p><div class="table-contents"><table border="1" summary="Management Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MNG-1001"></a>MNG-1001</td><td><em class="replaceable"><code>type</code></em> Management Startup </td></tr><tr><td> + <p>Indicates that a Management plugin is starting up. Supported by Web management plugin.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MNG-1002"></a>MNG-1002</td><td>Starting : <em class="replaceable"><code>type</code></em> : Listening on <em class="replaceable"><code>transporttype</code></em> port + <em class="replaceable"><code>port</code></em> + </td></tr><tr><td> + <p>Indicates that a Management plugin is listening on the given port.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MNG-1003"></a>MNG-1003</td><td>Shutting down : <em class="replaceable"><code>type</code></em> : port + <em class="replaceable"><code>port</code></em></td></tr><tr><td> + <p>Indicates that a Management plugin is ceasing to listen on the given port.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MNG-1004"></a>MNG-1004</td><td><em class="replaceable"><code>type</code></em> Management Ready</td></tr><tr><td> + <p>Indicates that a Management plugin is ready for work.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MNG-1005"></a>MNG-1005</td><td><em class="replaceable"><code>type</code></em> Management Stopped</td></tr><tr><td> + <p>Indicates that a Management plugin is stopped.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MNG-1007"></a>MNG-1007</td><td>Open : User <em class="replaceable"><code>username</code></em></td></tr><tr><td> + <p>Indicates the opening of a connection to Management has by the given + username.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MNG-1008"></a>MNG-1008</td><td>Close : User <em class="replaceable"><code>username</code></em></td></tr><tr><td> + <p>Indicates the closing of a connection to Management has by the given + username.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-VirtualHost"></a><p class="title"><strong>Table C.5. Virtual Host Log Messages</strong></p><div class="table-contents"><table border="1" summary="Virtual Host Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1001"></a>VHT-1001</td><td>Created : <em class="replaceable"><code>virtualhostname</code></em></td></tr><tr><td> + <p>Indicates that a virtualhost has been created.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1002"></a>VHT-1002</td><td>Closed</td></tr><tr><td> + <p>Indicates that a virtualhost has been closed. This occurs on Broker + shutdown.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1003"></a>VHT-1003</td><td><em class="replaceable"><code>virtualhostname</code></em> : + <em class="replaceable"><code>delivered|received</code></em> : <em class="replaceable"><code>size</code></em> kB/s + peak : <em class="replaceable"><code>size</code></em> bytes total</td></tr><tr><td> + <p>Statistic - bytes delivered or received by the virtualhost.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1004"></a>VHT-1004</td><td><em class="replaceable"><code>virtualhostname</code></em> : + <em class="replaceable"><code>delivered|received</code></em> : <em class="replaceable"><code>size</code></em> msg/s + peak : <em class="replaceable"><code>size</code></em> msgs total</td></tr><tr><td> + <p>Statistic - messages delivered or received by the virtualhost.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1005"></a>VHT-1005</td><td>Unexpected fatal error</td></tr><tr><td> + <p>Virtualhost has suffered an unexpected fatal error, check the logs for more + details.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1006"></a>VHT-1006</td><td>Filesystem is over <em class="replaceable"><code>size in %</code></em> per cent full, enforcing flow control.</td></tr><tr><td> + <p>Indicates that virtual host flow control is activated + when the usage of file system containing Virtualhost message store exceeded predefined limit.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-VHT-1007"></a>VHT-1007</td><td>Filesystem is no longer over <em class="replaceable"><code>size in %</code></em> per cent full.</td></tr><tr><td> + <p>Indicates that virtual host flow control is deactivated + when the usage of file system containing Virtualhost message falls under predefined limit.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Queue"></a><p class="title"><strong>Table C.6. Queue Log Messages</strong></p><div class="table-contents"><table border="1" summary="Queue Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1001"></a>QUE-1001</td><td>Create : Owner: <em class="replaceable"><code>owner</code></em> + <em class="replaceable"><code>AutoDelete</code></em> [<em class="replaceable"><code>Durable</code></em>] + <em class="replaceable"><code>Transient</code></em> Priority: + <em class="replaceable"><code>numberofpriorities</code></em></td></tr><tr><td> + <p>Indicates that a queue has been created.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1002"></a>QUE-1002</td><td>Deleted</td></tr><tr><td> + <p>Indicates that a queue has been deleted.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1003"></a>QUE-1003</td><td> + Overfull : Size : <em class="replaceable"><code>size in bytes</code></em>, Capacity : <em class="replaceable"><code>resumesize in bytes</code></em>, + Messages : <em class="replaceable"><code>size in messages</code></em>, Message Capacity : <em class="replaceable"><code>resumesize in messages</code></em> + </td></tr><tr><td> + <p>Indicates that a queue has exceeded its permitted capacity when + <span class="emphasis"><em>Producer Flow Control</em></span> overflow policy is used. + See <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.7. Controlling Queue Size">Section 4.7.7, “Controlling Queue Size”</a> for details.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1004"></a>QUE-1004</td><td> + Underfull : Size : <em class="replaceable"><code>size in bytes</code></em>, Capacity : <em class="replaceable"><code>resumesize in bytes</code></em>, + Messages : <em class="replaceable"><code>size in messages</code></em>, Message Capacity : <em class="replaceable"><code>resumesize in messages</code></em> + </td></tr><tr><td> + <p> + Indicates that a queue has fallen to its resume capacity when + <span class="emphasis"><em>Producer Flow Control</em></span> overflow policy is used. + See <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.7. Controlling Queue Size">Section 4.7.7, “Controlling Queue Size”</a> for details. + </p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1004"></a>QUE-1005</td><td> + Dropped : <em class="replaceable"><code>number</code></em> messages, Depth : <em class="replaceable"><code>size</code></em> bytes, + <em class="replaceable"><code>size</code></em> messages, Capacity : <em class="replaceable"><code>limit</code></em> bytes, + <em class="replaceable"><code>limit</code></em> messages + </td></tr><tr><td> + <p> + Indicates that a given number of messages is deleted when <span class="emphasis"><em>Ring</em></span> overflow policy is + used and any of queue capacity limits is breached . + See <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.7. Controlling Queue Size">Section 4.7.7, “Controlling Queue Size”</a> for details. + </p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1014"></a>QUE-1014</td><td>Message flow to disk active : Message memory use <em class="replaceable"><code>size of all + messages</code></em> exceeds threshold <em class="replaceable"><code>threshold + size</code></em></td></tr><tr><td> + <p>Indicates that the memory space occupied by messages for this queue + has exceeded thevthreshold so the flow to disk feature has been activated.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-QUE-1015"></a>QUE-1015</td><td>Message flow to disk inactive : Message memory use <em class="replaceable"><code>size of all + messages</code></em> within threshold <em class="replaceable"><code>threshold + size</code></em></td></tr><tr><td> + <p>Indicates that the memory space occupied by messages for this queue has fallen + below the threshold so the flow to disk feature has been deactivated.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Exchange"></a><p class="title"><strong>Table C.7. Exchange Log Messages</strong></p><div class="table-contents"><table border="1" summary="Exchange Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-EXH-1001"></a>EXH-1001</td><td>Create : [<em class="replaceable"><code>Durable</code></em>] Type: <em class="replaceable"><code>type</code></em> + Name: <em class="replaceable"><code>exchange name</code></em></td></tr><tr><td> + <p>Indicates that an exchange has been created.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-EXH-1002"></a>EXH-1002</td><td>Deleted</td></tr><tr><td> + <p>Indicates that an exchange has been deleted.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-EXH-1003"></a>EXH-1003</td><td>Discarded Message : Name: <em class="replaceable"><code>exchange name</code></em> Routing Key: + <em class="replaceable"><code>routing key</code></em></td></tr><tr><td> + <p>Indicates that an exchange received a message that could not be routed to at least + one queue. queue has exceeded its permitted capacity. See <a class="xref" href="Java-Broker-Concepts-Exchanges.html#Java-Broker-Concepts-Exchanges-UnroutableMessage" title="4.6.4. Unrouteable Messages">Section 4.6.4, “Unrouteable Messages”</a> for details.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Binding"></a><p class="title"><strong>Table C.8. Binding Log Messages</strong></p><div class="table-contents"><table border="1" summary="Binding Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BND-1001"></a>BND-1001</td><td>Create : Arguments : <em class="replaceable"><code>arguments</code></em></td></tr><tr><td> + <p>Indicates that a binding has been made between an exchange and a queue.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-BND-1002"></a>BND-1002</td><td>Deleted</td></tr><tr><td> + <p>Indicates that a binding has been deleted</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Connection"></a><p class="title"><strong>Table C.9. Connection Log Messages</strong></p><div class="table-contents"><table border="1" summary="Connection Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CON-1001"></a>CON-1001</td><td>Open : Destination : <em class="replaceable"><code>target port</code></em> : Protocol Version : + <em class="replaceable"><code>protocol version</code></em> : Client ID : <em class="replaceable"><code>clientid</code></em> : + Client Version : <em class="replaceable"><code>client version</code></em> : + Client Product : <em class="replaceable"><code>client product</code></em></td></tr><tr><td> + <p>Indicates that a connection has been opened. The Broker logs one of these message + each time it learns more about the client as the connection is negotiated.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CON-1002"></a>CON-1002</td><td>Close</td></tr><tr><td> + <p>Indicates that a connection has been closed. This message is logged regardless of + if the connection is closed normally, or if the connection is somehow lost e.g network + error. </p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CON-1003"></a>CON-1003</td><td>Closed due to inactivity</td></tr><tr><td> + <p>Used when heart beating is in-use. Indicates that the connection has not received + a heartbeat for too long and is therefore closed as being inactive. </p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CON-1004"></a>CON-1004</td><td>Connection dropped</td></tr><tr><td> + <p>Indicates that a connection has been unexpectedly closed by the peer. This usually + occurs if a machine hosting an application fails or the application's process is + abruptly terminated.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CON-1005"></a>CON-1005</td><td>Client version <em class="replaceable"><code>version</code></em> logged by validation</td></tr><tr><td> + <p>Indicates that a connection has been received from client with a version number + that is configured to be logged. This feature may help teams manage software currency.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CON-1006"></a>CON-1006</td><td>Client version <em class="replaceable"><code>version</code></em> rejected by validation</td></tr><tr><td> + <p>Indicates that a connection attempt has been received from client with a version number + that is configured to be rejected. This feature may help manage software currency.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CON-1007"></a>CON-1007</td><td>Connection close initiated by operator</td></tr><tr><td> + <p>Indicates that a connection has been closed by the actions of an + Operator using manangement.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Channel"></a><p class="title"><strong>Table C.10. Channel Log Messages</strong></p><div class="table-contents"><table border="1" summary="Channel Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1001"></a>CHN-1001</td><td>Create</td></tr><tr><td> + <p>Indicates that a channel (corresponds to the JMS concept of Session) has been + created.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1002"></a>CHN-1002</td><td>Flow Started</td></tr><tr><td> + <p>Indicates message flow to a session has begun.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1003"></a>CHN-1003</td><td>Close</td></tr><tr><td> + <p>Indicates that a channel has been closed.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1004"></a>CHN-1004</td><td>Prefetch Size (bytes) <em class="replaceable"><code>size</code></em> : Count <em class="replaceable"><code>number + of messages</code></em></td></tr><tr><td> + <p>Indicates the prefetch size in use by a channel.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1005"></a>CHN-1005</td><td>Flow Control Enforced (Queue <em class="replaceable"><code>queue name</code></em>)</td></tr><tr><td> + <p>Indicates that producer flow control has been imposed on a channel owning to + excessive queue depth in the indicated queue. Produces using the channel will be + requested to pause the sending of messages. + See <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.7. Controlling Queue Size">Section 4.7.7, “Controlling Queue Size”</a> for more details.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1006"></a>CHN-1006</td><td>Flow Control Removed</td></tr><tr><td> + <p>Indicates that producer flow control has been removed from a channel. + See <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.7. Controlling Queue Size">Section 4.7.7, “Controlling Queue Size”</a> for more details.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1007"></a>CHN-1007</td><td>Open Transaction : <em class="replaceable"><code>time</code></em> ms</td></tr><tr><td> + <p>Indicates that a producer transaction has been open for longer than that + permitted. See <a class="xref" href="Java-Broker-Runtime-Producer-Transaction-Timeout.html" title="9.3. Producer Transaction Timeout">Section 9.3, “Producer Transaction Timeout”</a> for + more details.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1008"></a>CHN-1008</td><td>Idle Transaction : <em class="replaceable"><code>time</code></em> ms</td></tr><tr><td> + <p>Indicates that a producer transaction has been idle for longer than that + permitted. See <a class="xref" href="Java-Broker-Runtime-Producer-Transaction-Timeout.html" title="9.3. Producer Transaction Timeout">Section 9.3, “Producer Transaction Timeout”</a> for + more details.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1009"></a>CHN-1009</td><td>Discarded message : <em class="replaceable"><code>message number</code></em> as no alternate + exchange configured for queue : <em class="replaceable"><code>queue name</code></em>{1} routing key : + <em class="replaceable"><code>routing key</code></em></td></tr><tr><td> + <p>Indicates that a channel has discarded a message as the maximum delivery count has + been exceeded but the queue defines no alternate exchange. See <a class="xref" href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Maximum-Delivery-Count" title="9.4.2. Maximum Delivery Count">Section 9.4.2, “Maximum Delivery Count”</a> for more details. Note that <em class="replaceable"><code>message number</code></em> is an + internal message reference.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1010"></a>CHN-1010</td><td>Discarded message : <em class="replaceable"><code>message number</code></em> as no binding on + alternate exchange : <em class="replaceable"><code>exchange name</code></em></td></tr><tr><td> + <p>Indicates that a channel has discarded a message as the maximum delivery count has + been exceeded but the queue's alternate exchange has no binding to a queue. See <a class="xref" href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Maximum-Delivery-Count" title="9.4.2. Maximum Delivery Count">Section 9.4.2, “Maximum Delivery Count”</a> for more details. Note that <em class="replaceable"><code>message number</code></em> is an + internal message reference.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1011"></a>CHN-1011</td><td>Message : <em class="replaceable"><code>message number</code></em> moved to dead letter queue : + <em class="replaceable"><code>queue name</code></em></td></tr><tr><td> + <p>Indicates that a channel has moved a message to the named dead letter queue + </p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1012"></a>CHN-1012</td><td>Flow Control Ignored. Channel will be closed.</td></tr><tr><td> + <p>Indicates that a channel violating the imposed flow control has been closed + </p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CHN-1013"></a>CHN-1013</td><td>Uncommitted transaction contains <em class="replaceable"><code>size</code></em> bytes of incoming message data.</td></tr><tr><td> + <p>Warns about uncommitted transaction with large message(s) + </p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Subscription"></a><p class="title"><strong>Table C.11. Subscription Log Messages</strong></p><div class="table-contents"><table border="1" summary="Subscription Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-SUB-1001"></a>SUB-1001</td><td>Create : [<em class="replaceable"><code>Durable</code></em>] Arguments : + <em class="replaceable"><code>arguments</code></em></td></tr><tr><td> + <p>Indicates that a subscription (corresponds to JMS concept of a MessageConsumer) + has been created.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-SUB-1002"></a>SUB-1002</td><td>Close</td></tr><tr><td> + <p>Indicates that a subscription has been closed.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-SUB-1003"></a>SUB-1003</td><td>SUB-1003 : Suspended for <em class="replaceable"><code>time</code></em> ms</td></tr><tr><td> + <p>Indicates that a subscription has been in a suspened state for an unusual length + of time. This may be indicative of an consuming application that has stopped taking + messages from the consumer (i.e. a JMS application is not calling receive() or its + asynchronous message listener onMessage() is blocked in application code). It may also + indicate a generally overloaded system. + </p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-MessageStore"></a><p class="title"><strong>Table C.12. Message Store Log Messages</strong></p><div class="table-contents"><table border="1" summary="Message Store Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1001"></a>MST-1001</td><td>Created</td></tr><tr><td> + <p>Indicates that a message store has been created. The message store is responsible + for the storage of the messages themselves, including the message body and any + headers.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1002"></a>MST-1002</td><td>Store location : <em class="replaceable"><code>path</code></em></td></tr><tr><td> + <p>Indicates that the message store is using <em class="replaceable"><code>path</code></em> for the + location of the message store.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1003"></a>MST-1003</td><td>Closed</td></tr><tr><td> + <p>Indicates that the message store has been closed.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1004"></a>MST-1004</td><td>Recovery Start</td></tr><tr><td> + <p>Indicates that message recovery has begun.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1005"></a>MST-1005</td><td>Recovered <em class="replaceable"><code>number of messages</code></em> messages.</td></tr><tr><td> + <p>Indicates that recovery recovered the given number of messages from the + store.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1006"></a>MST-1006</td><td>Recovered Complete</td></tr><tr><td> + <p>Indicates that the message recovery is concluded.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1007"></a>MST-1007</td><td>Store Passivated</td></tr><tr><td> + <p>The store is entering a passive state where is it unavailable for normal + operations. Currently this message is used by HA when the node is in replica + state.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1008"></a>MST-1008</td><td>Store overfull, flow control will be enforced</td></tr><tr><td> + <p>The store has breached is maximum configured size. + See <a class="xref" href="Java-Broker-Runtime-Disk-Space-Management.html#Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control" title="9.2.1. Disk quota-based flow control">Section 9.2.1, “Disk quota-based flow control”</a> for details.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-1009"></a>MST-1009</td><td>Store overfull condition cleared</td></tr><tr><td> + <p>The store size has fallen beneath its resume capacity and therefore flow control + has been rescinded. See <a class="xref" href="Java-Broker-Runtime-Disk-Space-Management.html#Java-Broker-Runtime-Disk-Space-Management-Producer-Flow-Control" title="9.2.1. Disk quota-based flow control">Section 9.2.1, “Disk quota-based flow control”</a> + for details. </p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-TransactionStore"></a><p class="title"><strong>Table C.13. Transaction Store Log Messages</strong></p><div class="table-contents"><table border="1" summary="Transaction Store Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-TXN-1001"></a>TXN-1001</td><td>Created</td></tr><tr><td> + <p>Indicates that a transaction store has been created. The transaction store is + responsible for the storage of messages instances, that is, the presence of a message + on a queue.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-TXN-1002"></a>TXN-1002</td><td>Store location : <em class="replaceable"><code>path</code></em></td></tr><tr><td> + <p>Indicates that the transaction store is using <em class="replaceable"><code>path</code></em> for + the location of the store.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-TXN-1003"></a>TXN-1003</td><td>Closed</td></tr><tr><td> + <p>Indicates that the transaction store has been closed.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-TXN-1004"></a>TXN-1004</td><td>Recovery Start</td></tr><tr><td> + <p>Indicates that transaction recovery has begun.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-MST-TXN"></a>TXN-1005</td><td>Recovered <em class="replaceable"><code>number</code></em> messages for queue + <em class="replaceable"><code>name</code></em>.</td></tr><tr><td> + <p>Indicates that recovery recovered the given number of message instances for the + given queue.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-TXN-1006"></a>TXN-1006</td><td>Recovered Complete</td></tr><tr><td> + <p>Indicates that the message recovery is concluded.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-ConfigurationStore"></a><p class="title"><strong>Table C.14. Configuration Store Log Messages</strong></p><div class="table-contents"><table border="1" summary="Configuration Store Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CFG-1001"></a>CFG-1001</td><td>Created</td></tr><tr><td> + <p>Indicates that a configuration store has been created. The configuration store is + responsible for the storage of the definition of objects such as queues, exchanges, + and bindings.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CFG-1002"></a>CFG-1002</td><td>Store location : <em class="replaceable"><code>path</code></em></td></tr><tr><td> + <p>Indicates that the configuration store is using <em class="replaceable"><code>path</code></em> + for the location of the store.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CFG-1003"></a>CFG-1003</td><td>Closed</td></tr><tr><td> + <p>Indicates that the configuration store has been closed.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CFG-1004"></a>CFG-1004</td><td>Recovery Start</td></tr><tr><td> + <p>Indicates that configuration recovery has begun.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-CFG-1005"></a>CFG-1005</td><td>Recovered Complete</td></tr><tr><td> + <p>Indicates that the configuration recovery is concluded.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-HA"></a><p class="title"><strong>Table C.15. HA Log Messages</strong></p><div class="table-contents"><table border="1" summary="HA Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1001"></a>HA-1001</td><td>Created</td></tr><tr><td> + <p>This HA node has been created.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1002"></a>HA-1002</td><td>Deleted</td></tr><tr><td> + <p>This HA node has been deleted</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1003"></a>HA-1003</td><td>Added : Node : '<em class="replaceable"><code>name</code></em>' + (<em class="replaceable"><code>host:port</code></em>)</td></tr><tr><td> + <p>A new node has been added to the group.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1004"></a>HA-1004</td><td>Removed : Node : '<em class="replaceable"><code>name</code></em>' + (<em class="replaceable"><code>host:port</code></em>)</td></tr><tr><td> + <p>The node has been removed from the group. This removal is permanent.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1005"></a>HA-1005</td><td>Joined : Node : '<em class="replaceable"><code>name</code></em>' + (<em class="replaceable"><code>host:port</code></em>)</td></tr><tr><td> + <p>The node has become reachable. This may be as a result of the node being + restarted, or a network problem may have been resolved.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1006"></a>HA-1006</td><td>Left : Node : '<em class="replaceable"><code>name</code></em>' + (<em class="replaceable"><code>host:port</code></em>)</td></tr><tr><td> + <p>The node is no longer reachable. This may be as a result of the node being stopped + or a network partition may be preventing it from being connected. The node is still a + member of the group.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1007"></a>HA-1007</td><td>HA-1007 : Master transfer requested : to '<em class="replaceable"><code>name</code></em>' + (<em class="replaceable"><code>host:port</code></em>)</td></tr><tr><td> + <p>Indicates that a master transfer operation has been requested.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1008"></a>HA-1008</td><td>HA-1008 : Intruder detected : Node '<em class="replaceable"><code>name</code></em>' + (<em class="replaceable"><code>host:port</code></em>)</td></tr><tr><td> + <p>Indicates that an unexpected node has joined the group. The virtualhost node will + go into the ERROR state in response to the condition.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1009"></a>HA-1009</td><td>HA-1009 : Insufficient replicas contactable</td></tr><tr><td> + <p>This node (which was in the master role) no longer has sufficient replica in + contact in order to complete transactions.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1010"></a>HA-1010</td><td>HA-1010 : Role change reported: Node : '<em class="replaceable"><code>name</code></em>' + (<em class="replaceable"><code>host:port</code></em>) : from <em class="replaceable"><code>role</code></em> to + <em class="replaceable"><code>role</code></em></td></tr><tr><td> + <p>Indicates that the node has changed role within the group.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1011"></a>HA-1011</td><td>HA-1011 : Minimum group size : <em class="replaceable"><code>new group size</code></em></td></tr><tr><td> + <p>The quorum requirements from completing elections or transactions has been + changed.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1012"></a>HA-1012</td><td>HA-1012 : Priority : <em class="replaceable"><code>priority</code></em></td></tr><tr><td> + <p>The priority of the object node has been changed. Zero indicates that the node + cannot be elected master.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1013"></a>HA-1013</td><td>HA-1013 : Designated primary : <em class="replaceable"><code>true|false</code></em></td></tr><tr><td> + <p>This node has been designated primary and can now operate solo. Applies to two + node groups only. See <a class="xref" href="Java-Broker-High-Availability-Behaviour.html#Java-Broker-High-Availability-Behaviour-DesignatedPrimary" title="10.4.5. Allow to Operate Solo">Section 10.4.5, “Allow to Operate Solo”</a></p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-HA-1014"></a>HA-1014</td><td>HA-1014 : Diverged transactions discarded</td></tr><tr><td> + <p>This node is in the process of rejoining the group but has discovered that some + of its transactions differ from those of the current master. The node will + automatically roll-back (i.e. discard) the diverging transactions in order to be + allowed to rejoin the group. This situation can only usually occur as a result of use + of the weak durability options. These allow the group to operate with fewer than + quorum nodes and therefore allow the inconsistencies to develop. </p> + <p>On encountering this condition, it is <span class="emphasis"><em>strongly</em></span> recommendend + to run an application level reconcilation to determine the data that has been + lost.</p> + </td></tr></tbody></table></div></div><br class="table-break" /><div class="table"><a id="Java-Broker-Appendix-Operation-Logging-Message-List-Port"></a><p class="title"><strong>Table C.16. Port Log Messages</strong></p><div class="table-contents"><table border="1" summary="Port Log Messages" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Message Id</th><th>Message Text / Purpose</th></tr></thead><tbody><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1001"></a>PRT-1001</td><td>Create</td></tr><tr><td> + <p>Port has been created.</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1002"></a>PRT-1002</td><td>Open</td></tr><tr><td> + <p>Port has been open</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1003"></a>PRT-1003</td><td>Close</td></tr><tr><td> + <p>Port has been closed</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1004"></a>PRT-1004</td><td>Connection count <em class="replaceable"><code>number</code></em> within <em class="replaceable"><code>warn limit</code></em> % of maximum <em class="replaceable"><code>limit</code></em> + </td></tr><tr><td> + <p>Warns that number of open connections approaches maximum allowed limit</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1005"></a>PRT-1005</td><td>Connection from <em class="replaceable"><code>peer</code></em> rejected. Maximum connection count (<em class="replaceable"><code>limit</code></em>) for this port already reached.</td></tr><tr><td> + <p>Connection from given host is rejected because of reaching the maximum allowed limit</p> + </td></tr><tr><td rowspan="2"><a id="Java-Broker-Appendix-Operation-Logging-Message-PRT-1007"></a>PRT-1007</td><td>Unsupported protocol header received, replying with <em class="replaceable"><code>AMQP version</code></em></td></tr><tr><td> + <p>Ususualy indicates an attempt to make an non-AMQP connection on an AMQP port, for instance, + with a web browser.</p> + </td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Appendix-System-Properties.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Appendix-Queue-Alerts.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Appendix B. System Properties </td><td align="center" width="20%"><a accesskey="h" href="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Appendix D. Queue Alerts</td></tr></table></div></div> \ No newline at end of file
http://git-wip-us.apache.org/repos/asf/qpid-site/blob/32dce6b5/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Alerts.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Alerts.html.in b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Alerts.html.in new file mode 100644 index 0000000..382a1f3 --- /dev/null +++ b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Alerts.html.in @@ -0,0 +1,28 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Appendix D. Queue Alerts</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Appendix-Operation-Logging.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Miscellaneous.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Appendix-Queue-Alerts"></a>Appendix D. Queue Alerts</h1></div></div></div><p>The Broker supports a variety of queue alerting thresholds. Once configured on a queue, + these limits will be periodically written to the log if these limits are breached, until the + condition is rectified.</p><p>For example, if queue <code class="literal">myqueue</code> is configured with a message count alert of + 1000, and then owing to a failure of a downstream system messages begin to accumulate on the + queue, the following alerts will be written periodically to the log. </p><pre class="screen"> +INFO [default:VirtualHostHouseKeepingTask] (queue.NotificationCheck) - MESSAGE_COUNT_ALERT + On Queue myqueue - 1272: Maximum count on queue threshold (1000) breached. + </pre><p>Note that queue alerts are <span class="emphasis"><em>soft</em></span> in nature; breaching the limit will + merely cause the alerts to be generated but messages will still be accepted to the queue.</p><div class="table"><a id="Java-Broker-Appendix-Queue-Alerts-Alerting-Messages"></a><p class="title"><strong>Table D.1. Queue Alerts</strong></p><div class="table-contents"><table border="1" summary="Queue Alerts" width="100%"><colgroup><col /><col /></colgroup><thead><tr><th>Alert Name</th><th>Alert Format and Purpose</th></tr></thead><tbody><tr><td rowspan="2">MESSAGE_COUNT_ALERT</td><td> MESSAGE_COUNT_ALERT On Queue <em class="replaceable"><code>queuename</code></em> - + <em class="replaceable"><code>number of messages</code></em>: Maximum count on queue threshold + (<em class="replaceable"><code>limit</code></em>) breached. </td></tr><tr><td> + <p>The number of messages on the given queue has breached its configured + limit.</p> + </td></tr><tr><td rowspan="2">MESSAGE_SIZE_ALERT</td><td> MESSAGE_SIZE_ALERT On Queue <em class="replaceable"><code>queuename</code></em> + -<em class="replaceable"><code>message size</code></em> : Maximum message size threshold + (<em class="replaceable"><code>limit</code></em>) breached. [Message ID=<em class="replaceable"><code>message + id</code></em>]</td></tr><tr><td> + <p>The size of an individual messages has breached its configured limit.</p> + </td></tr><tr><td rowspan="2">QUEUE_DEPTH_ALERT</td><td> QUEUE_DEPTH_ALERT On Queue <em class="replaceable"><code>queuename</code></em> - + <em class="replaceable"><code>total size of all messages on queue</code></em> : Maximum queue depth + threshold (<em class="replaceable"><code>limit</code></em>) breached.</td></tr><tr><td> + <p>The total size of all messages on the queue has breached its configured + limit.</p> + </td></tr><tr><td rowspan="2">MESSAGE_AGE_ALERT</td><td>MESSAGE_AGE_ALERT On Queue <em class="replaceable"><code>queuename</code></em> - <em class="replaceable"><code>age + of message</code></em> : Maximum age on queue threshold + (<em class="replaceable"><code>limit</code></em>) breached. </td></tr><tr><td> + <p>The age of a message on the given queue has breached its configured limit.</p> + </td></tr></tbody></table></div></div><br class="table-break" /></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> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Miscellaneous.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Appendix C. Operational Logging </td><td align="center" width="20%"><a accesskey="h" href="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Appendix E. Miscellaneous</td></tr></table></div></div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/32dce6b5/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Declare-Arguments.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Declare-Arguments.html.in b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Declare-Arguments.html.in new file mode 100644 index 0000000..424a1e7 --- /dev/null +++ b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-Queue-Declare-Arguments.html.in @@ -0,0 +1,55 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Appendix F. Queue Declaration Arguments supported by the Broker</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> </td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Appendix-Queue-Declare-Arguments"></a>Appendix F. Queue Declaration Arguments supported by the Broker</h1></div></div></div><p> + <span class="emphasis"><em>Qpid Broker for Java</em></span> + supports a number of custom arguments which can be specified as part of <span class="emphasis"><em>queue.declare</em></span> + commands for AMQP 0-x protocols. This section provides an overview of the supported arguments. + </p><div class="table"><a id="Java-Broker-Appendix-Supported-Queue-Declare-Arguments"></a><p class="title"><strong>Table F.1. Queue declare arguments</strong></p><div class="table-contents"><table border="1" summary="Queue declare arguments"><colgroup><col class="col1" /><col class="col2" /></colgroup><thead><tr><th>Argument Name</th><th>Description</th></tr></thead><tbody><tr><td colspan="2"><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Overflow-Policy"></a> + <p>Declaration of overflow policy. + See + <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.7. Controlling Queue Size">Section 4.7.7, “Controlling Queue Size”</a> + for more details. + </p> + </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Policy-Type"></a> + <p>qpid.policy_type</p> + </td><td> + <p>Defines queue overflow policy.</p> + </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Max-Count"></a> + <p>qpid.max_count</p> + </td><td> + <p>Defines <span class="emphasis"><em>maximum number of messages</em></span>. + </p> + </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Max-Size"></a> + <p>qpid.max_size</p> + </td><td> + <p>Defines <span class="emphasis"><em>maximum number of bytes</em></span>. + </p> + </td></tr><tr><td colspan="2"> + <p>The <span class="emphasis"><em>Overflow Policy</em></span> and the limits can be specified using + <span class="emphasis"><em>Address</em></span> + based syntax as in the example below: + </p><pre class="screen"> +my-queue; {create: always, node: {x-declare: {arguments:{'qpid.max_count': 10000, 'qpid.max_size': 102400, 'qpid.policy_type: 'ring'}}}} +</pre><p> + </p> + </td></tr><tr><td colspan="2"><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Overflow-Policy-Producer-Flow-Control"></a> + <p>Alternative declaration of <span class="emphasis"><em>Producer Flow Control</em></span> overflow policy. + See + <a class="xref" href="Java-Broker-Concepts-Queues.html#Java-Broker-Concepts-Queue-OverflowPolicy" title="4.7.7. Controlling Queue Size">Section 4.7.7, “Controlling Queue Size”</a> + for more details. + </p> + </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Capacity"></a> + <p>x-qpid-capacity</p> + </td><td> + <p>Defines <span class="emphasis"><em>maximum number of bytes</em></span>. + </p> + </td></tr><tr><td><a id="Java-Broker-Appendix-Queue-Declare-Arguments-Flow-Resume-Capacity"></a> + <p>x-qpid-flow-resume-capacity</p> + </td><td> + <p>Defines flow resume threshold in bytes</p> + </td></tr><tr><td colspan="2"> + <p>The <span class="emphasis"><em>Producer Flow Control</em></span> can be specified using + <span class="emphasis"><em>Address</em></span> based syntax as in the example below: + </p><pre class="screen"> +my-queue; {create: always, node: {x-declare: {arguments:{'x-qpid-capacity': 102400, 'x-qpid-flow-resume-capacity': 8192000}}}} +</pre><p> + </p> + </td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Miscellaneous-Installing-Oracle-BDB-JE.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> </td></tr><tr><td align="left" valign="top" width="40%">E.3. Installing Oracle BDB JE </td><td align="center" width="20%"><a accesskey="h" href="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> </td></tr></table></div></div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/32dce6b5/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-System-Properties.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-System-Properties.html.in b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-System-Properties.html.in new file mode 100644 index 0000000..f8053aa --- /dev/null +++ b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Appendix-System-Properties.html.in @@ -0,0 +1,13 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">Appendix B. System Properties</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Appendix-Environment-Variables.html">Prev</a> </td><th align="center" width="60%"> </th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Appendix-Operation-Logging.html">Next</a></td></tr></table><hr /></div><div class="appendix"><div class="titlepage"><div><div><h1 class="title"><a id="Java-Broker-Appendix-System-Properties"></a>Appendix B. System Properties</h1></div></div></div><p>The following table describes the Java system properties used by the Broker to control + various optional behaviours.</p><p>The preferred method of enabling these system properties is using the <a class="link" href="Java-Broker-Appendix-Environment-Variables.html#Java-Broker-Appendix-Environment-Variables-Qpid-Opts"><code class="literal">QPID_OPTS</code></a> environment variable described in the previous + section.</p><div class="table"><a id="d0e7564"></a><p class="title"><strong>Table B.1. System properties</strong></p><div class="table-contents"><table border="1" summary="System properties" width="100%"><colgroup><col /><col /><col /></colgroup><thead><tr><th>System property</th><th>Default</th><th>Purpose</th></tr></thead><tbody><tr><td><a id="Java-Broker-Appendix-System-Properties-Broker-Heartbeat-Timeout-Factor"></a>qpid.broker_heartbeat_timeout_factor</td><td>2</td><td>Factor to determine the maximum length of that may elapse between heartbeats being + received from the peer before a connection is deemed to have been broken.</td></tr><tr><td><a id="Java-Broker-Appendix-System-Properties-Broker-Dead-Letter-Exchange-Suffix"></a>qpid.broker_dead_letter_exchange_suffix</td><td>_DLE</td><td>Used with the <a class="xref" href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Dead-Letter-Queues" title="9.4.3. Dead Letter Queues (DLQ)">Section 9.4.3, “Dead Letter Queues (DLQ)”</a> + feature. Governs the suffix used when generating a name for a Dead Letter + Exchange.</td></tr><tr><td><a id="Java-Broker-Appendix-System-Properties-Broker-Dead-Letter-Queue-Suffix"></a>qpid.broker_dead_letter_queue_suffix</td><td>_DLQ</td><td>Used with the <a class="xref" href="Java-Broker-Runtime-Handling-Undeliverable-Messages.html#Java-Broker-Runtime-Handling-Undeliverable-Messages-Dead-Letter-Queues" title="9.4.3. Dead Letter Queues (DLQ)">Section 9.4.3, “Dead Letter Queues (DLQ)”</a> + feature. Governs the suffix used when generating a name for a Dead Letter Queue.</td></tr><tr><td><a id="Java-Broker-Appendix-System-Properties-Broker-Status-Updates"></a>qpid.broker_status_updates</td><td>true</td><td> + <p>If set true, the Broker will produce operational logging messages.</p> + </td></tr><tr><td><a id="Java-Broker-Appendix-System-Properties-Broker-Disabled-Features"></a>qpid.broker_disabled_features</td><td>none</td><td> + <p>Allows optional Broker features to be disabled. Currently understood feature + names are: <code class="literal">qpid.jms-selector</code></p> + <p>Feature names should be comma separated.</p> + </td></tr></tbody></table></div></div><br class="table-break" /></div><div class="navfooter"><hr /><table summary="Navigation footer" width="100%"><tr><td align="left" width="40%"><a accesskey="p" href="Java-Broker-Appendix-Environment-Variables.html">Prev</a> </td><td align="center" width="20%"> </td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Appendix-Operation-Logging.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Appendix A. Environment Variables </td><td align="center" width="20%"><a accesskey="h" href="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Appendix C. Operational Logging</td></tr></table></div></div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/32dce6b5/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html.in b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html.in new file mode 100644 index 0000000..ac12c1a --- /dev/null +++ b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost-Node.html.in @@ -0,0 +1,13 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">11.2. Virtualhost Node</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Backup-And-Recovery.html">Prev</a> </td><th align="center" width="60%">Chapter 11. Backup And Recovery</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Backup-And-Recovery-Virtualhost.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Node"></a>11.2. Virtualhost Node</h2></div></div></div><p>To perform a complete backup of a Virtualhost node whilst it is stopped (or Broker down), + simply copy all the files the exist beneath + <code class="literal">${QPID_WORK}/<nodename>/config</code>, assuming the virtualhost node is in + the standard location. This will copy all configuration that belongs to that virtualhost + node.</p><p>The technique for backing up a virtualhost node whilst it is running depends on its + type.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB"></a>11.2.1. BDB</h3></div></div></div><p>BDB module includes the "hot" backup utility <code class="literal">org.apache.qpid.server.store.berkeleydb.BDBBackup</code>. + This utility can perform the backup when the broker is running.</p><p>You can run this class from command line like in an example below:</p><div class="example"><a id="d0e7294"></a><p class="title"><strong>Example 11.1. Performing store backup by using <code class="classname">BDBBackup</code> class + directly</strong></p><div class="example-contents"><div class="cmdsynopsis"><p><code class="command">java</code> -cp <em class="replaceable"><code>"${QPID_HOME}/lib/*"</code></em> org.apache.qpid.server.store.berkeleydb.BDBBackup \ <br /> -fromdir <em class="replaceable"><code>${QPID_WORK}/<nodename>/config</code></em> -todir <em class="replaceable"><code>path/to/backup/folder</code></em> </p></div></div></div><br class="example-break" /><p>In the example above BDBBackup utility is called to backup the store at + <code class="literal">${QPID_WORK}/<nodename>/config</code> and copy store logs into + <code class="literal">path/to/backup/folder</code>.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB-HA"></a>11.2.2. BDB-HA</h3></div></div></div><p>See <a class="xref" href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html#Java-Broker-Backup-And-Recovery-Virtualhost-Node-BDB" title="11.2.1. BDB">Section 11.2.1, “BDB”</a></p><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><h3 class="title">Note</h3><p>BDB-HA VirtualHost node backups are node specific. You cannot use the backup of one node to recover a different node. To backup a group a backup of each node needs to be taken separately.</p></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-Derby"></a>11.2.3. Derby</h3></div></div></div><p>Not yet supported</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-JDBC"></a>11.2.4. JDBC</h3></div></div></div><p>The responsibility for backup is delegated to the database server itself. See the + documentation accompanying it. Any technique that takes a consistent snapshot of the + database is acceptable.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Node-JSON"></a>11.2.5. JSON</h3></div></div></div><p>JSON stores its config in a single text file. It can be safely backed up using standard + command line tools.</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-Backup-And-Recovery.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Backup-And-Recovery.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Backup-And-Recovery-Virtualhost.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">Chapter 11. Backup And Recovery </td><td align="center" width="20%"><a accesskey="h" href="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> 11.3. Virtualhost</td></tr></table></div></div> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/qpid-site/blob/32dce6b5/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost.html.in ---------------------------------------------------------------------- diff --git a/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost.html.in b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost.html.in new file mode 100644 index 0000000..8ff4dbf --- /dev/null +++ b/input/releases/qpid-broker-j-master/java-broker/book/Java-Broker-Backup-And-Recovery-Virtualhost.html.in @@ -0,0 +1,10 @@ +<div class="docbook"><div class="navheader"><table summary="Navigation header" width="100%"><tr><th align="center" colspan="3">11.3. Virtualhost</th></tr><tr><td align="left" width="20%"><a accesskey="p" href="Java-Broker-Backup-And-Recovery-Virtualhost-Node.html">Prev</a> </td><th align="center" width="60%">Chapter 11. Backup And Recovery</th><td align="right" width="20%"> <a accesskey="n" href="Java-Broker-Appendix-Environment-Variables.html">Next</a></td></tr></table><hr /></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="Java-Broker-Backup-And-Recovery-Virtualhost"></a>11.3. Virtualhost</h2></div></div></div><p>To perform a complete backup of a Virtualhost whilst it is stopped (or Broker down), + simply copy all the files the exist beneath + <code class="literal">${QPID_WORK}/<name>/messages</code>, assuming the virtualhost is in the + standard location. This will copy all messages that belongs to that virtualhost.</p><p>The technique for backing up a virtualhost whilst it is running depends on its + type.</p><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-BDB"></a>11.3.1. BDB</h3></div></div></div><p>Use the same backup utility described above, but use the path + <code class="literal">${QPID_WORK}/<name>/messages</code> instead.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Derby"></a>11.3.2. Derby</h3></div></div></div><p>Not yet supported</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-JDBC"></a>11.3.3. JDBC</h3></div></div></div><p>The responsibility for backup is delegated to the database server itself. See the + documentation accompanying it. Any technique that takes a consistent snapshot of the + database is acceptable.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-Provided"></a>11.3.4. Provided</h3></div></div></div><p>The contents of the virtualhost will be backed up as part of virtualhost node that + contains it.</p></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="Java-Broker-Backup-And-Recovery-Virtualhost-BDBHA"></a>11.3.5. BDB-HA</h3></div></div></div><p>The contents of the virtualhost will be backed up as part of virtualhost node that + contains it.</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-Backup-And-Recovery-Virtualhost-Node.html">Prev</a> </td><td align="center" width="20%"><a accesskey="u" href="Java-Broker-Backup-And-Recovery.html">Up</a></td><td align="right" width="40%"> <a accesskey="n" href="Java-Broker-Appendix-Environment-Variables.html">Next</a></td></tr><tr><td align="left" valign="top" width="40%">11.2. Virtualhost Node </td><td align="center" width="20%"><a accesskey="h" href="AMQP-Messaging-Broker-Java-Book.html">Home</a></td><td align="right" valign="top" width="40%"> Appendix A. Environment Variables</td></tr></table></div></div> \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
