1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282
|
HELP = {
'exchange-auto-delete':
'If yes, the exchange will delete itself after at least one queue or exchange has been bound to this one, and then all queues or exchanges have been unbound.',
'exchange-internal':
'If yes, clients cannot publish to this exchange directly. It can only be used with exchange to exchange bindings.',
'exchange-alternate':
'If messages to this exchange cannot otherwise be routed, send them to the alternate exchange named here.<br/>(Sets the "<a target="_blank" href="http://rabbitmq.com/ae.html">alternate-exchange</a>" argument.)',
'queue-message-ttl':
'How long a message published to a queue can live before it is discarded (milliseconds).<br/>(Sets the "<a target="_blank" href="http://rabbitmq.com/ttl.html#per-queue-message-ttl">x-message-ttl</a>" argument.)',
'queue-expires':
'How long a queue can be unused for before it is automatically deleted (milliseconds).<br/>(Sets the "<a target="_blank" href="http://rabbitmq.com/ttl.html#queue-ttl">x-expires</a>" argument.)',
'queue-max-length':
'How many (ready) messages a queue can contain before it starts to drop them from its head.<br/>(Sets the "<a target="_blank" href="http://rabbitmq.com/maxlength.html">x-max-length</a>" argument.)',
'queue-auto-delete':
'If yes, the queue will delete itself after at least one consumer has connected, and then all consumers have disconnected.',
'queue-dead-letter-exchange':
'Optional name of an exchange to which messages will be republished if they are rejected or expire.<br/>(Sets the "<a target="_blank" href="http://rabbitmq.com/dlx.html">x-dead-letter-exchange</a>" argument.)',
'queue-dead-letter-routing-key':
'Optional replacement routing key to use when a message is dead-lettered. If this is not set, the message\'s original routing key will be used.<br/>(Sets the "<a target="_blank" href="http://rabbitmq.com/dlx.html">x-dead-letter-routing-key</a>" argument.)',
'queue-memory-resident':
'<p>Number of messages in the queue which are held in memory. These messages may also be on disc (if they are persistent).</p><p>There may be a limit imposed in order to manage total memory use. If the number of memory-resident messages in the queue exceeds the limit some messages will be paged out.</p>',
'queue-persistent':
'Number of messages in the queue which are persistent. These messages will be on disc but may also be available in memory. Note that if a message is published as persistent but routed to a transient queue it is not considered persistent by that queue, so transient queues will always report 0 persistent messages.',
'queue-consumer-utilisation':
'Fraction of the time that the queue is able to immediately deliver messages to consumers. If this number is less than 100% you may be able to deliver messages faster if: \
<ul> \
<li>There were more consumers or</li> \
<li>The consumers were faster or</li> \
<li>The consumers had a higher prefetch count</li> \
</ul>',
'internal-users-only':
'Only users within the internal RabbitMQ database are shown here. Other users (e.g. those authenticated over LDAP) will not appear.',
'export-definitions':
'The definitions consist of users, virtual hosts, permissions, parameters, exchanges, queues and bindings. They do not include the contents of queues or the cluster name. Exclusive queues will not be exported.',
'import-definitions':
'The definitions that are imported will be merged with the current definitions. If an error occurs during import, any changes made will not be rolled back.',
'exchange-rates-incoming':
'The incoming rate is the rate at which messages are published directly to this exchange.',
'exchange-rates-outgoing':
'The outgoing rate is the rate at which messages enter queues, having been published directly to this exchange.',
'channel-mode':
'Channel guarantee mode. Can be one of the following, or neither:<br/> \
<dl> \
<dt><acronym title="Confirm">C</acronym> – <a target="_blank" href="http://www.rabbitmq.com/confirms.html">confirm</a></dt> \
<dd>Channel will send streaming publish confirmations.</dd> \
<dt><acronym title="Transactional">T</acronym> – <a target="_blank" href="http://www.rabbitmq.com/amqp-0-9-1-reference.html#class.tx">transactional</a></dt> \
<dd>Channel is transactional.</dd> \
</dl>',
'channel-prefetch':
'Channel prefetch counts. \
<p> \
Each channel can have two prefetch counts: A per-consumer count, which \
will limit each new consumer created on the channel, and a global \
count, which is shared between all consumers on the channel.\
</p> \
<p> \
This column shows one, the other, or both limits if they are set. \
</p>',
'file-descriptors':
'<p>File descriptor count and limit, as reported by the operating \
system. The count includes network sockets and file handles.</p> \
<p>To optimize disk access RabbitMQ uses as many free descriptors as are \
available, so the count may safely approach the limit. \
However, if most of the file descriptors are used by sockets then \
persister performance will be negatively impacted.</p> \
<p>To change the limit on Unix / Linux, use "ulimit -n". To change \
the limit on Windows, set the ERL_MAX_PORTS environment variable</p> \
<p>To report used file handles on Windows, handle.exe from \
sysinternals must be installed in your path. You can download it \
<a target="_blank" href="http://technet.microsoft.com/en-us/sysinternals/bb896655">here</a>.</p>',
'socket-descriptors':
'The network sockets count and limit managed by RabbitMQ.<br/> \
When the limit is exhausted RabbitMQ will stop accepting new \
network connections.',
'memory-alarm':
'<p>The <a target="_blank" href="http://www.rabbitmq.com/memory.html#memsup">memory \
alarm</a> for this node has gone off. It will block \
incoming network traffic until the memory usage drops below \
the watermark.</p>\
<p>Note that the pale line in this case indicates the high watermark \
in relation to how much memory is used in total. </p>',
'disk-free-alarm':
'The <a target="_blank" href="http://www.rabbitmq.com/memory.html#diskfreesup">disk \
free space alarm</a> for this node has gone off. It will block \
incoming network traffic until the amount of free space exceeds \
the limit.',
'message-get-requeue':
'<p>Clicking "Get Message(s)" will consume messages from the queue. \
If requeue is set the message will be put back into the queue in place, \
but "redelivered" will be set on the message.</p> \
<p>If requeue is not set messages will be removed from the queue.</p> \
<p>Furthermore, message payloads will be truncated to 50000 bytes.</p>',
'message-publish-headers':
'Headers can have any name. Only long string headers can be set here.',
'message-publish-properties':
'<p>You can set other message properties here (delivery mode and headers \
are pulled out as the most common cases).</p>\
<p>Invalid properties will be ignored. Valid properties are:</p>\
<ul>\
<li>content_type</li>\
<li>content_encoding</li>\
<li>priority</li>\
<li>correlation_id</li>\
<li>reply_to</li>\
<li>expiration</li>\
<li>message_id</li>\
<li>timestamp</li>\
<li>type</li>\
<li>user_id</li>\
<li>app_id</li>\
<li>cluster_id</li>\
</ul>',
'string-base64':
'<p>AMQP message payloads can contain any binary content. They can \
therefore be difficult to display in a browser. The options here \
have the following meanings:</p> \
<dl> \
<dt>Auto string / base64</dt> \
<dd>If the message payload can be interpreted as a string in UTF-8 \
encoding, do so. Otherwise return the payload encoded as \
base64.</dd> \
<dt>base64</dt> \
<dd>Return the payload encoded as base64 unconditionally.</dd> \
</dl>',
'user-tags':
'Comma-separated list of tags to apply to the user. Currently \
<a target="_blank" href="http://www.rabbitmq.com/management.html#permissions">supported \
by the management plugin</a>: \
<dl> \
<dt>management</dt> \
<dd> \
User can access the management plugin \
</dd> \
<dt>policymaker</dt> \
<dd> \
User can access the management plugin and manage policies and \
parameters for the vhosts they have access to. \
</dd> \
<dt>monitoring</dt> \
<dd> \
User can access the management plugin and see all connections and \
channels as well as node-related information. \
</dd> \
<dt>administrator</dt> \
<dd> \
User can do everything monitoring can do, manage users, \
vhosts and permissions, close other user\'s connections, and manage \
policies and parameters for all vhosts. \
</dd> \
</dl> \
<p> \
Note that you can set any tag here; the links for the above four \
tags are just for convenience. \
</p>',
'queued-messages':
'<dl> \
<dt>Ready</dt>\
<dd>Number of messages that are available to be delivered now.</dd>\
<dt>Unacknowledged</dt>\
<dd>Number of messages for which the server is waiting for acknowledgement.</dd>\
<dt>Total</dt>\
<dd>The total of these two numbers.</dd>\
</dl>\
Note that the rate of change of total queued messages does \
<b>not</b> include messages removed due to queue deletion.',
'message-rates':
'Only rates for which some activity is taking place will be shown.\
<dl>\
<dt>Publish</dt>\
<dd>Rate at which messages are entering the server.</dd>\
<dt>Confirm</dt>\
<dd>Rate at which the server is confirming publishes.</dd>\
<dt>Deliver</dt>\
<dd>Rate at which messages requiring acknowledgement are being delivered in response to basic.consume.</dd>\
<dt>Deliver (noack)</dt>\
<dd>Rate at which messages not requiring acknowledgement are being delivered in response to basic.consume.</dd>\
<dt>Get</dt>\
<dd>Rate at which messages requiring acknowledgement are being delivered in response to basic.get.</dd>\
<dt>Get (noack)</dt>\
<dd>Rate at which messages not requiring acknowledgement are being delivered in response to basic.get.</dd>\
<dt>Acknowledge</dt>\
<dd>Rate at which messages are being acknowledged.</dd>\
<dt>Redelivered</dt>\
<dd>Rate at which messages with the \'redelivered\' flag set are being delivered. Note that these messages will <b>also</b> be counted in one of the delivery rates above.</dd>\
<dt>Return</dt>\
<dd>Rate at which basic.return is sent to publishers for unroutable messages published with the \'mandatory\' flag set.</dd>\
</dl>',
'disk-monitoring-no-watermark' : 'There is no <a target="_blank" href="http://www.rabbitmq.com/memory.html#diskfreesup">disk space low watermark</a> set. RabbitMQ will not take any action to avoid running out of disk space.',
'resource-counts' : 'Shows total number of objects for all virtual hosts the current user has access to.',
'memory-use' : '<p>Note that the memory details shown here are only updated on request - they could be too expensive to calculate every few seconds on a busy server.</p><p><a target="_blank" href="http://www.rabbitmq.com/memory-use.html">Read more</a> on memory use.</p>',
'policy-definitions' : '<dl>\
<dt><code>ha-mode</code></dt>\
<dd>\
One of <code>all</code>, <code>exactly</code>\
or <code>nodes</code>.\
</dd>\
<dt><code>ha-params</code></dt>\
<dd>\
Absent if <code>ha-mode</code> is <code>all</code>, a number\
if <code>ha-mode</code> is <code>exactly</code>, or a list\
of strings if <code>ha-mode</code> is <code>nodes</code>.\
</dd>\
<dt><code>ha-sync-mode</code></dt>\
<dd>\
One of <code>manual</code> or <code>automatic</code>.\
</dd>\
<dt><code>alternate-exchange</code></dt>\
<dd>\
The name of an alternate exchange.\
</dd>\
<dt><code>dead-letter-exchange</code></dt>\
<dd>\
The name of a dead letter exchange.\
</dd>\
<dt><code>dead-letter-routing-key</code></dt>\
<dd>\
Key to use when dead-lettering.\
</dd>\
<dt><code>message-ttl</code></dt>\
<dd>\
Per-queue message TTL, in milliseconds.\
</dd>\
<dt><code>expires</code></dt>\
<dd>\
Queue TTL, in milliseconds.\
</dd>\
<dt><code>max-length</code></dt>\
<dd>\
Maximum queue length, in messages.\
</dd>\
<dt><code>federation-upstream-set</code></dt>\
<dd>\
A string; only if the federation plugin is enabled.\
</dd>\
</dl>',
'handle-exe' : 'In order to monitor the number of file descriptors in use on Windows, RabbitMQ needs the <a href="http://technet.microsoft.com/en-us/sysinternals/bb896655" target="_blank">handle.exe command line tool from Microsoft</a>. Download it and place it in the path (e.g. in C:\Windows).',
'filter-regex' :
'Whether to enable regular expression matching. Both string literals \
and regular expressions are matched in a case-insensitive manner.<br/></br/> \
(<a href="https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Regular_Expressions" target="_blank">Regular expression reference</a>)',
'foo': 'foo' // No comma.
};
function help(id) {
show_popup('help', HELP[id]);
}
|