Oracle® Coherence Monitor -
System
Requirements and SetupThis
page describes the system requirements and setup for the Oracle
Coherence Monitor (OCM). 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 the OCM is only available if you
have specifically requested to receive the Enterprise RTView for Oracle
Coherence product.
There are two ways the
Oracle Coherence Monitor can communicate with a Coherence cluster: via remote
JMX port or as a management node. System requirements and setup are
significantly different depending on which option you select. Before reviewing
the system requirements and setup below, refer to Oracle
Coherence Monitor Communication Options to select a communication mode.
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.html.
Run
via Remote JMX Port
If
you will be running Enterprise RTView via remote JMX port, the Coherence
installation does not need to be on the system where you run Enterprise RTView.
Instead, the Coherence installation 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. NOTE: If
you choose to run the simulated cluster,
the Coherence installation needs to be on the system where you run Enterprise
RTView.
Run
as Management Node
If you
will be running the OCM 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 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 MB by setting your RTV_JAVAOPTS
to -Xmx256m. Additional setup requirements depend
on whether you choose to run the OCM via remote JMX port or as a management node. Run
via Remote JMX 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. Refer to 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.
Refer to
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. Refer to your Coherence documentation for more
information.
3. Finally, include the
following .jar files in your CLASSPATH or RTV_USERPATH:
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. Refer to 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 development or production
mode. See tangosol.coherence.mode in your Coherence documentation for
more information. |
COHERENCE_OVERRIDE |
Deployment
configuration override file name. 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: To easily setup
these environment variables, two scripts (myocm_setup.bat
and myocm_setup) are provided in demos\ocmdemo. Modify the
appropriate script for your platform with the correct values for your system and
then run that script whenever you need to set these environment variables.
|