[qpid-dispatch] branch master updated: DISPATCH-1374 - Doc qdstat --all-routers and all-entities options. This closes #551
This is an automated email from the ASF dual-hosted git repository.
gmurthy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/qpid-dispatch.git
The following commit(s) were added to refs/heads/master by this push:
new 7d5cf3c DISPATCH-1374 - Doc qdstat --all-routers and all-entities
options. This closes #551
7d5cf3c is described below
commit 7d5cf3c1ddc63990d89d3474d7e7ea6cec7209a0
Author: Ben Hardesty
AuthorDate: Mon Aug 19 15:51:42 2019 -0400
DISPATCH-1374 - Doc qdstat --all-routers and all-entities options. This
closes #551
---
docs/books/user-guide/monitoring-using-qdstat.adoc | 74 ++
1 file changed, 62 insertions(+), 12 deletions(-)
diff --git a/docs/books/user-guide/monitoring-using-qdstat.adoc
b/docs/books/user-guide/monitoring-using-qdstat.adoc
index fdad27f..77b065a 100644
--- a/docs/books/user-guide/monitoring-using-qdstat.adoc
+++ b/docs/books/user-guide/monitoring-using-qdstat.adoc
@@ -35,12 +35,62 @@ This specifies:
* An `option` for the type of information to view.
* One or more optional `connection_options` to specify a router for which to
view the information.
-+
++
If you do not specify a connection option, `qdstat` connects to the router
listening on localhost and the default AMQP port (5672).
-* The `secure_connection_options` if the router for which you want to view
information only accepts secure connections.
+* The `secure_connection_options` if the router for which you want to view
information only accepts secure connections.
For more information about `qdstat`, see the {qdstatManPageLink}.
+== Creating a State Dump of the Router Network
+
+A state dump shows the current operational state of the router network. You
can display the following statistics for a single router, or for all routers in
the router network:
+
+* Links
+* Addresses
+* Connections
+* Autolinks
+* Link routes
+* General statistics
+* Memory usage
+
+.Procedure
+
+* Do one of the following:
++
+--
+[cols="30,70"]
+|===
+| To... | Use this command:
+
+| Create a state dump containing all statistics for all routers
+a|
+[options="nowrap"]
+
+$ qdstat --all-routers --all-entities
+
+
+If you run this command on an interior router, it displays the statistics for
all interior routers. If you run the command on an edge router, it displays the
statistics for only that edge router.
+
+| Create a state dump containing a single statistic for all routers
+a|
+[options="nowrap",subs="+quotes"]
+
+$ qdstat -l\|-a\|-c\|--autolinks\|--linkroutes\|-g\|-m --all-routers
+
+
+If you run this command on an interior router, it displays the statistic for
all interior routers. If you run the command on an edge router, it displays the
statistic for only that edge router.
+
+| Create a state dump containing all statistics for a single router
+a|
+[options="nowrap"]
+
+$ qdstat --all-entities
+
+
+This command shows the statistics for the local router only.
+|===
+--
+
== Viewing General Statistics for a Router
You can view information about a router in the router network, such as its
working mode and ID.
@@ -52,7 +102,7 @@ You can view information about a router in the router
network, such as its worki
--
[options="nowrap",subs="+quotes"]
-$ qdstat -g [__CONNECTION_OPTIONS__]
+$ qdstat -g [all-routers|__CONNECTION_OPTIONS__]
This example shows general statistics for the local router:
@@ -102,7 +152,7 @@ You can view:
--
[options="nowrap",subs="+quotes"]
-$ qdstat -c [__CONNECTION_OPTIONS__]
+$ qdstat -c [all-routers|__CONNECTION_OPTIONS__]
For more information about the fields displayed by this command, see
link:{qdstatManPageUrl}#_qdstat_c[the qdstat -c output columns^].
@@ -132,7 +182,7 @@ idhostcontainer
role
[options="nowrap"]
-$ qdstat -c -r Router.B
+$ qdstat -c -r Router.B
Connections
idhost container role dir security
authentication tenant
@@ -151,7 +201,7 @@ You can view a list of AMQP links attached to the router
from clients (sender/re
--
[options="nowrap",subs="+quotes"]
-$ qdstat -l [__CONNECTION_OPTIONS__]
+$ qdstat -l [all-routers|__CONNECTION_OPTIONS__]
For more information about the fields displayed by this command, see
link:{qdstatManPageUrl}#_qdstat_l[the qdstat -l output columns^].
@@ -200,7 +250,7 @@ To see the topology of the router network, you can view
known routers on the net
--
[options="nowrap",subs="+quotes"]
-$ qdstat -n [__CONNECTION_OPTIONS__]
+$ qdstat -n [all-routers|__CONNECTION_OPTIONS__]
For more information about the fields displayed by this command, see
link:{qdstatManPageUrl}#_qdstat_n[the qdstat -n output columns^].
@@ -265,7 +315,7 @@ You can view message-routed and link-routed addresses
[qpid-dispatch] branch master updated: DISPATCH-1396 - Add starting router procedure. This closes #548
This is an automated email from the ASF dual-hosted git repository.
gmurthy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/qpid-dispatch.git
The following commit(s) were added to refs/heads/master by this push:
new 03a1734 DISPATCH-1396 - Add starting router procedure. This closes
#548
03a1734 is described below
commit 03a1734a532f76f02383c9482a8ed7dfc0947862
Author: Ben Hardesty
AuthorDate: Mon Aug 12 16:39:56 2019 -0400
DISPATCH-1396 - Add starting router procedure. This closes #548
---
... => fragment-start-router-service-command.adoc} | 8 +--
adoc => fragment-systemd-limitnofile-fmi.adoc} | 11 +---
.../user-guide/assemblies/getting-started.adoc | 2 +-
docs/books/user-guide/book.adoc| 1 +
...ecting-using-mutual-ssl-tls-authentication.adoc | 2 +-
...r.adoc => starting-router-getting-started.adoc} | 23 +
.../books/user-guide/modules/starting-routers.adoc | 60 ++
7 files changed, 78 insertions(+), 29 deletions(-)
diff --git a/docs/books/_common/fragment-starting-router-step.adoc
b/docs/books/_common/fragment-start-router-service-command.adoc
similarity index 83%
copy from docs/books/_common/fragment-starting-router-step.adoc
copy to docs/books/_common/fragment-start-router-service-command.adoc
index 22142ac..ca15a99 100644
--- a/docs/books/_common/fragment-starting-router-step.adoc
+++ b/docs/books/_common/fragment-start-router-service-command.adoc
@@ -17,13 +17,7 @@ specific language governing permissions and limitations
under the License
-. To start the router, use the *`qdrouterd`* command.
-+
---
-This example uses the default configuration to start the router as a daemon:
-
[source,bash,options="nowrap"]
-$ qdrouterd -d
+$ systemctl start qdrouterd.service
---
\ No newline at end of file
diff --git a/docs/books/_common/fragment-starting-router-step.adoc
b/docs/books/_common/fragment-systemd-limitnofile-fmi.adoc
similarity index 79%
rename from docs/books/_common/fragment-starting-router-step.adoc
rename to docs/books/_common/fragment-systemd-limitnofile-fmi.adoc
index 22142ac..3062644 100644
--- a/docs/books/_common/fragment-starting-router-step.adoc
+++ b/docs/books/_common/fragment-systemd-limitnofile-fmi.adoc
@@ -17,13 +17,4 @@ specific language governing permissions and limitations
under the License
-. To start the router, use the *`qdrouterd`* command.
-+
---
-This example uses the default configuration to start the router as a daemon:
-
-[source,bash,options="nowrap"]
-
-$ qdrouterd -d
-
---
\ No newline at end of file
+For more information, see the `systemd.exec(5)` man page.
diff --git a/docs/books/user-guide/assemblies/getting-started.adoc
b/docs/books/user-guide/assemblies/getting-started.adoc
index 019c05f..c1e325a 100644
--- a/docs/books/user-guide/assemblies/getting-started.adoc
+++ b/docs/books/user-guide/assemblies/getting-started.adoc
@@ -33,7 +33,7 @@ include::modules/installing-router.adoc[leveloffset=+1]
include::modules/viewing-default-router-configuration-file.adoc[leveloffset=+1]
// Starting the router
-include::modules/starting-router.adoc[leveloffset=+1]
+include::modules/starting-router-getting-started.adoc[leveloffset=+1]
// Sending some test messages
include::modules/sending-test-messages.adoc[leveloffset=+1]
diff --git a/docs/books/user-guide/book.adoc b/docs/books/user-guide/book.adoc
index bb22571..d291db5 100644
--- a/docs/books/user-guide/book.adoc
+++ b/docs/books/user-guide/book.adoc
@@ -40,6 +40,7 @@ include::routing.adoc[leveloffset=+1]
[id="monitoring-managing-router-network"]
== Monitoring and managing the router network
+include::modules/starting-routers.adoc[leveloffset=+2]
include::logging.adoc[leveloffset=+2]
include::using-console.adoc[leveloffset=+2]
include::monitoring-using-qdstat.adoc[leveloffset=+2]
diff --git
a/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc
b/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc
index 6bc9e05..6d2b698 100644
---
a/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc
+++
b/docs/books/user-guide/modules/connecting-using-mutual-ssl-tls-authentication.adoc
@@ -33,7 +33,7 @@ You can connect to an external AMQP container (such as a
broker) using mutual SS
* A security certificate must be generated for the router and be signed by the
CA.
.Procedure
-
+{FragmentDir}
include::{FragmentDir}/fragment-router-open-config-file-step.adoc[]
. If the router does not contain an `sslProfile` that defines the private keys
and certificates to connect to the external AMQP container, then add one.
diff --git a/docs/books/user-guide/modules/starting-router.adoc
b/docs/books/user-guide/modules/starting-router-getting-started.adoc
similarity index 92%
rename from docs/books/user-guide/modules/starting-router.adoc
rename to
