You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@activemq.apache.org by jb...@apache.org on 2017/08/17 15:09:35 UTC
[2/2] activemq-artemis git commit: ARTEMIS-1346 Add initial
Management Console Documentation
ARTEMIS-1346 Add initial Management Console Documentation
Added some initial documentation
Project: http://git-wip-us.apache.org/repos/asf/activemq-artemis/repo
Commit: http://git-wip-us.apache.org/repos/asf/activemq-artemis/commit/569bd42b
Tree: http://git-wip-us.apache.org/repos/asf/activemq-artemis/tree/569bd42b
Diff: http://git-wip-us.apache.org/repos/asf/activemq-artemis/diff/569bd42b
Branch: refs/heads/master
Commit: 569bd42ba5ff5d9ce38cfa43930268a29d81b3f7
Parents: bcdefde
Author: Michael Andre Pearce <Mi...@me.com>
Authored: Thu Aug 10 16:12:48 2017 +0100
Committer: Justin Bertram <jb...@apache.org>
Committed: Thu Aug 17 10:09:17 2017 -0500
----------------------------------------------------------------------
docs/user-manual/en/SUMMARY.md | 1 +
.../en/images/console-artemis-plugin.png | Bin 0 -> 430028 bytes
docs/user-manual/en/images/console-login.png | Bin 0 -> 1062092 bytes
docs/user-manual/en/management-console.md | 84 +++++++++++++++++++
4 files changed, 85 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/569bd42b/docs/user-manual/en/SUMMARY.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/SUMMARY.md b/docs/user-manual/en/SUMMARY.md
index bc9ac31..68facdc 100644
--- a/docs/user-manual/en/SUMMARY.md
+++ b/docs/user-manual/en/SUMMARY.md
@@ -37,6 +37,7 @@
* [Message Grouping](message-grouping.md)
* [Extra Acknowledge Modes](pre-acknowledge.md)
* [Management](management.md)
+* [Management Console](management-console.md)
* [Security](security.md)
* [Broker Plugins](broker-plugins.md)
* [Resource Limits](resource-limits.md)
http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/569bd42b/docs/user-manual/en/images/console-artemis-plugin.png
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/images/console-artemis-plugin.png b/docs/user-manual/en/images/console-artemis-plugin.png
new file mode 100644
index 0000000..34036a9
Binary files /dev/null and b/docs/user-manual/en/images/console-artemis-plugin.png differ
http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/569bd42b/docs/user-manual/en/images/console-login.png
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/images/console-login.png b/docs/user-manual/en/images/console-login.png
new file mode 100644
index 0000000..7f243bb
Binary files /dev/null and b/docs/user-manual/en/images/console-login.png differ
http://git-wip-us.apache.org/repos/asf/activemq-artemis/blob/569bd42b/docs/user-manual/en/management-console.md
----------------------------------------------------------------------
diff --git a/docs/user-manual/en/management-console.md b/docs/user-manual/en/management-console.md
new file mode 100644
index 0000000..d7956c8
--- /dev/null
+++ b/docs/user-manual/en/management-console.md
@@ -0,0 +1,84 @@
+# Management Console
+
+Apache ActiveMQ Artemis ships by default with a management console. It is powered by [Hawt.io](http://hawt.io).
+
+Its purpose is to expose the [Management API](management.md "Management API") via a user friendly web ui.
+
+
+## Login
+
+To access the management console use a browser and go to the URL [http://localhost:8161/console]().
+
+A login screen will be presented, if your broker is secure, you will need to use a user with admin role, if it is unsecure simply enter any user/password.
+
+
+
+
+## Console
+
+Once logged in you should be presented with a screen similar to.
+
+
+
+#### Navigation Menu
+
+On the top right is small menu area you will see some icons.
+
+- `question mark` This will load the artemis documentation in the console main window
+- `person` will provide a drop down menu with
+- - `about` this will load an about screen, here you will be able to see and validate versions
+- - `log out` self descriptive.
+
+#### Navigation Tabs
+
+Running below the Navigation Menu you will see several default feature tabs.
+
+- `Artemis` This is the core tab for Apache ActiveMQ Artemis specific functionality. The rest of this document will focus on this.
+
+- `Connect` This allows you to connect to a remote broker from the same console.
+
+- `Dashboard` Here you can create and save graphs and tables of metrics available via JMX, a default jvm health dashboard is provided.
+
+- `JMX` This exposes the raw Jolokia JMX so you can browse/access all the JMX endpoints exposed by the JVM.
+
+- `Threads` This allows you to monitor the thread usage and their state.
+
+You can install further hawtio plugins if you wish to have further functionality.
+
+
+
+## Artemis Tab
+
+Click `Artemis` in the top navigation bar to see the Artemis specific plugin. (The Artemis tab won't appear if there is no broker in this JVM). The Artemis plugin works very much the same as the JMX plugin however with a focus on interacting with an Artemis broker.
+
+### Tree View
+
+The tree view on the left-hand side shows the top level JMX tree of each broker instance running in the JVM. Expanding the tree will show the various MBeans registered by Artemis that you can inspect via the **Attributes** tab.
+
+#### Acceptors
+
+This expands to show and expose details of the current configured acceptors.
+
+#### Addresses
+
+This expands to show the current configured available `addresses`.
+
+Under the address you can expand to find the `queues` for the address exposing attributes
+
+
+
+### Key Apache ActiveMQ Artemis Operations
+
+#### Creating a new Address
+
+To create a new address simply click on the broker or the address folder in the jmx tree and click on the create tab.
+
+Once you have created an address you should be able to **Send** to it by clicking on it in the jmx tree and clicking on the send tab.
+
+#### Creating a new Queue
+
+To create a new queue click on the address you want to bind the queue to and click on the create tab.
+
+Once you have created a queue you should be able to **Send** a message to it or **Browse** it or view the **Attributes** or **Charts**. Simply click on the queue in th ejmx tree and click on the appropriate tab.
+
+You can also see a graphical view of all brokers, addresses, queues and their consumers using the **Diagram** tab.