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 policy, 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 -p, --policy : Show Router Policy
42 --autolinks : Show Auto Links
44 --linkroutes : Show Link Routes
46 --vhosts : Show Vhosts
48 --vhostgroups : Show Vhost Groups
50 --vhoststats : Show Vhost Stats
52 --log : Show recent log entries
54 --all-entities : Show all router entities. Can be combined with --all-
56 --all-routers : Show entities for all routers in network. Can also be
58 -r ROUTER-ID, --router ROUTER-ID : Router to be queried
60 -d EDGE-ROUTER-ID, --edge-router EDGE-ROUTER-ID : Edge Router to be
62 queried
63 -b URL, --bus URL : URL of the messaging bus to connect to default
65 0.0.0.0
66 -t SECS, --timeout SECS : Maximum time to wait for connection in
68 seconds default 5
69 --ssl-certificate CERT : Client SSL certificate (PEM Format)
71 --ssl-key KEY : Client SSL private key (PEM Format)
73 --ssl-trustfile TRUSTED-CA-DB : Trusted Certificate Authority Database
75 file (PEM Format)
76 --ssl-password PASSWORD : Certificate password, will be prompted if not
78 specifed.
79 --ssl-password-file SSL-PASSWORD-FILE : Certificate password, will be
81 prompted if not specifed.
82 --sasl-mechanisms SASL-MECHANISMS : Allowed sasl mechanisms to be
84 supplied during the sasl handshake.
85 --sasl-username SASL-USERNAME : User name for SASL plain authentication
87 --sasl-password SASL-PASSWORD : Password for SASL plain authentication
89 --sasl-password-file SASL-PASSWORD-FILE : Password for SASL plain
91 authentication
92 --ssl-disable-peer-name-verify : Disables SSL peer name verification.
94 WARNING - This option is insecure and must not be used in production
95 environments
96
98 qdstat -g
99 Version
100 The version of Dispatch Router.
101 Mode
103 The router’s operating mode:
104 • standalone - The router operates as a single, standalone
106 network node.
107 • interior - The router operates in cooperation with other
109 interior routers in an interconnected network.
110 • edge - The router operates at the edge of the router network.
112 It maintains an uplink connection to an interior router.
113 Router Id
115 The router’s ID.
116 Uptime
118 Time this router has been up. Displayed in the
119 days:hours:minutes:seconds format.
120 Link Routes
122 The number of active and inactive link routes configured for this
123 router.
124 Auto Links
126 The number of incoming and outgoing auto links configured for this
127 router.
128 Links
130 The number of incoming and outgoing links attached to the router.
131 Nodes
133 The number of peer routers connected to this router.
134 Addresses
136 The number of addresses with links attached to this router.
137 Connections
139 The number of connections to the router. This includes connections
140 from and to any AMQP route container.
141 Presettled Count
143 The number of presettled deliveries forwarded by this router.
144 Dropped Presettled Count
146 The number of presettled deliveries that this router dropped due to
147 congestion.
148 Accepted Count
150 The number of deliveries forwarded by this router that were
151 accepted.
152 Rejected Count
154 The number of deliveries forwarded by this router that were
155 rejected.
156 Released Count
158 The number of deliveries forwarded by this router that were
159 released.
160 Modified Count
162 The number of deliveries forwarded by this router that were
163 modified.
164 Deliveries Delayed > 1sec
166 The number of deliveries forwarded by this router that were
167 unsettled for more than one second.
168 Deliveries Delayed > 10sec
170 The number of deliveries forwarded by this router that were
171 unsettled for more than ten seconds.
172 Deliveries Stuck > 10sec
174 The number of deliveries forwarded by this router that were stuck
175 for more than ten seconds.
176 Deliveries to Fallback
178 The number of deliveries that were forwarded to a fallback
179 destination.
180 Links Blocked
182 The number of links that are blocked. A blocked link is one in
183 which the available credit has remained zero for more than 10
184 seconds.
185 Ingress Count
187 The number of messages sent to this router.
188 Egress Count
190 The number of messages sent from this router.
191 Transit Count
193 The number of deliveries sent to another router in the network.
194 Deliveries from Route Container
196 The number of deliveries this router has received from AMQP route
197 containers.
198 Deliveries to Route Container
200 The number of deliveries this router has sent to AMQP route
201 containers.
202 qdstat -c
204 id
205 The connection’s unique identifier.
206 host
208 The hostname or internet address of the remotely-connected AMQP
209 container.
210 container
212 The container name of the remotely-connected AMQP container.
213 role
215 The connection’s role:
216 • normal - The normal connection from a client to a router.
218 • inter-router - The connection between routers to form a
220 network.
221 • route-container - The connection to or from a broker or other
223 host to receive link routes and waypoints.
224 • edge - The connection between an edge router and an interior
226 router.
227 dir
229 The direction in which the connection was established:
230 • in - The connection was initiated by the remote container.
232 • out - The connection was initiated by this router.
234 security
236 The security or encryption method, if any, used for this
237 connection.
238 authentication
240 The authentication method and user ID of the connection’s
241 authenticated user.
242 tenant
244 If the connection is to a listener using multi-tenancy, this column
245 displays the tenant namespace for the connection.
246 last dlv
248 Time since the last delivery arrived on this connection. Displayed
249 in the days:hours:minutes:seconds format.
250 uptime
252 Time this connection has been up. Displayed in the
253 days:hours:minutes:seconds format.
254 qdstat -l
256 type
257 The type of link:
258 • router-control - An inter-router link that is reserved for
260 control messages exchanged between routers.
261 • inter-router - An inter-router link that is used for normal
263 message-routed deliveries.
264 • endpoint - A normal link to an external endpoint container.
266 dir
268 The direction that messages flow on the link:
269 • in - Deliveries flow inbound to the router.
271 • out - Deliveries flow outbound from the router.
273 conn id
275 The unique identifier of the connection over which this link is
276 attached.
277 id
279 The unique identifier of this link.
280 peer
282 For link-routed links, the unique identifier of the peer link. In
283 link routing, an inbound link is paired with an outbound link.
284 class
286 The class of the address bound to the link:
287 • local - The address that is local to this router (temporary).
289 • topo - A topological address used for router control messages.
291 • router - A summary router address used to route messages to a
293 remote router’s local addresses.
294 • mobile - A mobile address for an attached consumer or producer.
296 • link-in - The address match for incoming routed links.
298 • link-out - The address match for outgoing routed links.
300 addr
302 The address bound to the link.
303 phs
305 The phase of the address bound to the link.
306 cap
308 The capacity, in deliveries, of the link.
309 pri
311 The priority of the link. Priority influences the order in which
312 links are processed within a connection. Higher numbers represent
313 higher priorities.
314 undel
316 The number of undelivered messages stored on the link’s FIFO.
317 unsett
319 The number of unsettled deliveries being tracked by the link.
320 deliv
322 The total number of deliveries that have transited this link.
323 presett
325 The number of pre-settled deliveries that transited this link.
326 psdrop
328 The number of pre-settled deliveries that were dropped due to
329 congestion.
330 acc
332 The number of deliveries on this link that were accepted.
333 rej
335 The number of deliveries on this link that were rejected.
336 rel
338 The number of deliveries on this link that were released.
339 mod
341 The number of deliveries on this link that were modified.
342 delay
344 The number of settled deliveries on this link that were unsettled
345 for more than one second.
346 rate
348 The average rate (over a period of five seconds) at which
349 deliveries have been settled on this link.
350 stuck
352 The number of deliveries on this link that are flagged as "stuck".
353 A delivery is considered stuck if it has been either undelivered or
354 unsettled for more than 10 seconds.
355 cred
357 The number of flow credits currently available on this link.
358 blkd
360 The time elapsed since the available credit for this link became
361 zero and has remained zero.
362 admin
364 The administrative status of the link (with -v option only):
365 • enabled - The link is enabled for normal operation.
367 • disabled - The link is disabled and should be quiescing or
369 stopped (not yet supported).
370 oper
372 The operational status of the link (with -v option only):
373 • up - The link is operational.
375 • down - The link is not attached.
377 • quiescing - The link is in the process of quiescing (not yet
379 supported).
380 • idle - The link has completed quiescing and is idle (not yet
382 supported).
383 name
385 The link name (only shown if the -v option is provided).
386 qdstat -n
388 router-id
389 The router’s ID.
390 next-hop
392 If this router is not a neighbor, this field identifies the
393 next-hop neighbor used to reach this router.
394 link
396 The ID of the link to the neighbor router.
397 cost
399 The topology cost to this remote router (with -v option only).
400 neighbors
402 The list of neighbor routers (the router’s link-state). This field
403 is available only if you specify the -v option.
404 valid-origins
406 The list of origin routers for which the best path to the listed
407 router passes through this router (available only with the -v
408 option).
409 qdstat -e
411 id
412 The connection’s unique identifier.
413 host
415 The hostname or internet address of the remotely-connected edge
416 router.
417 container
419 The container name of the remotely-connected edge router.
420 dir
422 The direction in which the connection was established:
423 • in - The connection was initiated by the edge router.
425 • out - The connection was initiated by this router.
427 security
429 The security or encryption method, if any, used for this
430 connection.
431 authentication
433 The authentication method and user ID of the connection’s
434 authenticated user.
435 tenant
437 If the connection is to a listener using multi-tenancy, this column
438 displays the tenant namespace for the connection.
439 qdstat -a
441 class
442 The class of the address:
443 • local - The address that is local to this router.
445 • topo - The topological address used for router control
447 messages.
448 • router - A summary router address used to route messages to a
450 remote router’s local addresses.
451 • mobile - A mobile address for an attached consumer or producer.
453 addr
455 The address text.
456 phs
458 For mobile addresses only, the phase of the address. Direct
459 addresses have only a phase 0. Waypoint addresses have multiple
460 phases, normally 0 and 1.
461 distrib
463 One of the following distribution methods used for this address:
464 • multicast - A copy of each message is delivered once to each
466 consumer for the address.
467 • closest - Each message is delivered to only one consumer for
469 the address. The closest (lowest cost) consumer will be chosen.
470 If there are multiple lowest-cost consumers, deliveries will be
471 spread across those consumers.
472 • balanced - Each message is delivered to only one consumer for
474 the address. The consumer with the fewest outstanding
475 (unsettled) deliveries will be chosen. The cost of the route to
476 the consumer is a threshold for delivery (that is, higher cost
477 consumers will only receive deliveries if closer consumers are
478 backed up).
479 • flood - Used only for router-control traffic. This is multicast
481 without the prevention of duplicate deliveries.
482 pri
484 The priority of the address. If the address prefix/pattern is
485 configured with a priority, that priority will appear in this
486 column. Messages for addresses configured with a priority will be
487 forwarded according to the address’s priority.
488 in-proc
490 The number of in-process consumers for this address.
491 local
493 For this router, the number of local consumers for this address, or
494 for link-routed addresses, the number of locally-attached
495 containers that are destinations for this address.
496 remote
498 The number of remote routers that have at least one consumer for
499 this address.
500 in
502 The number of deliveries for this address that entered the network
503 on this router.
504 out
506 The number of deliveries for this address that exited the network
507 on this router.
508 thru
510 The number of deliveries for this address that were forwarded to
511 other routers.
512 to-proc
514 The number of deliveries for this address that were delivered to an
515 in-process consumer.
516 from-proc
518 The number of deliveries for this address that were received from
519 an in-process producer.
520 qdstat --linkroutes
522 prefix
523 The address prefix of the link route.
524 dir
526 The direction of matching links (from this router’s perspective).
527 distrib
529 The distribution method used for routed links. This value should
530 always be linkBalanced, which is the only supported distribution
531 for routed links.
532 status
534 The operational status of the link route:
535 • active - The route is actively routing attaches (it is ready
537 for use).
538 • inactive - The route is inactive, because no local destination
540 is connected.
541 qdstat --autolinks
543 addr
544 The auto link’s address.
545 dir
547 The direction that messages flow over the auto link:
548 • in - Messages flow in from the route-container to the router
550 network.
551 • out - Messages flow out to the route-container from the router
553 network.
554 phs
556 The address phase for this auto link.
557 link
559 The ID of the link managed by this auto link.
560 status
562 The operational status of this auto link:
563 • inactive - There is no connected container for this auto link.
565 • attaching - The link is attaching to the container.
567 • failed - The link-attach failed.
569 • active - The link is operational.
571 • quiescing - The link is quiescing (not yet supported).
573 • idle - The link is idle (not yet supported).
575 lastErr
577 The description of the last attach failure that occurred on this
578 auto link.
579 qdstat --policy
581 Maximum Concurrent Connections
582 The maximum number of concurrent client connections allowed for
583 this router.
584 Maximum Message Size
586 The maximum size in bytes of AMQP message transfers allowed for
587 this router. This limit is applied to transfers over user
588 connections and to transfers to interior routers from edge routers.
589 Enable Vhost Policy
591 Enables the router to enforce the connection denials and resource
592 limits defined in the vhost policies.
593 Enable Vhost Name Patterns
595 Enable vhost name patterns. When false vhost hostnames are treated
596 as literal strings. When true vhost hostnames are treated as match
597 patterns.
598 Policy Directory
600 The absolute path to a directory that holds vhost policy definition
601 files in JSON format (*.json).
602 Default Vhost
604 The name of the default vhost policy. This policy rule set is
605 applied to a connection for which a vhost policy has not otherwise
606 been configured. Processing for the default vhost is enabled by
607 default and set to select vhost $default. To disable default vhost
608 processing set defaultVhost to blank or do not define a vhost named
609 $default.
610 Connections Processed
612 Count of all incoming connection attempts.
613 Connections Denied
615 Count of all incoming connection attempts denied by policy.
616 Connections Current
618 Count of currently active incoming connections.
619 Links Denied
621 Count of all sender and receiver policy denials summed across all
622 vhosts.
623 Maximum Message Size Denied
625 Count of all maxMessageSize policy denials summed across all
626 vhosts.
627 Total Denials
629 Count of all policy denials for any reason summed across all
630 vhosts.
631 qdstat --vhosts
633 hostname
634 The hostname of the vhost. This vhost policy applies to any client
635 connection that uses this hostname in the hostname field of the
636 incoming AMQP Open.
637 maxConnections
639 The global maximum number of concurrent client connections allowed
640 for this vhost.
641 maxMessageSize
643 Optional maximum size in bytes of AMQP message transfers allowed
644 for connections to this vhost. This limit overrides the policy
645 maxMessageSize value and may be overridden by vhost user group
646 settings. A value of zero disables this limit.
647 maxConnectionsPerUser
649 The maximum number of concurrent client connections allowed for any
650 user.
651 maxConnectionsPerHost
653 The maximum number of concurrent client connections allowed for any
654 remote host (the host from which the client is connecting).
655 allowUnknownUser
657 Set to true this allows unknown users, users who are not members of
658 a defined user group, to connect to the vhost. Unknown users are
659 assigned to the $default user group and receive $default settings.
660 groups
662 Count of usergroups defined for this vhost.
663 qdstat --vhoststats
665 Vhost Stats table
666 hostname
668 Name of the vhost.
669 connectionsApproved
671 Count of connections approved by policy for this vhost.
672 connectionsDenied
674 Count of connections denied by policy for this vhost.
675 connectionsCurrent
677 Count of active connections for this vhost.
678 sessionDenied
680 Count of sessions denied by policy for this vhost.
681 senderDenied
683 Count of senders denied by policy for this vhost.
684 receiverDenied
686 Count of receivers denied by policy for this vhost.
687 maxMessageSizeDenied
689 Count of transfers denied by maxMesageSize policy for this vhost.
690 Vhost User Stats table
692 vhost
694 Vhost hostname
695 user
697 Authenticated user name
698 remote hosts
700 List of remote hosts from which this user has connected to this
701 vhost.
702 qdstat --vhostgroups
704 Table of settings for all vhosts and groups.
705 vhost
707 Vhost name.
708 group
710 Vhost user group name.
711 maxConnectionsPerUser
713 Optional maximum number of connections that may be created by users
714 in this group. This value, if specified, overrides the vhost
715 maxConnectionsPerUser value.
716 maxConnectionsPerHost
718 Optional maximum number of concurrent connections allowed for any
719 remote host by users in this group. This value, if specified,
720 overrides the vhost maxConnectionsPerHost value.
721 maxMessageSize
723 Optional maximum size in bytes of AMQP message transfers allowed
724 for connections created by users in this group. This limit
725 overrides the policy and vhost maxMessageSize values. A value of
726 zero disables this limit.
727 maxFrameSize
729 The largest frame, in bytes, that may be sent on this connection.
730 Non-zero policy values overwrite values specified for a listener
731 object (AMQP Open, max-frame-size).
732 maxSessionWindow
734 The incoming capacity for new AMQP sessions, measured in octets.
735 Non-zero policy values overwrite values specified for a listener
736 object (AMQP Begin, incoming-window).
737 maxSessions
739 The maximum number of sessions that may be created on this
740 connection. Non-zero policy values overwrite values specified for a
741 listener object (AMQP Open, channel-max).
742 maxSenders
744 The maximum number of sending links that may be created on this
745 connection. A value of 0 disables all sender links.
746 maxReceivers
748 The maximum number of receiving links that may be created on this
749 connection. A value of 0 disables all receiver links.
750 allowDynamicSource
752 Whether this connection is allowed to create dynamic receiving
753 links (links to resources that do not exist on the peer). A value
754 of true means that users are able to automatically create resources
755 on the peer system.
756 allowAnonymousSender
758 Whether this connection is allowed to create sending links if the
759 sender does not provide a target address. By prohibiting anonymous
760 senders, the router only needs to verify once, when the link is
761 created, that the sender is permitted to send messages to the
762 target address. The router does not need to verify each message
763 that is sent on the link. A value of true means that users may send
764 messages to any address. Allowing anonymous senders can also
765 decrease performance: if the sender does not specify a target
766 address, then the router must parse each message to determine how
767 to route it.
768 allowUserIdProxy
770 Whether this connection is allowed to send messages with a user ID
771 that is different than the connection’s authenticated user name.
772 allowWaypointLinks
774 Whether this connection is allowed to claim waypoint.N capability
775 for attached links. This allows endpoints to act as waypoints
776 without needing auto-links.
777 allowDynamicLinkRoutes
779 Whether this connection is allowed to dynamically create
780 connection-scoped link route destinations.
781 allowAdminStatusUpdate
783 Whether this connection is allowed to update the admin status of
784 other connections. Note: Inter-router connections cannot be deleted
785 at any time.
786 allowFallbackLinks
788 Whether this connection is allowed to claim qd.fallback capability
789 for attached links. This allows endpoints to act as fallback
790 destinations for addresses that have fallback capability enabled.
791 Tables for each vhost and user group.
793 Vhost
795 Name of vhost.
796 UserGroup
798 Name of vhost usergroup.
799 vhost
801 Name of vhost.
802 group
804 Name of vhost usergroup.
805 users
807 A list of authenticated users for this user group.
808 remoteHosts
810 A list of remote hosts from which the users may connect. A host can
811 be a hostname, IP address, or IP address range. Use commas to
812 separate multiple hosts. To allow access from all remote hosts,
813 specify a wildcard asterisk \*. To deny access from all remote
814 hosts, leave this attribute blank.
815 sources
817 A list of source addresses from which users in this group may
818 receive messages. To specify multiple addresses, separate the
819 addresses with either a comma or a space. If you do not specify any
820 addresses, users in this group are not allowed to receive messages
821 from any addresses. You can use the substitution token ${user} to
822 specify an address that contains a user’s authenticated user name.
823 You can use an asterisk \* wildcard to match one or more characters
824 in an address. However, this wildcard is only recognized if it is
825 the last character in the address name. You may specify attributes
826 sources or sourcePattern but not both at the same time.
827 targets
829 A list of target addresses to which users in this group may send
830 messages. To specify multiple addresses, separate the addresses
831 with either a comma or a space. If you do not specify any
832 addresses, users in this group are not allowed to send messages to
833 any addresses. You can use the substitution token ${user} to
834 specify an address that contains a user’s authenticated user name.
835 You can use an asterisk \* wildcard to match one or more characters
836 in an address. However, this wildcard is only recognized if it is
837 the last character in the address name. You may specify attributes
838 targets or targetPattern but not both at the same time.
839 sourcePattern
841 A wildcarded pattern for matching source addresses from which users
842 in this group may receive messages. The pattern consists of one or
843 more tokens separated by a forward slash /. A token can be one of
844 the following: asterisk *, hash #, or a sequence of characters that
845 do not include /, asterisk *, or hash #. The asterisk * token
846 matches any single token. The hash # token matches zero or more
847 tokens. asterisk \* has higher precedence than hash \#, and exact
848 match has the highest precedence. To specify multiple addresses,
849 separate the addresses with either a comma or a space. You can use
850 the text string ${user} in a token to specify an address that
851 contains a user’s authenticated user name. If you do not specify
852 any addresses then users in this group are not allowed to receive
853 messages from any addresses. You may specify attributes sources or
854 sourcePattern but not both at the same time.
855 targetPattern
857 A wildcarded pattern for matching target addresses to which users
858 in this group may send messages. The pattern consists of one or
859 more tokens separated by a forward slash "/". A token can be one of
860 the following: asterisk *, hash #, or a sequence of characters that
861 do not include "/", asterisk *, or hash #. The asterisk * token
862 matches any single token. The hash # token matches zero or more
863 tokens. asterisk \* has higher precedence than hash \#, and exact
864 match has the highest precedence. To specify multiple addresses,
865 separate the addresses with either a comma or a space. You can use
866 the text string ${user} in a token to specify an address that
867 contains a user’s authenticated user name. If you do not specify
868 any addresses then users in this group are not allowed to send
869 messages to any addresses. You may specify attributes targets or
870 targetPattern but not both at the same time.
871
873 qdrouterd(8), qdmanage(8), qdrouterd.conf(5)
874 http://qpid.apache.org/components/dispatch-router
876 03/29/2022 QDSTAT(8)