Tuesday, September 13, 2011

I Don't Need To Read The Manual...Spring Integration and JMX

Enabling JMX Monitoring with Spring Integration

The title pretty much says it all.  This seems like a pretty simple task, right?  I thought that I would just go to the Spring Integration reference documentation, follow the instructions, and boom, you can see all of your Spring Integration components via JMX from your favorite JMX monitoring client.  If only it were that easy.  The first hurdle I encountered was that the documentation at Spring's site fails to mention how to get the JMX schema included in your integration.xml or where the parsers/handlers live in the Spring library so that it can actually load and parse the integration.xml file.  The second is that there appears to be some typos in it (it should be "jmx:mbean-export", not "jmx:mbean-exporter" and the attributes of that tag are also listed incorrectly). Grr (I guess you get what you pay for). So, without further ado, this is how to turn on the MBean Exporter for Spring Integration:
  1. Declare the "jmx" namespace in your integration.xml file: 
  2. Add the "jmx" schema to the "schemaLocation" attribute:
    xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
        http://www.springframework.org/schema/integration/jmx http://www.springframework.org/schema/integration/jmx/spring-integration-jmx-2.0.xsd
        http://www.springframework.org/schema/integration http://www.springframework.org/schema/integration/spring-integration-2.0.xsd"
  3. Declare the MBean server bean: 
  4. Declare the Integration MBean Exporter: 
  5. Add the spring-integration-jmx library to your classpath.

1 comment:

  1. Jon, this is obvious to any 5 year old. To enable the JMX agent for local access, set this system property when you start the JVM or Java application:


    Setting this property registers the JVM instrumentation MBeans and publishes the RMI connector via a private interface to allow JMX client applications to monitor a local Java platform, that is, a JVM running on the same machine.

    For example, to enable the JMX agent for the J2SE sample application Notepad:

    cd JDK_HOME/demo/jfc/Notepad
    java -Dcom.sun.management.jmxremote -jar Notepad.jar

    where JDK_HOME is the directory where the JDK is installed.

    Limitation: On Windows, for security reasons, local monitoring and management is only supported if your default Windows temporary directory is on a file system that supports setting permissions on files and directories (for example, on an NTFS file system). It is not supported on a FAT file system that provide insufficient access controls.

    Durr. Now get back to synergizing and shifting paradigms.

    (THIS is why you can't have a nice blog.)