There are two ways the Oracle Coherence Monitor (OCM) can communicate with a Coherence cluster: via remote JMX port or by running the Oracle Coherence Monitor as a management node. System requirements and setup are significantly different depending on which option you select. Before reviewing the options below, please refer to Oracle Coherence Monitor Communication Options to select a communication mode.

Once you have selected a communication mode, you must decide whether you want to deploy as a Java application or as a thin client web application. NOTE: Rich client deployment is not supported for the Oracle Coherence Monitor. See the Deployment section for information on how to select a deployment, then return here for instructions on how to deploy the Oracle Coherence Monitor.

Both the Java application and the thin client browser deployment support a direct connection to the cluster (via remote JMX port or as a management node) or they can both be run as clients of the Data Server. In a Data Server deployment, the Data Server connects to the cluster, gathers and federates data and passes it to the client application via TCP. The client application can be the Oracle Monitor Application, the Display Server, the Historian, or all three. This is useful if you want to run the OCM on another machine that is disconnected from the Coherence cluster or if you want to run multiple OCMs, or a combination of multiple OCMs and the Historian, but limit direct access to the cluster to a single client. See Figure 3 for a diagram of the Data Server connecting to your cluster via remote JMX port and Figure 4 for a diagram of the Data Server connecting to your cluster as a management node.

To run the Oracle Coherence Monitor, Display Server, Data Server, Historian or Report Generator you will use one of the following command line arguments:

NOTE: When using multiple command line arguments, these must come first. For example: run_ocmonitor -ocmnode -u1000 will work; run_ocmonitor -u1000 -ocmnode will not.

Run HSQLDB Database
The Oracle Coherence Monitor, Display Server, Data Server and Historian will try to connect to a Historian database and an alert database at startup. If these databases are not running, history and alert data will not be available in the OCM. By default, the Oracle Coherence Monitor is configured to connect to the HSQLDB database in the demos\ocmdemo directory for both the history and alert data. Unless you have customized the Historian database, or do not want to see history and alert data, be sure this HSQLDB database is running before you start the OCM.

In an initialized command window go to demos\ocmdemo and type:

Type Ctrl-C in the database console to shutdown the database. On shutdown, the database writes all of its memory to rtvhistory.log. When it restarts, it uses this .log file to restore data from the previous session.

If you want to clear the data in the database, in demos\ocmdemo type:

Deploying the Oracle Coherence Monitor as a Java Application
There are four options on how to run the Oracle Coherence Monitor as a Java application:

1. Remote JMX port connected directly to the cluster (Figure 1).
2. Coherence management node connected directly to the cluster (Figure 2).
3. Remote JMX port using the Data Server to connect to the cluster and collect data (Figure 3). 
4. Coherence management node using the Data Server to connect to the cluster and collect data (Figure 4).

If you select Option 1 or 2:
Install, setup and license Enterprise RTView for Oracle Coherence on each system where you will run the OCM and follow instructions in Running the Oracle Coherence Monitor appropriate to which option (1 or 2) you selected.

If you select Option 3 or 4:
Follow the instructions below appropriate to which option (3 or 4) you selected.

Option 3: Run via Remote JMX Port Using the Data Server
In this deployment, the Data Server connects to the management node that you have setup as a JMX MBeanServer host via remote JMX port and collects and federates the data. Multiple Oracle Coherence Monitor clients can connect to the Data Server to receive data.

1. Install, set up and license Enterprise RTView for Oracle Coherence on each system where you will run the OCM. Each system must meet the basic Enterprise RTView system requirements.

2. Set up and run the Data Server using a remote JMX port.

3. On each system where you want to run the OCM, in an initialized command window type (where ipaddress is the IP address for the system where you are running the Data Server):

By default, the Data Server accepts connections on port 3278. See the Data Server section for information on how to modify Data Server settings, as well as how to run the Data Server as a daemon (headless) process. 

Option 4: Run as a Management Node Using the Data Server
In this deployment, the Data Server is run as the management node in your cluster and collects and federates the data. Multiple Oracle Coherence Monitor clients can connect to the Data Server to receive data.

1. Install, set up and license Enterprise RTView for Oracle Coherence on each system where you will run the OCM. Each system must meet the basic Enterprise RTView system requirements.

2. Set up and run the Data Server as a management node.

3. On each system where you want to run the OCM, in an initialized command window type (where ipaddress is the IP address for the system where you are running the Data Server):

By default, the Data Server accepts connections on port 3278. See the Data Server section for information on how to modify Data Server settings, as well as how to run the Data Server as a daemon (headless) process. 

NOTE: On UNIX, passing the $conn substitution as a command line argument requires a \ before the $ (e.g. -sub:\$conn...). This prevents the UNIX shell from looking in the environment for the connection variable.

Deploying the Oracle Coherence Monitor as a Thin Client Browser Application

The Oracle Coherence Monitor can also be deployed as a thin client browser application. This allows users to view the OCM from any system that has a browser with access to your web server. The thin client deployment consists of two parts: the Display Server application and the Display Server servlet.

Configure and Install Display Server Servlet
Enterprise RTView comes with a web application archive file (servlets\ocmonitor\ocmonitor.war) that contains everything needed to run the Display Server servlet.

In order to deploy the thin client application, you must install ocmonitor.war into a J2EE servlet container such as Tomcat. See the thin client deployment section for servlet configuration options. All instructions found in that section should be applied to the files contained in servlets\ocmonitor.

Enterprise RTView provides a sample Tomcat server with ocmonitor.war already installed. If you want to use this Tomcat application server for your thin client deployment and do not want to customize ocmonitor.war, simply start the Demo Server.

Otherwise, if you choose to modify any of these servlet files, you must rebuild ocmonitor.war and install that file into a J2EE servlet container. 

1. In an initialized command window go to the servlets\ocmonitor directory.

2. To rebuild ocmonitor.war type:

3. To install ocmonitor.war to the Enterprise RTView Tomcat Demo Server type:

 

install_to_demoserver ocmonitor.war

NOTE: If you will be using your own Apache Tomcat application server, make sure CATALINA_HOME is set to your Tomcat installation. To install ocmonitor.war your own Apache Tomcat application server type:
 

install_to_tomcat ocmonitor.war

If you will be using an application server other than Apache Tomcat, install the files in ocmonitor.war to your application server according to the documentation for that product.
 

Run the Enterprise RTView Display Server Application
Once your servlet container is running with ocmonitor.war installed, then you must setup and run the Enterprise RTView Display Server application.

There are four options on how to run the Display Server:
1. Remote JMX port connected directly to the cluster
2. Coherence management node connected directly to the cluster
3. Remote JMX port using the Data Server to connect to the cluster and collect data
4. Coherence management node using the Data Server to connect to the cluster and collect data  

Option 1: Run the Display Server via Remote JMX Port
In this deployment, the Display Server connects to the management node that you have setup as a JMX MBeanServer host via remote JMX port and collects and federates the data. Multiple browser clients can connect to the Display Server to see OCM displays.

1. Install, setup and license Enterprise RTView for Oracle Coherence on the system where you will run the Display Server. This system must meet the system requirements for using a remote JMX port.

2. Confirm that you have completed the  setup for monitoring the cluster using a remote JMX port on the system where you will run the Display Server.

NOTE: By default, the Oracle Coherence Monitor is setup to attach to port 9991 on localhost with no authentication. If this is not correct for your setup, you must customize the RemoteJmxRMI connection to point to the IP address of the machine running the Coherence node enabled with JMX remote capability and the exposed JMX port.

3. In an initialized command window type:

4. If ocmonitor.war was installed to the Enterprise RTView Demo Server, then you can access the Oracle Coherence Monitor application in your browser at the following link:

http://localhost:8068/ocmonitor

Option 2: Run the Display Server as a Coherence Management Node
In this deployment, the Display Server is run as the management node in your cluster. Multiple browser clients can connect to the Display Server to view OCM displays.

1. Install, setup and license Enterprise RTView for Oracle Coherence on the system where you will run the Display Server. This system must meet the system requirements for the running the OCM as a management node.

2. Confirm that you have completed the  setup for running the OCM as a management node on the system where you will run the Display Server.

3. In an initialized command window type:

The Display Server will start up as a node in the cluster and make all the information available to clients who connect to the web application.

4. If ocmonitor.war was installed to the Enterprise RTView Demo Server, then you can access the Oracle Coherence Monitor application in your browser at the following link:

http://localhost:8068/ocmonitor

Option 3: Run via Remote JMX Port Using the Data Server
In this deployment, the Data Server connects to the management node that you have setup as a JMX MBeanServer host via remote JMX port and collects and federates the data for the Display Server. In this way, the variable load placed on the Display Server will not impact the data collection process of the Data Server. Multiple browser clients can connect to the Display Server to view OCM displays.

1. Install, setup and license Enterprise RTView for Oracle Coherence on the system where you will run the Display Server. This system must meet the basic Enterprise RTView system requirements.

2. Setup and run the Data Server using a remote JMX port.

3. In an initialized command window type (where ipaddress is the IP address for the system where you are running the Data Server):

4. If the web archive was installed to the default Enterprise RTView Demo Server, then you can access the Oracle Coherence Monitor application in your browser at the following link:

http://localhost:8068/ocmonitor

Option 4: Run as a Management Node Using the Data Server
In this deployment, the Data Server is run as the management node in your cluster and collects and federates the data. In this way, the variable load placed on the Display Server will not impact the data collection process of the Data Server. Multiple browser clients can connect to the Display Server to view OCM displays.

1. Install, setup and license Enterprise RTView for Oracle Coherence on the system where you will run the Display Server. This system must meet the basic Enterprise RTView system requirements.

2. Set up and run the Data Server as a management node.

3. In an initialized command window type (where ipaddress is the IP address for the system where you are running the Data Server):

NOTE: On UNIX, passing the $conn substitution as a command line argument requires a \ before the $ (e.g. -sub:\$conn...). This prevents the UNIX shell from looking in the environment for the connection variable.

http://localhost:8068/ocmonitor

Set up and Run the Data Server Using a Remote JMX Port

Set up and Run the Data Server as a Management Node