Repository: qpid-dispatch Updated Branches: refs/heads/master 40f1005c4 -> b38d81d0f
Update qdmanage, qdrouterd, and qdstat man pages. Project: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/repo Commit: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/commit/f44bfdcb Tree: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/tree/f44bfdcb Diff: http://git-wip-us.apache.org/repos/asf/qpid-dispatch/diff/f44bfdcb Branch: refs/heads/master Commit: f44bfdcb3db5d3cb750197a70fd98a8e1338e6dd Parents: db96fd8 Author: Ben Hardesty <bhard...@redhat.com> Authored: Wed Jun 21 16:23:32 2017 -0400 Committer: Ben Hardesty <bhard...@redhat.com> Committed: Wed Jun 21 16:23:32 2017 -0400 ---------------------------------------------------------------------- doc/man/qdmanage.8.adoc | 29 +++--- doc/man/qdrouterd.8.adoc | 4 +- doc/man/qdstat.8.adoc | 202 +++++++++++++++++++++--------------------- 3 files changed, 119 insertions(+), 116 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f44bfdcb/doc/man/qdmanage.8.adoc ---------------------------------------------------------------------- diff --git a/doc/man/qdmanage.8.adoc b/doc/man/qdmanage.8.adoc index 8c88d33..9f668b5 100644 --- a/doc/man/qdmanage.8.adoc +++ b/doc/man/qdmanage.8.adoc @@ -31,10 +31,11 @@ SYNOPSIS DESCRIPTION ----------- -An AMQP management client for use with qdrouterd. Sends AMQP management -operations requests and prints the response in JSON format. This is a -generic AMQP management tool and can be used with any standard AMQP -managed endpoint, not just with qdrouter. +An AMQP management client for use with the Dispatch router daemon +('qdrouterd'). Sends AMQP management operations requests and prints +the response in JSON format. This is a generic AMQP management tool +and can be used with any standard AMQP managed endpoint, not just +with 'qdrouterd'. OPTIONS ------- @@ -57,7 +58,7 @@ OPERATIONS multiple entities. `read`:: - Print all the attributes of a single entity, specified by the --name or + Print all of the attributes of a single entity, specified by the --name or --identity options. `update` ['ATTR=VALUE'...]:: @@ -70,19 +71,19 @@ OPERATIONS Delete an entity specified by the --name or --identity options. `get-types` ['TYPE']:: - List entity types with their base types. With no arguments list all + List entity types with their base types. With no arguments, list all types. `get-operations` ['TYPE']:: - List entity types with their operations. With no arguments list all + List entity types with their operations. With no arguments, list all types. `get-attributes` ['TYPE']:: - List entity types with their attributes. With no arguments list all + List entity types with their attributes. With no arguments, list all types. `get-annotations` ['TYPE']:: - List entity types with their annotations. With no arguments list all + List entity types with their annotations. With no arguments, list all types. `get-mgmt-nodes`:: @@ -99,14 +100,14 @@ FILES ----- {CMAKE_INSTALL_PREFIX}/{QD_DOC_INSTALL_DIR}/qdrouter.json:: - Management schema for qdrouterd. + Management schema for 'qdrouterd'. {CMAKE_INSTALL_PREFIX}/{QD_DOC_INSTALL_DIR}/qdrouter.json.readme.txt:: Explanation of the management schema. EXAMPLES -------- -.Show the logging configuration +.Show the logging configuration: -------------------------------------------------------------- qdmanage query --type=log -------------------------------------------------------------- @@ -116,17 +117,17 @@ qdmanage query --type=log qdmanage update name=log/DEFAULT enable=debug+ -------------------------------------------------------------- -.Enable trace log messages only for the MESSAGE module and direct MESSAGE logs to the file "test.log" +.Enable trace log messages only for the MESSAGE module, and direct MESSAGE logs to the file _test.log_: -------------------------------------------------------------- qdmanage update name=log/MESSAGE enable=trace output=test.log -------------------------------------------------------------- -.Set MESSAGE logging back to the default +.Set MESSAGE logging back to the default: ------------------------------------------------ qdmanage update name=log/MESSAGE enable=default ------------------------------------------------ -.Disable MESSAGE logging +.Disable MESSAGE logging: --------------------------------------------- qdmanage update name=log/MESSAGE enable=none --------------------------------------------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f44bfdcb/doc/man/qdrouterd.8.adoc ---------------------------------------------------------------------- diff --git a/doc/man/qdrouterd.8.adoc b/doc/man/qdrouterd.8.adoc index 5b8ab1d..ae2c2a2 100644 --- a/doc/man/qdrouterd.8.adoc +++ b/doc/man/qdrouterd.8.adoc @@ -32,7 +32,7 @@ SYNOPSIS DESCRIPTION ----------- -The Qpid Dispatch router (qdrouterd) is a network daemon that directs +The Qpid Dispatch router ('qdrouterd') is a network daemon that directs AMQP 1.0 messages between endpoints, such as messaging clients and servers. @@ -45,7 +45,7 @@ FILES ----- {SYSCONF_INSTALL_DIR}/qdrouterd.conf:: - Configuration flie. + Configuration file. SEE ALSO -------- http://git-wip-us.apache.org/repos/asf/qpid-dispatch/blob/f44bfdcb/doc/man/qdstat.8.adoc ---------------------------------------------------------------------- diff --git a/doc/man/qdstat.8.adoc b/doc/man/qdstat.8.adoc index ae070dd..c94f476 100644 --- a/doc/man/qdstat.8.adoc +++ b/doc/man/qdstat.8.adoc @@ -31,8 +31,7 @@ SYNOPSIS DESCRIPTION ----------- -Shows status information about networks of Dispatch routers. It can display -connections, network nodes and links, and router stats such as memory use. +An AMQP monitoring tool that shows status information about networks of Dispatch routers. It can display connections, network nodes and links, and router stats such as memory use. OPTIONS ------- @@ -45,224 +44,227 @@ OUTPUT COLUMNS qdstat -c ~~~~~~~~~ id:: -Unique connection identifier +The connection's unique identifier. host:: -The hostname or internet address of the remotely connected AMQP container +The hostname or internet address of the remotely-connected AMQP container. container:: -The container-name of the remotely connected AMQP container +The container name of the remotely-connected AMQP container. role:: -The configured role of the connection - - normal - Normal connections from client to router - - inter-router - Connection between routers to form a network - - route-container - Connection to/from a Broker or other host to receive link-routes and waypoints +The connection's role: + - 'normal' - The normal connection from a client to a router. + - 'inter-router' - The connection between routers to form a network. + - 'route-container' - The connection to or from a broker or other host to receive link routes and waypoints. dir:: -The direction of connection establishment - - in - The connection was initiated by the remote container - - out - The connection was initiated by this router +The direction in which the connection was established: + - 'in' - The connection was initiated by the remote container. + - 'out' - The connection was initiated by this router. security:: -A description of the security/encryption in effect for this -connection +The security or encryption method, if any, used for this connection. authentication:: -The method and user-id of the authenticated user for -this connection +The authentication method and user ID of the connection's authenticated user. qdstat -l ~~~~~~~~~ type:: -Type of link - - router-control - An inter-router link that is reserved for control messages exchanged between routers - - inter-router - An inter-router link that is used for normal message-routed deliveries - - endpoint - A normal link to an external endpoint container +The type of link: + - 'router-control' - An inter-router link that is reserved for control messages exchanged between routers. + - 'inter-router' - An inter-router link that is used for normal message-routed deliveries. + - 'endpoint' - A normal link to an external endpoint container. dir:: -The direction of message flow on the link - - in - Deliveries flow inbound to the router - - out - Deliveries flow outbound from the router +The direction that messages flow on the link: + - 'in' - Deliveries flow inbound to the router. + - 'out' - Deliveries flow outbound from the router. conn id:: -Unique identifier of the connection over which this link is -attached +The unique identifier of the connection over which this link is +attached. id:: -Unique identifier of this link +The unique identifier of this link. peer:: For link-routed links, the unique identifier of the peer link. In -link routing, an inbound link is paired with an outbound link +link routing, an inbound link is paired with an outbound link. class:: -Class of the address bound to the link +The class of the address bound to the link: + - 'local' - The address that is local to this router (temporary). + - 'topo' - A topological address used for router control messages. + - 'router' - A summary router address used to route messages to a remote routerâs local addresses. + - 'mobile' - A mobile address for an attached consumer or producer. + - 'link-in' - The address match for incoming routed links. + - 'link-out' - The address match for outgoing routed links. addr:: -The address bound to the link +The address bound to the link. phs:: -The phase of the address bound to the link +The phase of the address bound to the link. cap:: -The capacity, in deliveries, of the link +The capacity, in deliveries, of the link. undel:: -The number of undelivered messages stored on the link's FIFO +The number of undelivered messages stored on the link's FIFO. unsett:: -The number of unsettled deliveries being tracked by the link +The number of unsettled deliveries being tracked by the link. del:: -The total number of deliveries that have transited this link +The total number of deliveries that have transited this link. -presett: -The number of pre-settled deliveries that transited this link +presett:: +The number of pre-settled deliveries that transited this link. -acc: -The number of deliveries on this link that were accepted +acc:: +The number of deliveries on this link that were accepted. -rej: -The number of deliveries on this link that were rejected +rej:: +The number of deliveries on this link that were rejected. -rel: -The number of deliveries on this link that were released +rel:: +The number of deliveries on this link that were released. -mod: -The number of deliveries on this link that were modified +mod:: +The number of deliveries on this link that were modified. admin:: -The administrative status of the link - - enabled - The link is enabled for normal operation - - disabled - The link is disabled and should be quiescing or stopped (not yet supported) +The administrative status of the link: + - 'enabled' - The link is enabled for normal operation. + - 'disabled' - The link is disabled and should be quiescing or stopped (not yet supported). oper:: -The operational status of the link - - up - The link is operational - - down - The link is not attached - - quiescing - The link is in the process of quiescing (not yet supported) - - idle - The link has completed quiescing and is idle (not yet supported) +The operational status of the link: + - 'up' - The link is operational. + - 'down' - The link is not attached. + - 'quiescing' - The link is in the process of quiescing (not yet supported). + - 'idle' - The link has completed quiescing and is idle (not yet supported). name:: -The link name (only shown if the -v option is provided) +The link name (only shown if the -v option is provided). qdstat -n ^^^^^^^^^ router-id:: -Identifier of the router +The router's ID. next-hop:: -If this router is not a neighbor, identifies the next-hop neighbor used to reach this router +If this router is not a neighbor, this field identifies the next-hop neighbor used to reach this router. link:: -Unique identifier of the link to the neighbor router +The ID of the link to the neighbor router. cost:: -The topology cost to this remote router (with -v option only) +The topology cost to this remote router (with -v option only). neighbors:: -The list of neighbor routers (the router's link-state) (with -v option only) +The list of neighbor routers (the router's link-state). This field is available only if you specify the -v option. valid-origins:: -The list of origin routers for which the best path to the listed router passes through this router (with -v option only) +The list of origin routers for which the best path to the listed router passes through this router (available only with the -v option). qdstat -a ~~~~~~~~~ class:: -The class of the listed address - - local - Address that is local to this router - - topo - Topological address used for router control messages - - router - A summary router address used to route messages to a remote router's local addresses - - mobile - A mobile address for an attached consumer or producer +The class of the address: + - 'local' - The address that is local to this router. + - 'topo' - The topological address used for router control messages. + - 'router' - A summary router address used to route messages to a remote router's local addresses. + - 'mobile' - A mobile address for an attached consumer or producer. addr:: -The address text +The address text. phs:: For mobile addresses only, the phase of the address. Direct addresses have only a phase 0. Waypoint addresses have multiple phases, normally 0 and 1. distrib:: -Distribution method used for this address - - multicast - A copy of each message is delivered once to each consumer for the address - - closest - Each message is delivered to only one consumer for the address. The closest (lowest cost) consumer will be chosen. If there are multiple lowest-cost consumers, deliveries will be spread across those consumers. - - balanced - Each message is delivered to only one consumer for the address. The consumer with the fewest outstanding (unsettled) deliveries will be chosen. The cost of the route to the consumer is a threshold for delivery (i.e. higher cost consumers will only receive deliveries if closer consumers are backed up). - - flood - Used only for router-control traffic. This is multicast without prevention of duplicate deliveries. +One of the following distribution methods used for this address: + - 'multicast' - A copy of each message is delivered once to each consumer for the address. + - 'closest' - Each message is delivered to only one consumer for the address. The closest (lowest cost) consumer will be chosen. If there are multiple lowest-cost consumers, deliveries will be spread across those consumers. + - 'balanced' - Each message is delivered to only one consumer for the address. The consumer with the fewest outstanding (unsettled) deliveries will be chosen. The cost of the route to the consumer is a threshold for delivery (that is, higher cost consumers will only receive deliveries if closer consumers are backed up). + - 'flood' - Used only for router-control traffic. This is multicast without the prevention of duplicate deliveries. in-proc:: -The number of in-process consumers for this address +The number of in-process consumers for this address. local:: -The number of local (on this router) consumers for this address +For this router, the number of local consumers for this address. remote:: -The number of remote routers that have at least one consumer for this address +The number of remote routers that have at least one consumer for this address. cntnr:: -The number of locally attached containers that are destinations for link-routes on this address +The number of locally-attached containers that are destinations for link routes on this address. in:: -The number of deliveries for this address that entered the network on this router +The number of deliveries for this address that entered the network on this router. out:: -The number of deliveries for this address that exited the network on this router +The number of deliveries for this address that exited the network on this router. thru:: -The number of deliveries for this address that were forwarded to other routers +The number of deliveries for this address that were forwarded to other routers. to-proc:: -The number of deliveries for this address that were delivered to an in-process consumer +The number of deliveries for this address that were delivered to an in-process consumer. from-proc:: -The number of deliveries for this address that were received from an in-process producer +The number of deliveries for this address that were received from an in-process producer. qdstat --linkroutes ~~~~~~~~~~~~~~~~~~~ prefix:: -The prefix for matching addresses of routed links +The address prefix of the link route. dir:: -The direction (from the router's perspective) of matching links +The direction of matching links (from this router's perspective). distrib:: -The distribution method used for routed links - - linkBalanced - the only supported distribution for routed links +The distribution method used for routed links. This value should always be 'linkBalanced', which is the only supported distribution for routed links. status:: -Operational status of the link route - - active - Route is actively routing attaches (i.e. ready for use) - - inactive - Route is inactive because there is no local destination connected +The operational status of the link route: + - 'active' - The route is actively routing attaches (it is ready for use). + - 'inactive' - The route is inactive, because no local destination is connected. qstat --autolinks ~~~~~~~~~~~~~~~~~ addr:: -The address of the auto link +The auto link's address. dir:: -The direction of message flow for the auto link - - in - Messages flow in from the route-container to the router network - - out - Messages flow out to the route-container from the router network +The direction that messages flow over the auto link: + - 'in' - Messages flow in from the route-container to the router network. + - 'out' - Messages flow out to the route-container from the router network. phs:: -Phase of the address for this auto link +The address phase for this auto link. link:: -Unique identifier of the link managed by this auto link +The ID of the link managed by this auto link. status:: -The operational status of this auto link - - inactive - There is no connected container for this auto link - - attaching - The link is attaching to the container - - failed - The link-attach failed - - active - The link is operational - - quiescing - The link is quiescing (not yet supported) - - idle - The link is idle (not yet supported) +The operational status of this auto link: + - 'inactive' - There is no connected container for this auto link. + - 'attaching' - The link is attaching to the container. + - 'failed' - The link-attach failed. + - 'active' - The link is operational. + - 'quiescing' - The link is quiescing (not yet supported). + - 'idle' - The link is idle (not yet supported). lastErr:: -The description of the last attach failure that occurred on this auto link +The description of the last attach failure that occurred on this auto link. SEE ALSO -------- --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@qpid.apache.org For additional commands, e-mail: commits-h...@qpid.apache.org
