@@ -56,6 +56,13 @@ <h2>Introduction</h2>
56
56
with the < code > columns</ code > parameter. This is a comma-separated
57
57
list of subfields separated by dots. See the example below.</ p >
58
58
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
+
59
66
< p > Most of the GET queries return many fields per
60
67
object. The second part of this guide covers those.</ p >
61
68
@@ -478,7 +485,12 @@ <h2>Reference</h2>
478
485
< td > </ td >
479
486
< td > </ td >
480
487
< 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=true</ code > can be used in combination with the
490
+ < code > disable_stats=true</ code > parameter to return a reduced set of fields and significantly
491
+ reduce the amount of data returned by this endpoint. That in turn can significantly reduce
492
+ CPU and bandwidth footprint of such requests.
493
+ </ td >
482
494
</ tr >
483
495
< tr >
484
496
< td > X</ td >
@@ -2158,6 +2170,85 @@ <h2>/api/exchanges/(vhost)/(name)</h2>
2158
2170
</ table >
2159
2171
2160
2172
< h2 > /api/queues</ h2 >
2173
+
2174
+ When using the query parameters combination of < code > disable_stats</ code > and
2175
+ < code > enable_queue_totals</ code > this query returns the following fields:
2176
+
2177
+ < table >
2178
+ < tr >
2179
+ < td > < code > name</ code > </ td >
2180
+ < td >
2181
+ The name of the queue.
2182
+ </ td >
2183
+ </ tr >
2184
+ < tr >
2185
+ < td > < code > vhost</ code > </ td >
2186
+ < td >
2187
+ The name of the virtual host.
2188
+ </ td >
2189
+ </ tr >
2190
+ < tr >
2191
+ < td > < code > type</ code > </ td >
2192
+ < td >
2193
+ The type of the queue.
2194
+ </ td >
2195
+ </ tr >
2196
+ < tr >
2197
+ < td > < code > node</ code > </ td >
2198
+ < td >
2199
+ Depending on the type of the queue, this is the node which holds the queue or hosts the leader.
2200
+ </ td >
2201
+ </ tr >
2202
+ < tr >
2203
+ < td > < code > state</ code > </ td >
2204
+ < td >
2205
+ The status of the queue.
2206
+ </ td >
2207
+ </ tr >
2208
+ < tr >
2209
+ < td > < code > arguments</ code > </ td >
2210
+ < td >
2211
+ The arguments of the queue.
2212
+ </ td >
2213
+ </ tr >
2214
+ < tr >
2215
+ < td > < code > auto_delete</ code > </ td >
2216
+ < td >
2217
+ The value of the < code > auto_delete</ code > argument.
2218
+ </ td >
2219
+ </ tr >
2220
+ < tr >
2221
+ < td > < code > durable</ code > </ td >
2222
+ < td >
2223
+ The value of the < code > durable</ code > argument.
2224
+ </ td >
2225
+ </ tr >
2226
+ < tr >
2227
+ < td > < code > exclusive</ code > </ td >
2228
+ < td >
2229
+ The value of the < code > exclusive</ code > argument.
2230
+ </ td >
2231
+ </ tr >
2232
+ < tr >
2233
+ < td > < code > messages</ code > </ td >
2234
+ < td >
2235
+ The total number of messages in the queue.
2236
+ </ td >
2237
+ </ tr >
2238
+ < tr >
2239
+ < td > < code > messages_ready</ code > </ td >
2240
+ < td >
2241
+ The number of messages ready to be delivered in the queue.
2242
+ </ td >
2243
+ </ tr >
2244
+ < tr >
2245
+ < td > < code > messages_unacknowledged</ code > </ td >
2246
+ < td >
2247
+ The number of messages waiting for acknowledgement in the queue.
2248
+ </ td >
2249
+ </ tr >
2250
+ </ table >
2251
+
2161
2252
< h2 > /api/queues/(vhost)</ h2 >
2162
2253
2163
2254
< p >
0 commit comments