Enterprise RTView® 
User Guide


Oracle Coherence Monitor System Requirements and Setup

This page describes the system requirements and setup for the Oracle Coherence Monitor. Enterprise RTView for Oracle Coherence is a separately licensed product offering available directly from SL Corporation.  Documentation for the Oracle Coherence Monitor is included in every download of Enterprise RTView however it is only available if you have specifically requested to receive the Enterprise RTView for Oracle Coherence product.

There are two options for how  the Oracle Coherence Monitor communicates with a Coherence cluster. The system requirements and setup are different depending on your selected option. See Oracle Coherence Monitor Communication Options for more information and select the communication mode you want to use before reviewing the system requirements and setup below.

System Requirements
In addition to basic system requirements,  the Oracle Coherence Monitor requires the Pure Java version of Coherence 3.3.1+, which you can download at http://www.oracle.com/technology/products/coherence/index.htmlIf you will be running Enterprise RTView as a JMX remote listener, the Coherence installation does not need to be on the system where you run Enterprise RTView (unless you will be running the simulated cluster), it needs to be on the system where you run the management node that is exposing metrics via JMX. This management node must be running on Java version 1.5.0+, but the other nodes in the cluster can run on an older version of Java. If you will be running the monitor as a management node, the Coherence installation needs to be on the system where you run Enterprise RTView.


Setup
In addition to general setup, you must setup your Coherence nodes to generate statistics and you may need to set several environment variables on the system where you run Enterprise RTView. The Oracle Coherence Monitor collects and caches metrics data from all of the nodes in your cluster. This can cause it to use more memory than the default JVM memory allocation. It is recommended that you increase the memory to at least 256 megabytes by setting your RTV_JAVAOPTS to -Xmx256m. Additional setup requirements depend on whether you run the monitor using a JMX remote port or as a Coherence management node.

Run Using as JMX Remote Port:

1. Setup one of the nodes in your cluster to run as a management node and an MBeanServer host. This node must be running on Java version 1.5.0+. Enterprise RTView will connect to the JMX port on this node to monitor all of the nodes in the cluster. Pass the following Java system properties into this node:
-Dtangosol.coherence.management=all 
-Dcom.sun.management.jmxremote.ssl=false 
-Dcom.sun.management.jmxremote.authenticate=false 
-Dcom.sun.management.jmxremote.port=COHERENCE_JMXPORT

Where COHERENCE_JMXPORT is the port you want to use for JMX. The tangosol.coherence.management property sets the node up as the management node and MBeanServerHost. See your Coherence documentation for more information on this property. The sun.management properties set up the connection settings for JMX. If you are using JMX authentication, set sun.management.jmxremote.authenticate to true. See the Sun Java documentation for more information on the sun.management properties.

2. Setup all of the nodes in your cluster that you want to monitor (including the MBeanServer host node) to allow JMX management. Pass the following Java system property into each cluster node:
-Dtangosol.coherence.management.remote=true

This property sets up the node to allow management by the node you setup in step 1. See your Coherence documentation for more information. 

3. Include the following .jar files in your CLASSPATH or RTV_USERPATH:
jmxtools.jar
jmxri.jar.

 

 Run as Management Node:

1. Setup all of the nodes in your cluster that you want to monitor to allow JMX management. Pass the following Java system property into each cluster node:
-Dtangosol.coherence.management.remote=true

This property sets up the node to allow management by the Oracle Coherence Monitor when it runs as a node. See your Coherence documentation for more information.

2. On the system where you will be running Enterprise RTView, setup the following environment variable:
Name Description Example
COHERENCE_HOME Oracle Coherence installation directory.  c:\coherence

3. Additional environment variables may be needed on the system where you are running Enterprise RTView depending on how your Coherence grid is configured. Since Enterprise RTView will run as a cluster node, these properties are needed for the node to access your grid. The setup required will be different for each Coherence grid. Consult with your Coherence grid administrator for the values needed for your particular Coherence environment. These properties can either be set using a cluster configuration files, or by manually setting the following environment variables:

Name Description
COHERENCE_EDITION Specifies the product edition that the member will utilize.  See tangosol.coherence.edition in your Coherence documentation for more information.
COHERENCE_MODE Specifies whether the product is being used in an development or production mode. See tangosol.coherence.mode in your Coherence documentation for more information.
COHERENCE_OVERRIDE Deployment configuration override filename. See tangosol.coherence.override in your Coherence documentation for more information.
COHERENCE_CLUSTER_NAME Name of the cluster. See tangosol.coherence.cluster in your Coherence documentation for more information.
COHERENCE_CLUSTER_ADDRESS Multicast IP address. See tangosol.coherence.clusteraddress in your Coherence documentation for more information.
COHERENCE_CLUSTER_PORT Multicast IP port. See tangosol.coherence.clusterport in your Coherence documentation for more information.
COHERENCE_WKA Well known IP address. See tangosol.coherence.wka in your Coherence documentation for more information.
COHERENCE_WKA_PORT Well known IP port. Part of the well known address scheme. See tangosol.coherence.wka.port in your Coherence documentation for more information.

NOTE: Two scripts, myocm_setup.bat and myocm_setup, are provided in demos\ocmdemo to easily setup these environment variables. Modify the appropriate script for your platform to use the correct values for your system, then run it whenever you want to set these variables in a command or terminal window.

 

 
SL, SL-GMS, GMS, Enterprise 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-2008 Sherrill-Lubinski Corporation. All Rights Reserved.

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