Introduction
QMan is a Management bridge that exposes one (or several) Qpid broker domain model as MBeans that are accessible through the Java Management Extensions (JMX).
How to run QMan
Prerequisites
QMan is a standalone application that is packaged as qpid-management-client-incubating-M3.jar. To run QMan you need to add the following jars in your CLASSPATH:
- log4j-1.2.12.jar
- slf4j-api-1.4.0.jar
- slf4j-log4j12-1.4.0.jar
- commons-pool-1.4.jar
- commons-codec-1.3.jar
- commons-lang-2.2.jar
- commons-collections-3.2.jar
- commons-configuration-1.2.jar
- qpid-client-incubating-Mx.jar (were x is the current qpid version)
- qpid-common-incubating-Mx.jar (were x is the current qpid version)
alternatively you can run the following script (that add all the qpid jars to the CLASSPATH):
> CLASSPATH=`find <lib-root> -name '*.jar' | tr '\n' ":"`
Where <lib-root> is the directory containing the qpid jars (when qpid is built from source <lib-root> is equal to qpid/java/build/lib)
QMan can be connected at run time against any broker. However if you wish to automatically connect to one or several brokers you can do so by providing a configuration file as follows:
<configuration> <brokers> <broker> <host>localhost</host> <port>5672</port> <virtual-host>test</virtual-host> <user>guest</user> <password>guest</password> <max-pool-capacity>4</max-pool-capacity> <initial-pool-capacity>0</initial-pool-capacity> <max-wait-timeout>-1</max-wait-timeout> </broker> <broker> <host>myhost</host> <port>5672</port> <virtual-host>test</virtual-host> <user>guest</user> <password>guest</password> <max-pool-capacity>4</max-pool-capacity> <initial-pool-capacity>0</initial-pool-capacity> <max-wait-timeout>-1</max-wait-timeout> </broker> </brokers> </configuration>
The configuration above specifies that QMan should connect to two brokers, one on localhos and one on myhost, both listening on port 5672.
The configuration file to use is specified through the JVM parameter "qman-config" that must point onto a valid configuration file.
Running QMan
To run QMan in a console run the following command:
java org.apache.qpid.management.domain.services.QMan
Messages similar to those should be displayed:
... [org.apache.qpid.management.domain.services.QMan] <QMAN-000001> : Starting Q-Man... ... Type "q" to quit.
if you wish to use a configuration file <home>/myconfiguration.xml so QMan establishes a connection with one or several brokers, run the following command:
java -Dqman-config="<home>/myconfiguration.xml" org.apache.qpid.management.domain.services.QMan
Stopping QMan
Type "q" In the console from which QMan has been started.
Browsing Manageable Beams
The jconsole tool (JMX-compliant graphical tool for monitoring a Java virtual machine) can be used for monitoring and QMan Mbeans. for more information see http://java.sun.com/javase/6/docs/technotes/guides/management/jconsole.html
The jconsole executable can be found in JDK_HOME/bin, where JDK_HOME is the directory in which the JDK software is installed. If this directory is in your system path, you can start JConsole by simply typing jconsole in a console. Otherwise, you have to type the full path to the executable file.
As jconsole needs to perform operations invocation you will need to add the QMan jar in jconsole classpath. In a console type:
jconsole -J-Djava.class.path=$CLASSPATH:$JAVA_HOME/lib/jconsole.jar:$JAVA_HOME/lib/tools.jar
Where CLASSPATH contains the QMan jars and JAVA_HOME point on your JDK home.
As demonstrated on the following screenshot, once jconsole is running select the MBeans tab and select the Q-MAN set of MBeans.
The screenshot above depicts the value of a queue attributes.
Invoking Operations
jconsole can be used for invoking operations. For example, the following screshot shows the queue message_queue attributes.
We can see that 22 messages have been enqueued when only 11 messages have been dequeued. This means that message_queue contains 11 messages. Let's delete 5 of them! For doing that we must select the operation purge of the queue message_queue. The following screeshot shows that the operation purge has one parameter that specify the number of messages to be discarded.
We invoke the purge operation with 5 messages. The following popup window tells us that the operation has been successfully invoked.
We can now check that 5 messages have been dequeued form message_queue. The following screenshot shows the updated attributes of message_queue.
As shown above there are now 16 messages that have been dequeued.
Deploying the QMan servlet
QMan comes with a servlet that can be deployed in any application server. In the following we show how to deploy the qman servlet within JBoss application server.
Prerequisites
You mus first install JBoss:
- Download the latest stable version from: http://www.jboss.org/jbossas/downloads/
- Unzip the download archive
Run JBoss with the Mbean server:
- Add the following option-Djboss.platform.mbeanserver to JAVA_OPTS (for example: export JAVA_OPTS=-Djboss.platform.mbeanserver)
- Execute <jboss-home>/binrun.sh (or run.bat on a windows platform)