Oracle Coherence Monitor User Guide

Oracle Coherence Monitor

User Guide

Configuring a Direct Connection
This section provides step-by-step instructions for configuring a direct connection to acquire data from the cluster. This method requires the OC Monitor Data Server to join the cluster as a node. For an overview, see the Direct Connection system diagram.

All Coherence parameters, options, configuration files and JAR files used by existing cluster nodes must be made available for Data Server configuration. This includes JARs that contain custom MBeans, patches, cluster configuration file, cache configuration file, POF configuration file and any configuration files that they reference.

These instructions assume you have a project directory, as described in OCM Setup. The rtview.properties file is located in your project directory.

To Get Coherence Parameters
If the Java properties and class path used by the cluster you want to monitor are not readily available from cluster design documents, cluster launch scripts, or knowledgeable personnel, the following steps might assist with discovery of the required settings.

Use the Coherence MBeanConnector to add a management node to your cluster as described in section 2.2.3 Setting Up the Coherence MBean Connector at the following link: http://docs.oracle.com/cd/E18686_01/coh.37/e18682/jmx.htm#CEGBECFH
Adjust JVM options and the class path as needed so that the MBean Connecter joins the cluster.
Use jconsole to connect to the MBean Connector node, and verify that all Coherence MBeans appear in the jconsole Mbeans tab. (Cache,Cluster,Connection,ConnectionManager,Node,Platform,Service,StorageManager).
Save the JVM options, and class path settings that work with the MBean Connector for later use in OCM configuration.

To configure a direct connection perform the following steps.
1. Open the rtview.properties file, located in the ocmon/projects/sample directory, in a text editor and make the following changes:

sl.rtvapm.ocmon.node=true
Set Coherence Properties for Cluster Node configuration. OC Monitor property files support the following Coherence command line override properties (and any other property that begins with tangosol):
        tangosol.coherence.cluster
        tangosol.coherence.clusteraddress
        tangosol.coherence.clusterport
        tangosol.coherence.edition
        tangosol.coherence.mode
        tangosol.coherence.wka
        tangosol.coherence.wka.port
        tangosol.coherence.localhost
        tangosol.coherence.localport
        tangosol.coherence.override
        tangosol.coherence.cacheconfig
        tangosol.coherence.management.refresh.policy
        tangosol.coherence.management.refresh.expiry
Define values for the properties that your cluster nodes use to join the cluster.
Uncomment, and set the value of the sl.rtvapm.ocmon.jmxconn property to the desired name of the direct connection. Typically, the name of the cluster is used for this value (or, if the cluster does not have a Coherence cluster name, a unique name is used).

Example:
sl.rtvapm.ocmon.jmxconn=DevClusterA

NOTE: The name specified for the sl.rtvapm.ocmon.jmxconn property (in Direct Connection mode) is also used to identify the cluster in alerts and data persisted in the database. Because data from multiple databases might subsequently be combined, best practices dictate that a globally unique identifier be specified for cluster names to easily identify data from each cluster.

2. Using the Jar Properties information you previously obtained:

Add the path to the Coherence JAR files required by the existing cluster to sl.rtview.cp=. Include any patch JARs used by cluster nodes, as well as the paths to JAR files for POF serialization. Use one entry per sl.rtview.cp property instance as they are combined into a cumulative classpath.

Windows Example:
sl.rtview.cp=c:\coherence352\lib\coh-352-patch-01.jar sl.rtview.cp=c:\coherence352\lib\coherence.jar

Add the path to the database JDBC driver, and other required JAR files, using additional sl.rtview.cp= property values.

Add JVM options as sl.rtview.jvm= property values.

Example:
sl.rtview.jvm=-Dtangosol.coherence.mbeans=/sl-custom-mbeans.xml

3. If none of the following are true, skip this Step. If any of the following are true, complete this Step:

the existing cluster uses Java authentication features.

additional Tangosol/Coherence properties or options are needed.

additional JAR files are needed to connect to the cluster.

additional JAR files are needed to support custom and third party MBeans.

additional JAR files are needed for database access.

additional file paths are needed for Coherence configuration files such as POF configuration.

If any of the above are true, edit the rtview.properties file as follows:

Add the paths to JAR files required to join the cluster as sl.rtview.cp=property values.

Add the paths needed for JAR and Coherence configuration file directories required by the existing cluster, third party applications or database as sl.rtview.cp=property values.

Add additional Coherence overrides and Java security properties used by the existing cluster as sl.rtview.jvm=property values.

4. Save the file.

Proceed to Verifying Your Configuration.

RTView contains components licensed under the Apache License Version 2.0.

JMS, JMX and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. They are mentioned in this document for identification purposes only.

SL, SL-GMS, GMS, RTView, SL Corporation, and the SL logo are trademarks or registered trademarks of Sherrill-Lubinski Corporation in the United States and other countries. Copyright © 1998-2013 Sherrill-Lubinski Corporation. All Rights Reserved.

	Add the path to the Coherence JAR files required by the existing cluster to sl.rtview.cp=. Include any patch JARs used by cluster nodes, as well as the paths to JAR files for POF serialization. Use one entry per sl.rtview.cp property instance as they are combined into a cumulative classpath.
		Windows Example: sl.rtview.cp=c:\coherence352\lib\coh-352-patch-01.jar sl.rtview.cp=c:\coherence352\lib\coherence.jar

	Add the path to the database JDBC driver, and other required JAR files, using additional sl.rtview.cp= property values.

	Add JVM options as sl.rtview.jvm= property values.
		Example: sl.rtview.jvm=-Dtangosol.coherence.mbeans=/sl-custom-mbeans.xml

	the existing cluster uses Java authentication features. additional Tangosol/Coherence properties or options are needed. additional JAR files are needed to connect to the cluster. additional JAR files are needed to support custom and third party MBeans. additional JAR files are needed for database access. additional file paths are needed for Coherence configuration files such as POF configuration.
	If any of the above are true, edit the rtview.properties file as follows:

		Add the paths to JAR files required to join the cluster as sl.rtview.cp=property values.
		Add the paths needed for JAR and Coherence configuration file directories required by the existing cluster, third party applications or database as sl.rtview.cp=property values.
		Add additional Coherence overrides and Java security properties used by the existing cluster as sl.rtview.jvm=property values.