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 --all-routers : Show entities for all routers in network. Can also be
40 --all-entities : Show all router entities. Can be combined with --all-
42 -v, --verbose : Show maximum detail
44 --log : Show recent log entries
46 --limit=LIMIT : Limit number of output rows
48 Connection Options
50 -b URL, --bus=URL : URL of the messaging bus to connect to (default
51 -r ROUTER-ID, --router=ROUTER-ID : Router to be queried
53 -t SECS, --timeout=SECS : Maximum time to wait for connection in
55 seconds (default 5)
56 --ssl-certificate=CERT : Client SSL certificate (PEM Format)
58 --ssl-key=KEY : Client SSL private key (PEM Format)
60 --ssl-trustfile=TRUSTED-CA-DB : Trusted Certificate Authority Database
62 file (PEM Format)
63 --ssl-password=PASSWORD : Certificate password, will be prompted if not
65 specifed.
66 --ssl-password-file=SSL-PASSWORD-FILE : Certificate password, will be
68 prompted if not specifed.
69 --sasl-mechanisms=SASL-MECHANISMS : Allowed sasl mechanisms to be
71 supplied during the sasl handshake.
72 --sasl-username=SASL-USERNAME : User name for SASL plain authentication
74 --sasl-password=SASL-PASSWORD : Password for SASL plain authentication
76 --sasl-password-file=SASL-PASSWORD-FILE : Password for SASL plain
78 authentication
79 --ssl-disable-peer-name-verify : Disables SSL peer name verification.
81 WARNING - This option is insecure and must not be used in production
82 environments
83
85 qdstat -c
86 id
87 The connection’s unique identifier.
88 host
90 The hostname or internet address of the remotely-connected AMQP
91 container.
92 container
94 The container name of the remotely-connected AMQP container.
95 role
97 The connection’s role:
98 · normal - The normal connection from a client to a router.
100 · inter-router - The connection between routers to form a
102 network.
103 · route-container - The connection to or from a broker or other
105 host to receive link routes and waypoints.
106 · edge - The connection between an edge router and an interior
108 router.
109 dir
111 The direction in which the connection was established:
112 · in - The connection was initiated by the remote container.
114 · out - The connection was initiated by this router.
116 security
118 The security or encryption method, if any, used for this
119 connection.
120 authentication
122 The authentication method and user ID of the connection’s
123 authenticated user.
124 tenant
126 If the connection is to a listener using multi-tenancy, this column
127 displays the tenant namespace for the connection.
128 qdstat -l
130 type
131 The type of link:
132 · router-control - An inter-router link that is reserved for
134 control messages exchanged between routers.
135 · inter-router - An inter-router link that is used for normal
137 message-routed deliveries.
138 · endpoint - A normal link to an external endpoint container.
140 dir
142 The direction that messages flow on the link:
143 · in - Deliveries flow inbound to the router.
145 · out - Deliveries flow outbound from the router.
147 conn id
149 The unique identifier of the connection over which this link is
150 attached.
151 id
153 The unique identifier of this link.
154 peer
156 For link-routed links, the unique identifier of the peer link. In
157 link routing, an inbound link is paired with an outbound link.
158 class
160 The class of the address bound to the link:
161 · local - The address that is local to this router (temporary).
163 · topo - A topological address used for router control messages.
165 · router - A summary router address used to route messages to a
167 remote router’s local addresses.
168 · mobile - A mobile address for an attached consumer or producer.
170 · link-in - The address match for incoming routed links.
172 · link-out - The address match for outgoing routed links.
174 addr
176 The address bound to the link.
177 phs
179 The phase of the address bound to the link.
180 cap
182 The capacity, in deliveries, of the link.
183 pri
185 The priority of the link. Priority influences the order in which
186 links are processed within a connection. Higher numbers represent
187 higher priorities.
188 undel
190 The number of undelivered messages stored on the link’s FIFO.
191 unsett
193 The number of unsettled deliveries being tracked by the link.
194 del
196 The total number of deliveries that have transited this link.
197 presett
199 The number of pre-settled deliveries that transited this link.
200 psdrop
202 The number of pre-settled deliveries that were dropped due to
203 congestion.
204 acc
206 The number of deliveries on this link that were accepted.
207 rej
209 The number of deliveries on this link that were rejected.
210 rel
212 The number of deliveries on this link that were released.
213 mod
215 The number of deliveries on this link that were modified.
216 delay
218 The number of settled deliveries on this link that were unsettled
219 for more than one second.
220 rate
222 The average rate (over a period of five seconds) at which
223 deliveries have been settled on this link.
224 admin
226 The administrative status of the link:
227 · enabled - The link is enabled for normal operation.
229 · disabled - The link is disabled and should be quiescing or
231 stopped (not yet supported).
232 oper
234 The operational status of the link:
235 · up - The link is operational.
237 · down - The link is not attached.
239 · quiescing - The link is in the process of quiescing (not yet
241 supported).
242 · idle - The link has completed quiescing and is idle (not yet
244 supported).
245 name
247 The link name (only shown if the -v option is provided).
248 qdstat -n
250 router-id
251 The router’s ID.
252 next-hop
254 If this router is not a neighbor, this field identifies the
255 next-hop neighbor used to reach this router.
256 link
258 The ID of the link to the neighbor router.
259 cost
261 The topology cost to this remote router (with -v option only).
262 neighbors
264 The list of neighbor routers (the router’s link-state). This field
265 is available only if you specify the -v option.
266 valid-origins
268 The list of origin routers for which the best path to the listed
269 router passes through this router (available only with the -v
270 option).
271 qdstat -e
273 id
274 The connection’s unique identifier.
275 host
277 The hostname or internet address of the remotely-connected edge
278 router.
279 container
281 The container name of the remotely-connected edge router.
282 dir
284 The direction in which the connection was established:
285 · in - The connection was initiated by the edge router.
287 · out - The connection was initiated by this router.
289 security
291 The security or encryption method, if any, used for this
292 connection.
293 authentication
295 The authentication method and user ID of the connection’s
296 authenticated user.
297 tenant
299 If the connection is to a listener using multi-tenancy, this column
300 displays the tenant namespace for the connection.
301 qdstat -a
303 class
304 The class of the address:
305 · local - The address that is local to this router.
307 · topo - The topological address used for router control
309 messages.
310 · router - A summary router address used to route messages to a
312 remote router’s local addresses.
313 · mobile - A mobile address for an attached consumer or producer.
315 addr
317 The address text.
318 phs
320 For mobile addresses only, the phase of the address. Direct
321 addresses have only a phase 0. Waypoint addresses have multiple
322 phases, normally 0 and 1.
323 distrib
325 One of the following distribution methods used for this address:
326 · multicast - A copy of each message is delivered once to each
328 consumer for the address.
329 · closest - Each message is delivered to only one consumer for
331 the address. The closest (lowest cost) consumer will be chosen.
332 If there are multiple lowest-cost consumers, deliveries will be
333 spread across those consumers.
334 · balanced - Each message is delivered to only one consumer for
336 the address. The consumer with the fewest outstanding
337 (unsettled) deliveries will be chosen. The cost of the route to
338 the consumer is a threshold for delivery (that is, higher cost
339 consumers will only receive deliveries if closer consumers are
340 backed up).
341 · flood - Used only for router-control traffic. This is multicast
343 without the prevention of duplicate deliveries.
344 pri
346 The priority of the address. If the address prefix/pattern is
347 configured with a priority, that priority will appear in this
348 column. Messages for addresses configured with a priority will be
349 forwarded according to the address’s priority.
350 in-proc
352 The number of in-process consumers for this address.
353 local
355 For this router, the number of local consumers for this address, or
356 for link-routed addresses, the number of locally-attached
357 containers that are destinations for this address.
358 remote
360 The number of remote routers that have at least one consumer for
361 this address.
362 in
364 The number of deliveries for this address that entered the network
365 on this router.
366 out
368 The number of deliveries for this address that exited the network
369 on this router.
370 thru
372 The number of deliveries for this address that were forwarded to
373 other routers.
374 to-proc
376 The number of deliveries for this address that were delivered to an
377 in-process consumer.
378 from-proc
380 The number of deliveries for this address that were received from
381 an in-process producer.
382 qdstat --linkroutes
384 prefix
385 The address prefix of the link route.
386 dir
388 The direction of matching links (from this router’s perspective).
389 distrib
391 The distribution method used for routed links. This value should
392 always be linkBalanced, which is the only supported distribution
393 for routed links.
394 status
396 The operational status of the link route:
397 · active - The route is actively routing attaches (it is ready
399 for use).
400 · inactive - The route is inactive, because no local destination
402 is connected.
403 qdstat --autolinks
405 addr
406 The auto link’s address.
407 dir
409 The direction that messages flow over the auto link:
410 · in - Messages flow in from the route-container to the router
412 network.
413 · out - Messages flow out to the route-container from the router
415 network.
416 phs
418 The address phase for this auto link.
419 link
421 The ID of the link managed by this auto link.
422 status
424 The operational status of this auto link:
425 · inactive - There is no connected container for this auto link.
427 · attaching - The link is attaching to the container.
429 · failed - The link-attach failed.
431 · active - The link is operational.
433 · quiescing - The link is quiescing (not yet supported).
435 · idle - The link is idle (not yet supported).
437 lastErr
439 The description of the last attach failure that occurred on this
440 auto link.
441
443 qdrouterd(8), qdmanage(8), qdrouterd.conf(5)
444 http://qpid.apache.org/components/dispatch-router
446 10/02/2019 QDSTAT(8)