Skip to content

Commit 9d8a537

Browse files
committed
HTTP API: document disable_stats and enable_queue_totals
Using GET /api/queues?disable_stats=true&enable_queue_totals=true is far more efficient than the standard GET /api/queues and in many cases will suffice for monitoring and operating purposes.
1 parent a17cdbe commit 9d8a537

File tree

1 file changed

+90
-1
lines changed

1 file changed

+90
-1
lines changed

deps/rabbitmq_management/priv/www/api/index.html

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,13 @@ <h2>Introduction</h2>
5656
with the <code>columns</code> parameter. This is a comma-separated
5757
list of subfields separated by dots. See the example below.</p>
5858

59+
<p> It is possible to disable the statistics in the GET requests
60+
and obtain just the basic information of every object. This reduces
61+
considerably the amount of data returned and the memory and resource
62+
consumption of each query in the system. For some monitoring and operation
63+
purposes, these queries are more appropiate. The query string parameter
64+
<code>disable_stats</code> set to <code>true</code> will achieve this.</p>
65+
5966
<p>Most of the GET queries return many fields per
6067
object. The second part of this guide covers those.</p>
6168

@@ -478,7 +485,10 @@ <h2>Reference</h2>
478485
<td></td>
479486
<td></td>
480487
<td class="path">/api/queues</td>
481-
<td>A list of all queues. Use <a href="#pagination">pagination parameters</a> to filter queues.</td>
488+
<td>A list of all queues. Use <a href="#pagination">pagination parameters</a> to filter queues.
489+
The parameter <code>enable_queue_totals</code> can be used in combination with the
490+
<code>disable_stats</code> parameter to return a reduced set of fields.
491+
</td>
482492
</tr>
483493
<tr>
484494
<td>X</td>
@@ -2158,6 +2168,85 @@ <h2>/api/exchanges/(vhost)/(name)</h2>
21582168
</table>
21592169

21602170
<h2>/api/queues</h2>
2171+
2172+
When using the query parameters combination of <code>disable_stats</code> and
2173+
<code>enable_queue_totals</code> this query returns the following fields:
2174+
2175+
<table>
2176+
<tr>
2177+
<td><code>name</code></td>
2178+
<td>
2179+
The name of the queue.
2180+
</td>
2181+
</tr>
2182+
<tr>
2183+
<td><code>vhost</code></td>
2184+
<td>
2185+
The name of the virtual host.
2186+
</td>
2187+
</tr>
2188+
<tr>
2189+
<td><code>type</code></td>
2190+
<td>
2191+
The type of the queue.
2192+
</td>
2193+
</tr>
2194+
<tr>
2195+
<td><code>node</code></td>
2196+
<td>
2197+
Depending on the type of the queue, this is the node which holds the queue or hosts the leader.
2198+
</td>
2199+
</tr>
2200+
<tr>
2201+
<td><code>state</code></td>
2202+
<td>
2203+
The status of the queue.
2204+
</td>
2205+
</tr>
2206+
<tr>
2207+
<td><code>arguments</code></td>
2208+
<td>
2209+
The arguments of the queue.
2210+
</td>
2211+
</tr>
2212+
<tr>
2213+
<td><code>auto_delete</code></td>
2214+
<td>
2215+
The value of the <code>auto_delete</code> argument.
2216+
</td>
2217+
</tr>
2218+
<tr>
2219+
<td><code>durable</code></td>
2220+
<td>
2221+
The value of the <code>durable</code> argument.
2222+
</td>
2223+
</tr>
2224+
<tr>
2225+
<td><code>exclusive</code></td>
2226+
<td>
2227+
The value of the <code>exclusive</code> argument.
2228+
</td>
2229+
</tr>
2230+
<tr>
2231+
<td><code>messages</code></td>
2232+
<td>
2233+
The total number of messages in the queue.
2234+
</td>
2235+
</tr>
2236+
<tr>
2237+
<td><code>messages_ready</code></td>
2238+
<td>
2239+
The number of messages ready to be delivered in the queue.
2240+
</td>
2241+
</tr>
2242+
<tr>
2243+
<td><code>messages_unacknowledged</code></td>
2244+
<td>
2245+
The number of messages waiting for acknowledgement in the queue.
2246+
</td>
2247+
</tr>
2248+
</table>
2249+
21612250
<h2>/api/queues/(vhost)</h2>
21622251

21632252
<p>

0 commit comments

Comments
 (0)