1QDSTAT(8) QDSTAT(8)
2
6 qdstat - show status and statistics for a running 'qdrouterd'
7
9 qdstat [OPTIONS]
10
12 An AMQP monitoring tool that shows status information about networks of
13 Dispatch routers. It can display connections, network nodes and links,
14 and router stats such as memory use.
15
17 -h, --help : show this help message and exit
18 --version : Print version and exit.
20 -g, --general : Show General Router Stats
22 -c, --connections : Show Connections
24 -l, --links : Show Router Links
26 -n, --nodes : Show Router Nodes
28 -e, --edge : Show edge connections
30 -a, --address : Show Router Addresses
32 -m, --memory : Show Router Memory Stats
34 --autolinks : Show Auto Links
36 --linkroutes : Show Link Routes
38 -v, --verbose : Show maximum detail
40 --log : Show recent log entries
42 --limit=LIMIT : Limit number of output rows
44 Connection Options
46 -b URL, --bus=URL : URL of the messaging bus to connect to (default
47 -r ROUTER-ID, --router=ROUTER-ID : Router to be queried
49 -t SECS, --timeout=SECS : Maximum time to wait for connection in
51 seconds (default 5)
52 --ssl-certificate=CERT : Client SSL certificate (PEM Format)
54 --ssl-key=KEY : Client SSL private key (PEM Format)
56 --ssl-trustfile=TRUSTED-CA-DB : Trusted Certificate Authority Database
58 file (PEM Format)
59 --ssl-password=PASSWORD : Certificate password, will be prompted if not
61 specifed.
62 --ssl-password-file=SSL-PASSWORD-FILE : Certificate password, will be
64 prompted if not specifed.
65 --sasl-mechanisms=SASL-MECHANISMS : Allowed sasl mechanisms to be
67 supplied during the sasl handshake.
68 --sasl-username=SASL-USERNAME : User name for SASL plain authentication
70 --sasl-password=SASL-PASSWORD : Password for SASL plain authentication
72 --sasl-password-file=SASL-PASSWORD-FILE : Password for SASL plain
74 authentication
75 --ssl-disable-peer-name-verify : Disables SSL peer name verification.
77 WARNING - This option is insecure and must not be used in production
78 environments
79
81 qdstat -c
82 id
83 The connection’s unique identifier.
84 host
86 The hostname or internet address of the remotely-connected AMQP
87 container.
88 container
90 The container name of the remotely-connected AMQP container.
91 role
93 The connection’s role:
94 · normal - The normal connection from a client to a router.
96 · inter-router - The connection between routers to form a
98 network.
99 · route-container - The connection to or from a broker or other
101 host to receive link routes and waypoints.
102 dir
104 The direction in which the connection was established:
105 · in - The connection was initiated by the remote container.
107 · out - The connection was initiated by this router.
109 security
111 The security or encryption method, if any, used for this
112 connection.
113 authentication
115 The authentication method and user ID of the connection’s
116 authenticated user.
117 tenant
119 If the connection is to a listener using multi-tenancy, this column
120 displays the tenant namespace for the connection.
121 qdstat -l
123 type
124 The type of link:
125 · router-control - An inter-router link that is reserved for
127 control messages exchanged between routers.
128 · inter-router - An inter-router link that is used for normal
130 message-routed deliveries.
131 · endpoint - A normal link to an external endpoint container.
133 dir
135 The direction that messages flow on the link:
136 · in - Deliveries flow inbound to the router.
138 · out - Deliveries flow outbound from the router.
140 conn id
142 The unique identifier of the connection over which this link is
143 attached.
144 id
146 The unique identifier of this link.
147 peer
149 For link-routed links, the unique identifier of the peer link. In
150 link routing, an inbound link is paired with an outbound link.
151 class
153 The class of the address bound to the link:
154 · local - The address that is local to this router (temporary).
156 · topo - A topological address used for router control messages.
158 · router - A summary router address used to route messages to a
160 remote router’s local addresses.
161 · mobile - A mobile address for an attached consumer or producer.
163 · link-in - The address match for incoming routed links.
165 · link-out - The address match for outgoing routed links.
167 addr
169 The address bound to the link.
170 phs
172 The phase of the address bound to the link.
173 cap
175 The capacity, in deliveries, of the link.
176 pri
178 The priority of the link. Priority influences the order in which
179 links are processed within a connection. Higher numbers represent
180 higher priorities.
181 undel
183 The number of undelivered messages stored on the link’s FIFO.
184 unsett
186 The number of unsettled deliveries being tracked by the link.
187 del
189 The total number of deliveries that have transited this link.
190 presett
192 The number of pre-settled deliveries that transited this link.
193 psdrop
195 The number of pre-settled deliveries that were dropped due to
196 congestion.
197 acc
199 The number of deliveries on this link that were accepted.
200 rej
202 The number of deliveries on this link that were rejected.
203 rel
205 The number of deliveries on this link that were released.
206 mod
208 The number of deliveries on this link that were modified.
209 delay
211 The number of settled deliveries on this link that were unsettled
212 for more than one second.
213 rate
215 The average rate (over a period of five seconds) at which
216 deliveries have been settled on this link.
217 admin
219 The administrative status of the link:
220 · enabled - The link is enabled for normal operation.
222 · disabled - The link is disabled and should be quiescing or
224 stopped (not yet supported).
225 oper
227 The operational status of the link:
228 · up - The link is operational.
230 · down - The link is not attached.
232 · quiescing - The link is in the process of quiescing (not yet
234 supported).
235 · idle - The link has completed quiescing and is idle (not yet
237 supported).
238 name
240 The link name (only shown if the -v option is provided).
241 qdstat -n
243 router-id
244 The router’s ID.
245 next-hop
247 If this router is not a neighbor, this field identifies the
248 next-hop neighbor used to reach this router.
249 link
251 The ID of the link to the neighbor router.
252 cost
254 The topology cost to this remote router (with -v option only).
255 neighbors
257 The list of neighbor routers (the router’s link-state). This
258 field is available only if you specify the -v option.
259 valid-origins
261 The list of origin routers for which the best path to the
262 listed router passes through this router (available only with
263 the -v option).
264 qdstat -a
266 class
267 The class of the address:
268 · local - The address that is local to this router.
270 · topo - The topological address used for router control
272 messages.
273 · router - A summary router address used to route messages to a
275 remote router’s local addresses.
276 · mobile - A mobile address for an attached consumer or producer.
278 addr
280 The address text.
281 phs
283 For mobile addresses only, the phase of the address. Direct
284 addresses have only a phase 0. Waypoint addresses have multiple
285 phases, normally 0 and 1.
286 distrib
288 One of the following distribution methods used for this address:
289 · multicast - A copy of each message is delivered once to each
291 consumer for the address.
292 · closest - Each message is delivered to only one consumer for
294 the address. The closest (lowest cost) consumer will be chosen.
295 If there are multiple lowest-cost consumers, deliveries will be
296 spread across those consumers.
297 · balanced - Each message is delivered to only one consumer for
299 the address. The consumer with the fewest outstanding
300 (unsettled) deliveries will be chosen. The cost of the route to
301 the consumer is a threshold for delivery (that is, higher cost
302 consumers will only receive deliveries if closer consumers are
303 backed up).
304 · flood - Used only for router-control traffic. This is multicast
306 without the prevention of duplicate deliveries.
307 pri
309 The priority of the address. If the address prefix/pattern is
310 configured with a priority, that priority will appear in this
311 column. Messages for addresses configured with a priority will be
312 forwarded according to the address’s priority.
313 in-proc
315 The number of in-process consumers for this address.
316 local
318 For this router, the number of local consumers for this address, or
319 for link-routed addresses, the number of locally-attached
320 containers that are destinations for this address.
321 remote
323 The number of remote routers that have at least one consumer for
324 this address.
325 in
327 The number of deliveries for this address that entered the network
328 on this router.
329 out
331 The number of deliveries for this address that exited the network
332 on this router.
333 thru
335 The number of deliveries for this address that were forwarded to
336 other routers.
337 to-proc
339 The number of deliveries for this address that were delivered to an
340 in-process consumer.
341 from-proc
343 The number of deliveries for this address that were received from
344 an in-process producer.
345 qdstat --linkroutes
347 prefix
348 The address prefix of the link route.
349 dir
351 The direction of matching links (from this router’s perspective).
352 distrib
354 The distribution method used for routed links. This value should
355 always be linkBalanced, which is the only supported distribution
356 for routed links.
357 status
359 The operational status of the link route:
360 · active - The route is actively routing attaches (it is ready
362 for use).
363 · inactive - The route is inactive, because no local destination
365 is connected.
366 qstat --autolinks
368 addr
369 The auto link’s address.
370 dir
372 The direction that messages flow over the auto link:
373 · in - Messages flow in from the route-container to the router
375 network.
376 · out - Messages flow out to the route-container from the router
378 network.
379 phs
381 The address phase for this auto link.
382 link
384 The ID of the link managed by this auto link.
385 status
387 The operational status of this auto link:
388 · inactive - There is no connected container for this auto link.
390 · attaching - The link is attaching to the container.
392 · failed - The link-attach failed.
394 · active - The link is operational.
396 · quiescing - The link is quiescing (not yet supported).
398 · idle - The link is idle (not yet supported).
400 lastErr
402 The description of the last attach failure that occurred on this
403 auto link.
404
406 qdrouterd(8), qdmanage(8), qdrouterd.conf(5)
407 http://qpid.apache.org/components/dispatch-router
409 05/14/2019 QDSTAT(8)