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 : show program’s version number and exit
20 -v, --verbose : Show maximum detail
22 --limit LIMIT : Limit number of output rows. Unlimited if limit is
24 --csv : Render tabular output in csv format
26 -g, --general : Show General Router Stats
28 -c, --connections : Show Connections
30 -l, --links : Show Router Links
32 -n, --nodes : Show Router Nodes
34 -e, --edge : Show edge connections
36 -a, --address : Show Router Addresses
38 -m, --memory : Show Router Memory Stats
40 --autolinks : Show Auto Links
42 --linkroutes : Show Link Routes
44 --log : Show recent log entries
46 --all-entities : Show all router entities. Can be combined with --all-
48 --all-routers : Show entities for all routers in network. Can also be
50 -r ROUTER-ID, --router ROUTER-ID : Router to be queried
52 -d EDGE-ROUTER-ID, --edge-router EDGE-ROUTER-ID : Edge Router to be
54 queried
55 -b URL, --bus URL : URL of the messaging bus to connect to default
57 0.0.0.0
58 -t SECS, --timeout SECS : Maximum time to wait for connection in
60 seconds default 5
61 --ssl-certificate CERT : Client SSL certificate (PEM Format)
63 --ssl-key KEY : Client SSL private key (PEM Format)
65 --ssl-trustfile TRUSTED-CA-DB : Trusted Certificate Authority Database
67 file (PEM Format)
68 --ssl-password PASSWORD : Certificate password, will be prompted if not
70 specifed.
71 --ssl-password-file SSL-PASSWORD-FILE : Certificate password, will be
73 prompted if not specifed.
74 --sasl-mechanisms SASL-MECHANISMS : Allowed sasl mechanisms to be
76 supplied during the sasl handshake.
77 --sasl-username SASL-USERNAME : User name for SASL plain authentication
79 --sasl-password SASL-PASSWORD : Password for SASL plain authentication
81 --sasl-password-file SASL-PASSWORD-FILE : Password for SASL plain
83 authentication
84 --ssl-disable-peer-name-verify : Disables SSL peer name verification.
86 WARNING - This option is insecure and must not be used in production
87 environments
88
90 qdstat -g
91 Version
92 The version of Dispatch Router.
93 Mode
95 The router’s operating mode:
96 · standalone - The router operates as a single, standalone
98 network node.
99 · interior - The router operates in cooperation with other
101 interior routers in an interconnected network.
102 · edge - The router operates at the edge of the router network.
104 It maintains an uplink connection to an interior router.
105 Router Id
107 The router’s ID.
108 Uptime
110 Time this router has been up. Displayed in the
111 days:hours:minutes:seconds format.
112 Link Routes
114 The number of active and inactive link routes configured for this
115 router.
116 Auto Links
118 The number of incoming and outgoing auto links configured for this
119 router.
120 Links
122 The number of incoming and outgoing links attached to the router.
123 Nodes
125 The number of peer routers connected to this router.
126 Addresses
128 The number of addresses with links attached to this router.
129 Connections
131 The number of connections to the router. This includes connections
132 from and to any AMQP route container.
133 Presettled Count
135 The number of presettled deliveries forwarded by this router.
136 Dropped Presettled Count
138 The number of presettled deliveries that this router dropped due to
139 congestion.
140 Accepted Count
142 The number of deliveries forwarded by this router that were
143 accepted.
144 Rejected Count
146 The number of deliveries forwarded by this router that were
147 rejected.
148 Released Count
150 The number of deliveries forwarded by this router that were
151 released.
152 Modified Count
154 The number of deliveries forwarded by this router that were
155 modified.
156 Deliveries Delayed > 1sec
158 The number of deliveries forwarded by this router that were
159 unsettled for more than one second.
160 Deliveries Delayed > 10sec
162 The number of deliveries forwarded by this router that were
163 unsettled for more than ten seconds.
164 Deliveries Stuck > 10sec
166 The number of deliveries forwarded by this router that were stuck
167 for more than ten seconds.
168 Deliveries to Fallback
170 The number of deliveries that were forwarded to a fallback
171 destination.
172 Links Blocked
174 The number of links that are blocked. A blocked link is one in
175 which the available credit has remained zero for more than 10
176 seconds.
177 Ingress Count
179 The number of messages sent to this router.
180 Egress Count
182 The number of messages sent from this router.
183 Transit Count
185 The number of deliveries sent to another router in the network.
186 Deliveries from Route Container
188 The number of deliveries this router has received from AMQP route
189 containers.
190 Deliveries to Route Container
192 The number of deliveries this router has sent to AMQP route
193 containers.
194 qdstat -c
196 id
197 The connection’s unique identifier.
198 host
200 The hostname or internet address of the remotely-connected AMQP
201 container.
202 container
204 The container name of the remotely-connected AMQP container.
205 role
207 The connection’s role:
208 · normal - The normal connection from a client to a router.
210 · inter-router - The connection between routers to form a
212 network.
213 · route-container - The connection to or from a broker or other
215 host to receive link routes and waypoints.
216 · edge - The connection between an edge router and an interior
218 router.
219 dir
221 The direction in which the connection was established:
222 · in - The connection was initiated by the remote container.
224 · out - The connection was initiated by this router.
226 security
228 The security or encryption method, if any, used for this
229 connection.
230 authentication
232 The authentication method and user ID of the connection’s
233 authenticated user.
234 tenant
236 If the connection is to a listener using multi-tenancy, this column
237 displays the tenant namespace for the connection.
238 last dlv
240 Time since the last delivery arrived on this connection. Displayed
241 in the days:hours:minutes:seconds format.
242 uptime
244 Time this connection has been up. Displayed in the
245 days:hours:minutes:seconds format.
246 qdstat -l
248 type
249 The type of link:
250 · router-control - An inter-router link that is reserved for
252 control messages exchanged between routers.
253 · inter-router - An inter-router link that is used for normal
255 message-routed deliveries.
256 · endpoint - A normal link to an external endpoint container.
258 dir
260 The direction that messages flow on the link:
261 · in - Deliveries flow inbound to the router.
263 · out - Deliveries flow outbound from the router.
265 conn id
267 The unique identifier of the connection over which this link is
268 attached.
269 id
271 The unique identifier of this link.
272 peer
274 For link-routed links, the unique identifier of the peer link. In
275 link routing, an inbound link is paired with an outbound link.
276 class
278 The class of the address bound to the link:
279 · local - The address that is local to this router (temporary).
281 · topo - A topological address used for router control messages.
283 · router - A summary router address used to route messages to a
285 remote router’s local addresses.
286 · mobile - A mobile address for an attached consumer or producer.
288 · link-in - The address match for incoming routed links.
290 · link-out - The address match for outgoing routed links.
292 addr
294 The address bound to the link.
295 phs
297 The phase of the address bound to the link.
298 cap
300 The capacity, in deliveries, of the link.
301 pri
303 The priority of the link. Priority influences the order in which
304 links are processed within a connection. Higher numbers represent
305 higher priorities.
306 undel
308 The number of undelivered messages stored on the link’s FIFO.
309 unsett
311 The number of unsettled deliveries being tracked by the link.
312 deliv
314 The total number of deliveries that have transited this link.
315 presett
317 The number of pre-settled deliveries that transited this link.
318 psdrop
320 The number of pre-settled deliveries that were dropped due to
321 congestion.
322 acc
324 The number of deliveries on this link that were accepted.
325 rej
327 The number of deliveries on this link that were rejected.
328 rel
330 The number of deliveries on this link that were released.
331 mod
333 The number of deliveries on this link that were modified.
334 delay
336 The number of settled deliveries on this link that were unsettled
337 for more than one second.
338 rate
340 The average rate (over a period of five seconds) at which
341 deliveries have been settled on this link.
342 stuck
344 The number of deliveries on this link that are flagged as "stuck".
345 A delivery is considered stuck if it has been either undelivered or
346 unsettled for more than 10 seconds.
347 cred
349 The number of flow credits currently available on this link.
350 blkd
352 The time elapsed since the available credit for this link became
353 zero and has remained zero.
354 admin
356 The administrative status of the link (with -v option only):
357 · enabled - The link is enabled for normal operation.
359 · disabled - The link is disabled and should be quiescing or
361 stopped (not yet supported).
362 oper
364 The operational status of the link (with -v option only):
365 · up - The link is operational.
367 · down - The link is not attached.
369 · quiescing - The link is in the process of quiescing (not yet
371 supported).
372 · idle - The link has completed quiescing and is idle (not yet
374 supported).
375 name
377 The link name (only shown if the -v option is provided).
378 qdstat -n
380 router-id
381 The router’s ID.
382 next-hop
384 If this router is not a neighbor, this field identifies the
385 next-hop neighbor used to reach this router.
386 link
388 The ID of the link to the neighbor router.
389 cost
391 The topology cost to this remote router (with -v option only).
392 neighbors
394 The list of neighbor routers (the router’s link-state). This field
395 is available only if you specify the -v option.
396 valid-origins
398 The list of origin routers for which the best path to the listed
399 router passes through this router (available only with the -v
400 option).
401 qdstat -e
403 id
404 The connection’s unique identifier.
405 host
407 The hostname or internet address of the remotely-connected edge
408 router.
409 container
411 The container name of the remotely-connected edge router.
412 dir
414 The direction in which the connection was established:
415 · in - The connection was initiated by the edge router.
417 · out - The connection was initiated by this router.
419 security
421 The security or encryption method, if any, used for this
422 connection.
423 authentication
425 The authentication method and user ID of the connection’s
426 authenticated user.
427 tenant
429 If the connection is to a listener using multi-tenancy, this column
430 displays the tenant namespace for the connection.
431 qdstat -a
433 class
434 The class of the address:
435 · local - The address that is local to this router.
437 · topo - The topological address used for router control
439 messages.
440 · router - A summary router address used to route messages to a
442 remote router’s local addresses.
443 · mobile - A mobile address for an attached consumer or producer.
445 addr
447 The address text.
448 phs
450 For mobile addresses only, the phase of the address. Direct
451 addresses have only a phase 0. Waypoint addresses have multiple
452 phases, normally 0 and 1.
453 distrib
455 One of the following distribution methods used for this address:
456 · multicast - A copy of each message is delivered once to each
458 consumer for the address.
459 · closest - Each message is delivered to only one consumer for
461 the address. The closest (lowest cost) consumer will be chosen.
462 If there are multiple lowest-cost consumers, deliveries will be
463 spread across those consumers.
464 · balanced - Each message is delivered to only one consumer for
466 the address. The consumer with the fewest outstanding
467 (unsettled) deliveries will be chosen. The cost of the route to
468 the consumer is a threshold for delivery (that is, higher cost
469 consumers will only receive deliveries if closer consumers are
470 backed up).
471 · flood - Used only for router-control traffic. This is multicast
473 without the prevention of duplicate deliveries.
474 pri
476 The priority of the address. If the address prefix/pattern is
477 configured with a priority, that priority will appear in this
478 column. Messages for addresses configured with a priority will be
479 forwarded according to the address’s priority.
480 in-proc
482 The number of in-process consumers for this address.
483 local
485 For this router, the number of local consumers for this address, or
486 for link-routed addresses, the number of locally-attached
487 containers that are destinations for this address.
488 remote
490 The number of remote routers that have at least one consumer for
491 this address.
492 in
494 The number of deliveries for this address that entered the network
495 on this router.
496 out
498 The number of deliveries for this address that exited the network
499 on this router.
500 thru
502 The number of deliveries for this address that were forwarded to
503 other routers.
504 to-proc
506 The number of deliveries for this address that were delivered to an
507 in-process consumer.
508 from-proc
510 The number of deliveries for this address that were received from
511 an in-process producer.
512 qdstat --linkroutes
514 prefix
515 The address prefix of the link route.
516 dir
518 The direction of matching links (from this router’s perspective).
519 distrib
521 The distribution method used for routed links. This value should
522 always be linkBalanced, which is the only supported distribution
523 for routed links.
524 status
526 The operational status of the link route:
527 · active - The route is actively routing attaches (it is ready
529 for use).
530 · inactive - The route is inactive, because no local destination
532 is connected.
533 qdstat --autolinks
535 addr
536 The auto link’s address.
537 dir
539 The direction that messages flow over the auto link:
540 · in - Messages flow in from the route-container to the router
542 network.
543 · out - Messages flow out to the route-container from the router
545 network.
546 phs
548 The address phase for this auto link.
549 link
551 The ID of the link managed by this auto link.
552 status
554 The operational status of this auto link:
555 · inactive - There is no connected container for this auto link.
557 · attaching - The link is attaching to the container.
559 · failed - The link-attach failed.
561 · active - The link is operational.
563 · quiescing - The link is quiescing (not yet supported).
565 · idle - The link is idle (not yet supported).
567 lastErr
569 The description of the last attach failure that occurred on this
570 auto link.
571
573 qdrouterd(8), qdmanage(8), qdrouterd.conf(5)
574 http://qpid.apache.org/components/dispatch-router
576 04/13/2020 QDSTAT(8)