There are two options for how the Oracle Coherence Monitor communicates with a Coherence cluster. The system requirements and setup for each deployment 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 deployment options below.

Once you have decided whether to connect to your grid using a remote JMX port or by running the Oracle Coherence monitor as a management node, you must decide whether you want to deploy as a Java application or as a thin client web application. The rich client deployment is not supported for the Oracle Coherence Monitor.  See the Deployment section for more information on selecting 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 directly connecting to the cluster (using a remote JMX port or as a management node), or they can both be run as clients of the Data Server. In the Data Server deployments, 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 3. This is useful if you want to run the monitor on another machine, disconnected from the Coherence cluster, or if you want to run multiple monitors or a combination of the monitors 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 using a remote JMX port and figure 4 for a diagram of the Data Server connecting to your cluster as a management node.

Two command line arguments are needed when running the Oracle Coherence Monitor, Display Server, Data Server, Historian or Report Generator. The -ocm command line argument must be used for all applications except the monitor when running using a JMX remote port to access the grid. The -ocmnode command line argument must be used for all applications including the monitor when running as a grid node. When using multiple command line arguments, these must come first. For example, run_ocmonitor -ocmnode -u1000 will work; run_ocmonitor -u1000 -ocmnode will not work.

The Display Server, Data Server, Historian and Oracle Coherence Monitor 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 monitor. 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 monitor. To start the database, run the following from demos\ocmdemo:

This script will run the database. 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 to log to restore the data from the previous session. To clear the data in the database, in demos\ocmdemo:

Deploying the Oracle Coherence Monitor as a Java Application

There are four options for running the Oracle Coherence Monitor as a Java Application:

1. Run using as a remote JMX port directly connected to the cluster (figure 1).
2. Run as a Coherence management node directly connected to the cluster (figure 2).
3. Run using a remote JMX port using the Data Server to connect to the cluster collect the data (figure 3). 
4. Run as a Coherence management node using the Data Server to connect to the cluster and collect the data (figure 4).

If you want to run the Oracle Coherence Monitor as either using a remote JMX port or as a management node directly connected to the cluster, install, setup and license Enterprise RTView for Oracle Coherence on each system where you will run the monitor and follow the appropriate instructions in Running the Oracle Coherence Monitor. If you want to use the Data Server for your deployment, follow the appropriate instructions below:

Run Using a Remote JMX Port With the Data Server

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

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

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

3. On each system where you want to run the monitor, in an initialized command window:

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. 

Run as a Management Node With 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, setup and license Enterprise RTView for Oracle Coherence on each system where you will run the monitor. This system must meet the basic Enterprise RTView system requirements.

2. Setup and Run the Data Server as a Management Node.

3. On each system where you want to run the monitor, in an initialized command window:

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 access the monitor from any system that has a browser with access to your web server. The thin client deployment consists of 2 parts: the Display Server application and the Display Server servlet. Enterprise RTView comes with a web application archive (.war) file, servlets\ocmonitor\ocmonitor.war, that contains everything needed to run the Display Server servlet.

In order to deploy the thin client application, install ocmonitor.war into a J2EE servlet container such as Tomcat. See the thin client deployment servlet configuration section for configuration options options for the servlet. All instructions supplied there should be applied to the files in servlets\ocmonitor. If you modify any of the servlet files, rebuild ocmonitor.war as follows: 

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

2. Execute the following to rebuild ocmonitor.war:

Enterprise RTView comes with a sample Tomcat server with ocmonitor.war already installed. If you want to use this Tomcat application server for your thin client deployment and you do not want to customize ocmonitor.war, simply start the demo server. Otherwise, install servlets\ocmonitor\ocmonitor.war to your J2EE servlet container:

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

2. Execute the following to install ocmonitor.war to the Enterprise RTView Tomcat demo server:

If you will be using your own Apache Tomcat application server, make sure CATALINA_HOME is set to your Tomcat installation and run the following script to install ocmonitor.war:
 

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.

Once your servlet container is running with ocmonitor.war installed, then you must setup and run the Enterprise RTView Display Server application. There are 3 options for how to run:

1. Run the Display Server using a remote JMX port.
2. Run the Display Server as a management node.
3. Run the Display Server as a Data Server client (with the Data Server running either using a remote JMX port or as a management node).

Run the Display Server Using a Remote JMX Port

In this deployment, the Display Server connects to the management node that you have setup as a JMX MBeanServer host via a JMX remote port and collects and federates the data. Multiple browser clients can connect to the Display Server to see the monitor 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 JMX remote port.

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

3. 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.

4. In an initialized command window:

5. 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

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 the monitor 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 monitor as a management node.

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

3. In an initialized command window:

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

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

Run the Display Server as a Data Server Client

In this deployment, the Data Server connects to your cluster and gathers data for the Display Server. Multiple browser clients can connect to the Display Server to view the monitor 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 or setup and run the Data Server as a management node.

3. In an initialized command window:

http://localhost:8068/ocmonitor

Run the Data Server Using a Remote JMX Port

Run the Data Server as a Management Node