Version

    52. JMX mBean

    JMX Configuration
    How to configure JMX on Apache Tomcat
    Possible Problems
    Operations

    The CloverDX Server JMX mBean is an API that can be used for monitoring the internal status of the Server.

    MBean is registered with the name:

    com.cloveretl.server.api.jmx:name=cloverServerJmxMBean

    JMX Configuration

    By default, application’s JMX MBeans aren’t accessible outside of JVM. Some changes in an application server configuration are required to make JMX Beans accessible.

    This section describes how to configure a JMX Connector for development and testing. Thus authentication may be disabled. For production deployment, authentication should be enabled. For more information, see for example Password Authentication.

    Configurations and possible problems:

    How to configure JMX on Apache Tomcat

    Tomcat’s JVM must be executed with these parameters:

    1. -Dcom.sun.management.jmxremote=true

    2. -Dcom.sun.management.jmxremote.port=8686

    3. -Dcom.sun.management.jmxremote.ssl=false

    4. -Dcom.sun.management.jmxremote.authenticate=false

    5. -Djava.rmi.server.hostname=your.server.domain (necessary only for remote JMX connections)

    On UNIX like OS, set environment variable CATALINA_OPTS, for example:

    export CATALINA_OPTS="-Dcom.sun.management.jmxremote=true
                      -Dcom.sun.management.jmxremote.port=8686
                      -Dcom.sun.management.jmxremote.ssl=false
                      -Dcom.sun.management.jmxremote.authenticate=false
                      -Djava.rmi.server.hostname=your.server.domain.com"

    File TOMCAT_HOME/bin/setenv.sh (if it does not exist, you may create it) or TOMCAT_HOME/bin/catalina.sh

    On Windows, each parameter must be set separately:

    set CATALINA_OPTS=-Dcom.sun.management.jmxremote=true
set CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote.port=8686
set CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote.authenticate=false
set CATALINA_OPTS=%CATALINA_OPTS% -Dcom.sun.management.jmxremote.ssl=false
set CATALINA_OPTS=%CATALINA_OPTS% -Djava.rmi.server.hostname=your.server.domain

    File TOMCAT_HOME/bin/setenv.bat (if it does not exist, you may create it) or TOMCAT_HOME/bin/catalina.bat

    With these values, you can use the URL service:jmx:rmi:///jndi/rmi://localhost:8686/jmxrmi for connection to JMX server of JVM. No user/password is needed

    Possible Problems

    • The default JMX mBean server uses RMI as a transport protocol. Sometimes RMI cannot connect remotely when one of peers uses Java version 1.6. As a solution, simply set these two system properties: -Djava.rmi.server.hostname=[hostname or IP address] -Djava.net.preferIPv4Stack=true

    Operations

    For details about operations, see the JavaDoc of the MBean interface:

    JMX API MBean JavaDoc is accessible in the running CloverDX Server instance on URL: http://[host]:[port]/[contextPath]/javadoc-jmx/index.html