JMX Configuration File

Copyright © Cloud Software Group, Inc. All Rights Reserved

Chapter 3 Configuration : JMX Configuration File

JMX Configuration File

The following table describes the top level <JMXConfiguration> element of the JMXPluginConfig.xml configuration file.

JMXConfiguration

MethodTimeout

The method timeout value in seconds.

Default value is 10 (seconds).

PluginDirectory

The location of the JMX plug-in directory.

The default location is TIBCO_HOME/hawk/<version>/plugin.

TraceDirectory

Location of the trace directory.

The default location is TIBCO_HOME/hawk/<version>/plugin/jmx/log.

TraceFilename

The name of the trace file.

The default name is jmxTrace.log.

AddMeanServerName

If this property is set to true the Hawk microagent name for every MBean discovered by the plug-in will include the MBeanServer name.

The default value is false.

TraceLevel

The trace level used by the plug-in.

The trace level is expressed as the sum of any of the following valid values:

-1 (All), 0 (always), 1 (Info), 2 (Warning), 4 (Error), and 8 (Debug).

The default value is 7 (which is Info+Warning+Error).

MBeanServerList

The list of MBean servers to which the plug-in connects to.

MBeanServer

This element provides connection information for a specific MBean server.

•

name: The name given to the MBean server

•

type: The type of the MBean server. Valid values are:

−

JSR160, (for Tomcat, JVM, JBOSS)

−

WebSphere (for IBM WebSphere)

−

WebLogic (for Oracle WebLogic)

•

JMXClassPath: The class path to the vendor specific MBean server jar files.

When connecting to multiple MBean servers, this element has to be replicated with one <MBeanServer> element for each MBean server.

ParameterList

The list of parameters used to connect to the MBean Server.This element consists of name-value pairs.

For information on customizing this element for the supported application server, see Customizing the MBeanServer Element. Additional parameters can be specified using name-value pairs.

Customizing the MBeanServer Element

The <MBeanServer> element of the configuration file contains connection information for each MBean sever. This filter is a list, delimited by ’;’, of the MBeans that you are interested in exposing as TIBCO Hawk microagents.The following sections describe in details in the information required by each supported servers.

JSR 160 compliant App Servers: JVM and Tomcat

The plug-in provides two different JSR 160 implementations; one for JVM and the other one for Tomcat.

For Tomcat, to enable JMX, set CATALINA_OPTS property to -Dcom.sun.management.jmxremote
-Dcom.sun.management.jmxremote.port=%my.jmx.port%
-Dcom.sun.management.jmxremote.ssl=false
-Dcom.sun.management.jmxremote.authenticate=false

For additional information on JMX configuration in Tomcat, refer to http://tomcat.apache.org/tomcat-7.0-doc/monitoring.html.

The <JMXClassPath> element can be defined as <JMXClassPath>;</JMXClassPath>

To connect to the Application server you need to specify:

•

JMXServiceURL, the connection URL to connect to the MBean server.

•

login and password, which are the used to connect to the application server.

•

MBeanFilter, which is the list of MBean(s) that you are interested in. If the MBeanFilter has a null value or if the MBeanFilter element is not used, all MBeans are accessed.

Example: JVM

<MBeanServer name="J2SE5JVM" type="JSR160">

<JMXClassPath>;</JMXClassPath>

<ParameterList>



<param name = "JMXServiceURL" value = "service:jmx:rmi:///jndi/rmi://localhost:6580/jmxrmi"/>



<param name = "login" value = ""/>

<param name = "password" value = ""/>



<param name = "MBeanFilter" value = "java.lang:*"/>

</ParameterList>

</MBeanServer>

Example: Tomcat

<MBeanServer name="RMI1234" type="JSR160">

<JMXClassPath>;</JMXClassPath>

<ParameterList>



<param name = "JMXServiceURL" value = "service:jmx:rmi://localhost/jndi/jrmp"/>



<param name = "login" value = ""/>

<param name = "password" value = ""/>



<param name = "MBeanFilter" value = "JMImplementation:type=MBeanServerDelegate;MyDomain:*"/>



</ParameterList>

</MBeanServer>

JBoss App Server

The <JMXClassPath> element should be defined as:

<JBOSS_HOME>/bin/client/jboss-client.jar

where, <JBOSS_HOME> is the JBOSS installation directory.

To connect to the JBoss server, you need to specify:

•

JMXServiceURL, the connection URL to connect to the MBean server.

•

MBeanFilter, the list of MBeans that you are interested in.

Example

<MBeanServer name="JBOSS1" type="JSR160">

<JMXClassPath>c:/jboss-as-7.1.1.Final/bin/client/jboss-client.jar</JMXClassPath>

<ParameterList>

<param name = "JMXServiceURL" value = "service:jmx:rmi:///jndi/rmi://localhost:57571/Member1"/>



<param name = "login" value = ""/>

<param name = "password" value = ""/>



<param name = "MBeanFilter" value = "JMImplementation:*;MletAgent:*"/>

</ParameterList>

</MBeanServer>

Oracle WebLogic App Servers

To connect to Weblogic on a local machine, define the <JMXClassPath> element as <WEBLOGIC_HOME>/wlserver/server/lib/weblogic.jar.

To connect to Weblogic on a remote machine, define the <JMXClassPath> element as <WEBLOGIC_HOME>/wlserver/server/lib/wlfullclient.jar. For more information on how to build the wlfullclient.jar, refer to https://docs.oracle.com/middleware/1212/wls/SACLT/jarbuilder.htm#SACLT240.

<WEBLOGIC_HOME> in the above paths is your WebLogic installation directory.

To connect to the Oracle WebLogic server you need to specify:

•

JNDIUrl, which is the location of the JNDI name server.

•

User, which is the username used to connect to the server.

•

Password, which is the encrypted password for a valid username used to connect to the server. See Encrypting Password for details on encrypting your password.

•

MBeanFilter, which is the list of MBean(s) that you are interested in.

Example

<MBeanServer name="WebLogic71" type="WebLogic">

<JMXClassPath>C:/Oracle_Home/wlserver/server/lib/weblogic.jar</JMXClassPath>

<ParameterList>



<param name = "JNDIUrl" value = "service:jmx:t3://localhost:7001/jndi/weblogic.management.mbeanservers.domainruntime"/>



<param name = "User" value = "admin"/>



<param name = "Password" value = "EncryptMe"/>







<param name = "MBeanFilter" value = "JMImplementation:type=MBeanServerDelegate;mydomain:Name=myserver,Server=myserver,Type=JTARecoveryService"/>

</ParameterList>

</MBeanServer>

IBM WebSphere App Server

The <JMXClassPath> element when using IBM WebSphere contains the location of the required classes and should be defined as:

<WEBSPHERE_HOME>/AppServer/runtimes/com.ibm.ws.admin.client_8.5.0.jar;<WEBSPHERE_HOME>/AppServer/runtimes/com.ibm.ws.ejb.thinclient_8.5.0.jar;<WEBSPHERE_HOME>/runtimes/com.ibm.ws.orb_8.5.0.jar

where, <WEBSPHERE_HOME> is the WebSphere installation directory.

To connect to the IBM WebSphere server, specify:

•

ConnectorType, the value of this parameter should be set to RMI or SOAP.

•

ConnectorHost, which is the host where the server is running.

•

ConnectorPort, which is the port used for connecting to the server.

•

MBeanFilter, which is the list of MBean(s) that you are interested in.

Example

<MBeanServer name="WebSphere1" type="WebSphere">

<JMXClassPath>C:/IBM/WebSphere/AppServer/runtimes/com.ibm.ws.admin.client_8.5.0.jar;C:/IBM/WebSphere/AppServer/runtimes/com.ibm.ws.ejb.thinclient_8.5.0.jar;C:/IBM/WebSphere/AppServer/runtimes/com.ibm.ws.orb_8.5.0.jar</JMXClassPath>

<ParameterList>

<param name = "ConnectorType" value = "SOAP"/>

<param name = "ConnectorHost" value = "localhost"/>

<param name = "ConnectorPort" value = "8880"/>

<param name = "MBeanFilter" value = "JMImplementation:*"/>

</ParameterList>

</MBeanServer>

Encrypting Password

Follow these steps to encrypt your password:

1.

Invoke the command line using the syntax. The scripts are located in the directory TIBCO_HOME/tibco/cfgmgmt/hawk/bin.

On Microsoft Windows, tibhawkpassword.exe -encrypt

On UNIX, tibhawkpassword.sh -encrypt

2.

Enter the password you want to encrypt when prompted.

3.

Copy and paste the output of the utility within quotes ("") into the configuration file.

4.

Re-start the TIBCO Hawk component whose configuration file you updated in step above.