Writer instructions

Page title

For most spaces, this page must be titled Space announcements.

For spaces with localized content, this page must be titled Space announcements l10n.

Purpose

Provide an announcement banner on every page of your space.

Location

Move this page outside of your home branch.

Guidelines

Limited supportBMC provides limited support for this version of the product. As a result, BMC no longer accepts comments in this space. If you encounter problems with the product version or the space, contact BMC Support.BMC recommends upgrading to the latest version of the product. To see documentation for that version, see MainView Middleware Monitor 9.2.

Running the Apache ActiveMQ monitoring extension

The MainView Middleware MonitorApache ActiveMQ monitoring extension uses JMX to gather monitoring information from Apache ActiveMQ brokers. The extension periodically (customizable interval) polls the JMX monitoring interface and retrieves configuration and statistical information from the monitored Apache ActiveMQ broker.

The JMX configuration and monitoring capabilities of Apache ActiveMQ are documented on the Apache ActiveMQ website.

As this information is gathered on a regular sample interval similar to every other MainView Middleware Monitorextension, all the features of the MainView Middleware Monitor product are available to Apache ActiveMQ users.

Viewing Apache ActiveMQ information

Once the extension is connected to an Apache ActiveMQ broker information from the broker appears under an ActiveMQ JMX Connection in the Monitor Console physical tree.

Discovered brokers and subordinate objects are visible in the Object Repository.

Configuring the Apache ActiveMQ broker for monitoring

The MainView Middleware Monitor Apache ActiveMQ extension uses Java Management Interface (JMX) to gather monitoring information from the broker.

The Apache ActiveMQ broker must have JMX monitoring enabled. JMX security should be configured to enable SSL for the JMX connector and JMX authentication if required.

Refer to the Apache ActiveMQ documentation for JMX monitoring configuration details.

Configuring the Apache ActiveMQ monitoring extension on Windows and UNIX

This section describes how to configure the MainView Middleware Monitor Apache ActiveMQ monitoring extension to connect to an Apache ActiveMQ broker.

To configure the Apache ActiveMQ monitoring extension on Windows:

Additional configuration is required if the Apache ActiveMQ brokers are configured to use SSL for JMX monitoring.

To configure SSL server authentication in the activemq_mon extension:

  1. Provide a Java KeyStore file configured with the trust materials for the Apache ActiveMQ brokers being monitored.
  2. Edit the activemq_mon.conf file and uncomment the following lines, setting the truststore name and password as appropriate.
  • Set these additional parameters to configure TLS for JMX server authentication

  • The trustStore should contain the certificate used by the ActiveMQ broker JMX connector

    wrapper.java.additional.2=-Djavax.net.ssl.trustStore=broker.ts
    wrapper.java.additional.3=-Djavax.net.ssl.trustStorePassword=password

To configure SSL client authentication in the activemq_mon extension:

  1. Provide a Java KeyStore file configured with the key materials for the extension.
  2. Edit the activemq_mon.conf file and uncomment the following lines, setting the keystore name and password as appropriate.
  • Set these additional parameters to configure TLS for client authentication

  • The keyStore should contain the client certificate, which should be trusted by the ActiveMQ broker JMX connector

    wrapper.java.additional.4=-Djavax.net.ssl.keyStore=client.ts
    wrapper.java.additional.5=-Djavax.net.ssl.keyStorePassword=password

    The extension must be restarted to affect these changes.

    Additional configuration for JMX security can be set using extension preferences.

To configure the Apache ActiveMQ monitoring extension on UNIX

 Additional configuration is required if the Apache ActiveMQ brokers are configured to use SSL for JMX monitoring.

To configure SSL server authentication in the activemq_mon extension:

  1. Provide a Java KeyStore file configured with the trust materials for the Apache ActiveMQ brokers being monitored.
  2. Edit the activemq_mon.sh file and uncomment the following lines, setting the truststore name and password as appropriate.
  • Set these parameters to configure TLS for JMX server authentication

  • The trustStore should contain the certificate used by the ActiveMQ broker JMX connector

    EXT_SSL_PARAMS="$EXT_SSL_PARAMS -Djavax.net.ssl.keyStore=client.ts -Djavax.net.ssl.keyStorePassword=password"

To configure SSL client authentication in the activemq_mon extension:

  1. Provide a Java KeyStore file configured with the key materials for the extension.
  2. Edit the activemq_mon.sh file and uncomment the following lines, setting the keystore name and password as appropriate.
  • Set these parameters to configure TLS for client authentication

  • The keyStore should contain the client certificate, which should be trusted by the ActiveMQ broker JMX connector

    EXT_SSL_PARAMS="$EXT_SSL_PARAMS -Djavax.net.ssl.keyStore=client.ts -Djavax.net.ssl.keyStorePassword=password"

    The extension must be restarted to affect these changes.

  • Additional configuration for JMX security can be set using extension preferences.

Set Extension Preferences to Monitor Apache ActiveMQ Brokers

Extension preferences are used to control which Apache ActiveMQ brokers are available for monitoring.  An Apache ActiveMQ broker has a URL that describes the hostname and port on which JMX monitoring information is available. For example, “service:jmx:rmi:///jndi/rmi://my-broker-host:1099/jmxrmi”.

When the URL is provided to the extension a JMX connection is established, and the brokers and subordinate objects are discovered and made available for monitoring. The broker objects can then be selected for monitoring either explicitly through the MVMM Object Repository, or by applying an MVMM Policy.

Example

To discover a broker on host “my-broker-host”, port 1099, use “agentpref” to set a URL preference for the broker

agentpref --set "ActiveMQ Monitor” --pref_path ComBmcActiveMQJMXConnection myBrokerName URL service:jmx:rmi:///jndi/rmi://my-broker-host:1099/jmxrmi

Note

The name (“myBrokerName” in the above example) is meaningful only to MainView Middleware Monitor, and need not map to any name in the Apache ActiveMQ configuration.

If JMX Security credentials are required they can be specified as additional preferences values.

Example

agentpref --set “ActiveMQ Monitor” --pref_path ComBmcActiveMQJMXConnection 

myBrokerName URL service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi JMXUser admin JMXPassword OBF:1unj1u9h1w261x821x8s1w1c1ua11uof

Note

Passwords will be encoded in an encoding supported by the extension. However you may provide the value encoded and the value will be re-encoded to the supported encoding. Supported encodings are: OBF, Base64, Cryptor and Cloaker.

The supported extension preferences are:

Preference Name

Value

Example

URL

String. Required.

service:jmx:rmi:///jndi/rmi://localhost:1099/jmxrmi

JMXUser

String. Optional.

admin

JMXPassword

String.

Plaintext or OBF encoded.

Optional.

OBF:1unj1u9h1w261x821x8s1w1c1ua11uof

 

Selective Monitoring of Apache ActiveMQ Brokers

The MainView Middleware Monitor Object Repository can be used select Apache ActiveMQ Brokers and subordinate objects for monitoring. Use the Object Repository tab in the Monitor Console to explore the broker objects and monitoring options, or use the “repomgr” command line tool to control monitoring options.

MainView Middleware Monitor Monitoring Policies can be used to automate the selection of Apache ActiveMQ Brokers and subordinate objects for monitoring. Review the Apache ActiveMQ technology sample policies provided in the Monitor Console to see examples.

Apache ActiveMQ allows for selective registration of JMX MBeans in the broker itself. This can be an effective way to exclude selected objects from JMX monitoring entirely.


Example

The following can be added to the “activemq.xml” configuration file for an Apache ActiveMQ broker to suppress registration of JMX MBeans with a matching destination name:

<managementContext>

<managementContext suppressMBean="destinationName=Uninteresting.destinations.*"/>

</managementContext>

Refer to the Apache ActiveMQ documentation for more information on Selective MBean Registration. Broker objects suppressed in this way are not visible to the MainView Middleware Monitor monitoring extension at all.

Controlling the Apache ActiveMQ monitoring extension on Windows and UNIX

This section describes how to start, stop, and otherwise run the MainView Middleware Monitor  Apache ActiveMQ monitoring extension.

For each of the following procedures, first open a command prompt and change directories to the 'activemq' directory created when installing the monitoring extension. Then enter the monitoring extension command followed by the required parameter.

To get usage information from the monitoring extension

  • On Windows, enter: bin\activemq_mon --help
  • On UNIX, enter: ./bin/activemq_mon -–help

To check if the monitoring extension is running

  • On Windows, enter: bin\activemq_mon --status
  • On UNIX, enter: ./bin/activemq_mon –-status

To start the monitoring extension

  • On Windows, enter: bin\activemq_mon --start
  • On UNIX, enter: ./bin/activemq_mon –-start

To stop the monitoring extension

  • On Windows, enter: bin\activemq_mon --stop
  • On UNIX, enter: ./bin/activemq_mon –-stop

To install the monitoring extension as a Windows service

On Windows, enter: bin\activemq_mon --install

To remove the monitoring extension as a Windows service

On Windows, enter: bin\activemq_mon --remove

To run the monitoring extension in console mode

  • On Windows, enter: bin\activemq_mon --console
  • On UNIX, enter: bin/activemq_mon --console

Troubleshooting the Apache ActiveMQ monitoring extension

This section details the steps necessary to switch on monitoring extension logging for BMC Support.

To switch on logging for the Apache ActiveMQ monitoring extension

  1. Edit the qplog.props file, found in the following locations:
    • Windows: <AGENT INSTALL>\activemq
    • UNIX: <AGENT INSTALL>/activemq

    1. Change these lines:

      log4j.logger.com.bmc.mmpa.ext.framework.treedump.sample.send=debug
      log4j.logger.com.mqsoftware.Extensions.jmx.JMXFrameworkExtension=debug=info
      log4j.appender.R.MaxFileSize=5MB
      To

  3.      log4j.logger.com.bmc.mmpa.ext.framework.treedump.sample.send=debug
         log4j.logger.com.mqsoftware.Extensions.jmx.JMXFrameworkExtension=debug=debug

               log4j.appender.R.MaxFileSize=50MB

  4. Restart the monitoring extension.
  5. Send in the log, which is found in the locations listed below, to BMC Customer Support:
  • Windows: <AGENT_INSTALL>\activemq\activemq_mon.log
  • UNIX: <AGENT_INSTALL/activemq\activemq_mon.log

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*