Using JON with AMQ Broker
For Use with AMQ Broker 7.8
Abstract
Chapter 1. Overview
JBoss Operations Network (JON) is an enterprise, Java-based administration and management platform that you can use to develop, test, deploy, and monitor JBoss middleware applications. JON is based on RHQ. When using the JON platform to manage AMQ Brokers, the system comprises three components:
- JON server
- JON agent
- Plug-in pack
The AMQ Broker plug-in is a connector that enables the JON Agent to collect information about the message brokers running in your JBoss environment.
1.1. Key Features
With the AMQ Broker plug-in for JON, you can:
- Discover and maintain an inventory of AMQ Brokers.
- Store, manage, and update AMQ Broker configurations.
- Detect configuration change, correlate them with performance history, and roll back.
- Automate and schedule execution of operations for managed resources and resource groups.
1.2. Supported Configurations
The supported configurations for both AMQ broker and JON server apply when you are using them together. Ensure that your systems align with the configurations documented in the following Knowledgebase articles:
Chapter 2. Installation
This chapter describes the prerequisites for installing the AMQ Broker plug-in and the process for obtaining and installing it.
2.1. Prerequisites
Before you can install the AMQ Broker plug-in, the following components must be installed, configured, and running:
- JBoss ON Server
- AMQ Broker
- JON Agent
Related information
2.2. Downloading and Installing the AMQ Broker Plug-in
JON uses plug-ins to handle specific JBoss resources, such as AMQ or EAP, and other applications. JON resource plug-ins are distributed in “plug-in packs” that are distributed separately from the JON Server and JON Agents. Plug-in packs may also require a separate subscription to download them.
When you install a plug-in pack on the JON server, its contents are available for download by JON agents. As a result, JBoss resources can be discovered and imported into the inventory to be managed.
To download and install the plug-in pack, complete the following steps:
- Log in to the Red Hat Customer Portal and navigate to the Software Download page.
- Select JBoss ON for AMQ from the Product drop-down menu. The Software Downloads page reloads and displays available releases.
- Select Download. A dialog prompts you to open or save the zip archive file.
Save the zip archive and extract the files to a temporary directory, for example:
[smith@server rhq-agent]$ unzip jon-plugin-pack-3.3.zip -d /tmp
This creates a subdirectory with the name
jon-plugin-pack-3.3.Copy the extracted plug-in JAR files from the
jon-plugin-pack-plugin_3.3/directory to the JBoss ON server plug-in directory. For example:[root@server rhq-agent]# cp /tmp/jon-plugin-pack-plugin_3.3/*.jar /opt/jon/jon-server-3.3.GA/plugins
2.3. Updating the Plug-ins on the JON Server
On stand-alone platforms, prompt the JBoss ON server to update its plug-ins by either restarting the server or by using the JON web interface, as follows:
- Click Administration > Configuration > Agent Plugins.
- Click Scan For Updates in the bottom left corner.
- Locate Red Hat JBoss AMQ 7 in the list of agent plug-ins and verify that the Last Updated timestamp is current.
On managed platforms, you can prompt agents to manually reload their plug-ins by using the plugins command:
[jsmith@server ~]$ agentRoot/rhq-agent/bin/rhq-agent.sh > plugins update
Alternatively, if the agents are imported into the JON inventory, this can be done in the JON GUI by scheduling an update plugins operation for an agent or a group of agents. To do so, select the agent resource entry in the inventory, open the Operations tab, and schedule the update plug-ins operation.
Related information
Chapter 3. Configuration
3.1. Configuring Authorization
AMQ Broker has role based access control (RBAC) that is used to restrict access to the attributes and methods of MBeans. For instructions on how this is configured see Configuring AMQ Broker.
If the broker is configured to use RBAC then the JON plugin must be configured with the correct username and password so that the plugin can authenticate against the broker. Once authenticated any access to MBeans will be restricted based on the BROKER_INSTANCE_DIR/etc/management.xml configuration file.
The JON plugin’s default user is 'admin' and default password is 'activemq'. You can configure the plugin to use a different user/password to connect to the broker. When the JON plugin is being initiated, it loads the JMX credentials from a configuration file located at BROKER_INSTANCE_DIR/etc/org.jboss.rh-messaging.amq.jon.cfg
This configuration file will look something like this.
principal = username credentials = password connectorAddress = service:jmx:rmi:///jndi/rmi://localhost:11099/jmxrmi
This configuration file also contains the connectorAddress property which is the JMX address that the plugin will use to connect to the broker.
3.2. Populating the Inventory
The Inventory is where all manageable resources and groups are shown. To populate the AMQ Broker resources, perform the following steps:
- Click Resources > Discovery Queue in the left navigation pane. At least one resource, an AMQ Broker instance, is displayed in the Discovery Queue window.
- Expand the broker resource entry by clicking the down arrow in the Resource Name column. Sub-entries for at least two servers are displayed, including the AMQ 7 Server and the JMX server. The AMQ 7 Server is the entity for which we need to populate the inventory.
- In the Resource Name column, click the checkbox next to the AMQ 7 Server sub-entry. Note that the Import and Ignore buttons are enabled in the bottom left part of the window. Click Import.
- A Question dialog opens and asks if you want to discover the platform children. Click Yes. You should see a confirmation message stating that the resources were successfully imported.
- Verify that the import was successful by clicking Resources > Platform in the left navigation pane. You should see multiple entries running in the Platforms window, such as the AMQ Server and the JON Server.
Chapter 4. Management
4.1. Browsing Broker Information
Now that you’ve populated the inventory with details about your AMQ 7 Server, you can browse information about most aspects of your AMQ Broker instances. To view details about AMQ 7 Servers, perform the following steps:
- Click Resources > Servers - Top Level Imports to view the AMQ 7 Server in the Servers - Top Level Imports window.
- Double-click the AMQ 7 Server entry. The left navigation pane now displays the AMQ Server and the areas into which you can drill down to view detailed data about your message brokers, acceptors, addresses, and more.
- With each level you drill down into the hierarchy, the main window displays detailed information specific to the AMQ Server you selected. In addition, the main window includes a set of tabs such as Summary, Inventory, Alerts, Monitoring, and Events that you can use to view different aspects of the entities you’ve selected on the left.
4.2. Managing Brokers
You can perform myriad monitoring, deployment, and management operations by using JON. It’s strongly recommended that you browse the JON guide titled Using JBoss Operations Network for Monitoring, Deploying, and Managing Resources to ensure that you’re taking advantage of all the benefits that JON has to offer.
Related information
Using JBoss Operations Network for Monitoring, Deploying, and Managing Resources
Appendix A. Using your subscription
AMQ is provided through a software subscription. To manage your subscriptions, access your account at the Red Hat Customer Portal.
A.1. Accessing your account
Procedure
- Go to access.redhat.com.
- If you do not already have an account, create one.
- Log in to your account.
A.2. Activating a subscription
Procedure
- Go to access.redhat.com.
- Navigate to My Subscriptions.
- Navigate to Activate a subscription and enter your 16-digit activation number.
A.3. Downloading release files
To access .zip, .tar.gz, and other release files, use the customer portal to find the relevant files for download. If you are using RPM packages or the Red Hat Maven repository, this step is not required.
Procedure
- Open a browser and log in to the Red Hat Customer Portal Product Downloads page at access.redhat.com/downloads.
- Locate the Red Hat AMQ entries in the INTEGRATION AND AUTOMATION category.
- Select the desired AMQ product. The Software Downloads page opens.
- Click the Download link for your component.
A.4. Registering your system for packages
To install RPM packages for this product on Red Hat Enterprise Linux, your system must be registered. If you are using downloaded release files, this step is not required.
Procedure
- Go to access.redhat.com.
- Navigate to Registration Assistant.
- Select your OS version and continue to the next page.
- Use the listed command in your system terminal to complete the registration.
For more information about registering your system, see one of the following resources:
Revised on 2020-12-03 08:53:12 UTC
