Installing and Configuring Oracle GoldenGate Monitor Agent

2 Installing and Configuring Oracle GoldenGate Monitor Agent

Use this step by step guide to install and configure Oracle GoldenGate Monitor Agent for all non-z/OS platforms.

If you are installing Oracle GoldenGate Monitor Agent on a z/OS platform, see Installing Oracle GoldenGate Monitor Agent for z/OS.

This chapter contains the following sections:

Installing Oracle GoldenGate Monitor Agent

Use the Oracle Universal Installer (OUI) to install Oracle GoldenGate Monitor Agent for all non-z/OS platforms. Perform the following steps:

Start the Installer

To start the installation program:

Log in to your system.
Go to the directory where you downloaded the installation program.

Launch the installation program by invoking java -jar from the JDK directory on your system, as shown in the following table:

For this Operating System	Use this command
Unix	$ java -jar -Xmx1024m /path/to/jar/file/ogg_generic.jar
Windows	C:\ java -jar -Xmx1024m ogg_generic.jar

Where ogg_generic.jar is the name of the file that you downloaded for your operating system.

When the installation program appears, you are ready to begin the installation. See Install the Product for a description of each installation program screen.

Note:

Oracle GoldenGate Monitor installer will not run on shared disk.

Install the Product

To install the product, navigate through the Installer screens, providing the necessary information as described on the following table. This table lists the screens in the order they will appear and provides instructions for completing any necessary fields. If you want further information on any screen, click its name in the left-hand column.

Screen	Description
Welcome	This screen introduces you to the product installer. Click Next.
Installation Location	Use this screen to specify the location of your Oracle home directory. Type or browse and select the Oracle Home location (that is, the path where you have installed WebLogic Server+JRF) and Coherence. Click View to see the products installed under the selected Oracle Home. Click Next.
Installation Type	Use this screen to select an installation type. Select Oracle Golden Gate Monitor Agent. Click Next.
Prerequisite Checks	This screen verifies that your system meets the minimum necessary requirements. If there are any warning or error messages, you can refer to one of the documents referenced in "Verifying Certification, System Requirements, and Interoperability" in Oracle Fusion Middleware Planning an Installation of Oracle Fusion Middleware. Click Next.
Installation Summary	Use this screen to verify the installation options you selected. Note: To display an individual component's approximate installed size, click its name. Click Install.
Installation Progress	This screen shows the progress of the installation. When the progress bar reaches 100%, the installation is complete. Be aware that the Generating Libraries process can take up to 70% of the total installation time on some systems. When the installation progress is 100%, click Next.
Installation Complete	This screen appears at the conclusion of the installation and provides a summary of the products and features that were installed. Click Finish. With this step, OUI installs the Oracle GoldenGate Monitor Agent binaries and configuration files, along with OUI specific file set, in the `ORACLE_HOME/oggmon/ogg_agent`directory. Going forward, this directory is referred to as `OGG_AGENT_INST_HOME`.

Install Available Patches

Enter the My Oracle Support link into a web browser:

http://support.oracle.com
Click Sign In....

Note:

If you are not already logged in, the Oracle Single Sign-On page appears. Enter your Oracle user id and password and click Sign In.

The Dashboard page appears.
Click the Patches & Updates tab.
Search for Management Pack for Oracle GoldenGate patches for your operating system.
Unzip the downloaded file.
Follow the instructions in the README.txt file, from the patch ZIP file, to verify that the patch is needed for your system and how to install the patch.

Creating and Configuring an Oracle GoldenGate Monitor Agent Instance

This section describes the procedures for creating and configuring an Oracle GoldenGate Monitor Agent instance for non-z/OS platforms. This process requires these six steps:

Note:

These procedures are for non-z/OS applications. If you are installing Oracle GoldenGate Monitor Agent for the z/OS platform, see Creating and Configuring an Oracle GoldenGate Monitor Agent Instance.

Create the Oracle GoldenGate Monitor Agent Instance

Go to the directory that contains the Oracle GoldenGate Monitor Agent creation script, createMonitorAgentInstance.sh. For example:
```
cd OGG_AGENT_BASE_HOME
```

Run the script:

For this Operating System	Use this command
Unix	$ ./createMonitorAgentInstance.sh
Windows	C:\ createMonitorAgentInstance.bat

The system responds:

Please enter absolute path of Oracle GoldenGate home directory :

Enter the absolute path to your Oracle GoldenGate home directory. For example, /u01/ogg/replication/oggcore1.
The system responds:
```
Please enter absolute path of OGG Agent instance : 
```
Enter the directory that contains your Oracle GoldenGate Monitor Agent instance, which can be an existing directory. For example, /u01/ogg/agents/oggmon/agent1. This directory should be different than the Oracle GoldenGate home directory to avoid overwriting your Oracle GoldenGate Monitor Agent JAR and configuration files the next time you install or patch Oracle GoldenGate. This directory must also be outside of OGG_AGENT_BASE_HOME directory to support patching. This directory will be referred as OGG_AGENT_INST_HOME in the following sections.
Note:

For Windows, you must ensure that you provide the absolute JDK8 directory path explicitly or the Monitor Agent cannot connect to the Monitor server. This directory path can also be defined in the jagent.prm file.

The Oracle GoldenGate Monitor Agent Instance directory can be an existing directory location. In that case, you are prompted:
```
OGG Agent instance directory already exists, do you want to overwrite the contents (yes | no)". 
```
If you choose yes, the execution of the script will continue and all the contents related to Oracle GoldenGate Monitor Agent will be overwritten on that location. If you choose no, the execution of the script will stop.

The system responds:
```
Please enter unique name to replace timestamp in startMonitorAgent script.
```
Enter the unique name that you want to replace the timestamp in the startMonitorAgent.sh script file.

You can create additional instances using this same process though you must ensure that you create them in unique directories. For example, you can point a new Monitor Agent instance to the same Oracle GoldenGate Instance directory (such as, /u01/ogg/replication/oggcore1) or a different Oracle GoldenGate Monitor Agent Instance, and the Oracle GoldenGate Monitor Agent Instance directory must always be a new directory (such as, /u01/ogg/agents/oggmon/agent2). The Oracle GoldenGate Monitor Agent reports Oracle GoldenGate monitoring statistics to the Oracle GoldenGate Monitor Server based on how it is configured.

Note:

Ensure that for Oracle GoldenGate 12.3.x, the minimum required JAgent version is 12.2.1.2.171115.

Update the Configuration Properties

Oracle GoldenGate Monitor Agent operates in one of two modes, Oracle GoldenGate Monitor Server or Oracle GoldenGate Enterprise Management Plug-In. You set the configuration properties for the mode you want to operate in using the following steps:

If you are using Oracle GoldenGate Monitor Server (not Oracle GoldenGate Enterprise Management Plug-In), copy the oggmon.properties file from the OGG_MONITORSERVER_DOMAIN/config/monitorserver/cfg directory to the OGG_AGENT_INST_HOME/cfg directory of all of your Oracle GoldenGate Monitor Agent Instances, where OGG_AGENT_INST_HOME is the absolute path to your Oracle GoldenGate Monitor Agent Instance.
Edit the OGG_AGENT_INST_HOME/cfg/Config.properties file.
Review and set the properties for one of the following modes:

Oracle GoldenGate Monitor (OGGMON):

jagent.host=

Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent) is running.

jagent.jmx.port=

Use the default or change to your preferred port.

monitor.host=

Set to the hostname you set during your Oracle GoldenGate Monitor Server installation in monitor.properties.

monitor.jmx.port=

Set to the port you set during your Oracle GoldenGate Monitor Server installation in monitor.properties.

monitor.jmx.username=

Set to the user name you provided during your Oracle GoldenGate Monitor Agent installation

jagent.username=

Set a jagent user name.

agent.type.enabled=

Ensure it is set to OGGMON.

jagent.backward.compatibility=

Ensure it is set to false.

jagent.ssl=

Ensure it is set to false.

Or

Oracle GoldenGate Enterprise Management Plug-In (OEM):

jagent.host=

Use the default or change to the complete hostname or IP of the machine where Oracle GoldenGate Monitor Agent (jagent) is running.

jagent.username=

Set a jagent user name.

jagent.rmi.port=

Use the default or change to a specific port.

agent.type.enabled=

Set it to OEM.

jagent.backward.compatibility=

Ensure it is set to false.

jagent.ssl=

Ensure it is set to false.
Close and save the file.

The oggmon.properties file is required to create the wallet.

Note:

If you use the Oracle GoldenGate Monitor UI to change a configuration file, you must reopen the file by clicking the Edit button. The tab title is changed to prefix with an asterisk symbol (*), which means that the text area is in edit mode. If you change any value and navigate to other sections without saving, then a confirmation dialog is displayed to inform you to save the change. Otherwise, the changed value is not retained and no messages are displayed.

Create Wallet Credentials

Navigate to the OGG_AGENT_INST_HOME/bin directory, and then use one of the following sections to create the Oracle Wallet for your operating mode, Oracle GoldenGate Monitor or Oracle GoldenGate Enterprise Management Plug-In.

Creating a Oracle GoldenGate Monitor Wallet

Delete any existing dirwlt directory.
Ensure that the oggmon.properties file is copied into the cfg directory.

Start creating the wallet credentials:

For this Operating System	Use this command
Unix	$ ./pw_agent_util.sh -create
Windows	C:\ pw_agent_util.bat -create

Enter and confirm a user password for your jagent.username property.

Please create a password for Java Agent: 
Please confirm password for Java Agent:

Enter and confirm a user password for your monitor.jmx.username property.
```
Please enter Monitor Server JMX password: 
```
Please confirm Monitor Server JMX password:

The system responds:Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start INFO: Jps initializing. Jan 06, 2014 5:17:24 PM oracle.security.jps.JpsStartup start INFO: Jps started. Wallet is created successfully.
This creates the wallet cwallet.sso and cwallet.sso.lck files in dirwlt in the OGG_AGENT_INST_HOME/cfg directory.

Creating an Oracle GoldenGate Enterprise Management Plug-In Wallet

Start creating the wallet credentials:

For this Operating System	Use this command
Unix	$ ./pw_agent_util.sh -jagentonly
Windows	C:\ pw_agent_util.bat -jagentonly

Enter and confirm a user password for your jagent.username property.

Please create a password for Java Agent: 
Please confirm password for Java Agent:

The system responds:

Jan 06, 2014 5:17:22 PM oracle.security.jps.JpsStartup start
INFO: Jps initializing.
Wallet is created successfully.

This creates the wallet cwallet.sso and cwallet.sso.lck files in dirwlt in the OGG_AGENT_INST_HOME directory.

Copy the SSL Certificate Files

Note:

This step is required only if the Oracle GoldenGate Monitor Agent is running in SSL mode.

Go to the OGG_AGENT_INST_HOME/dircrt and copy the Keystore and Truststore files.

After copying the keystore and truststore files, do the following:

Using the pw_agent_util.sh (or .bat, on Windows) utility, update the wallet with keystore and truststore passwords, as described in "Updating Oracle GoldenGate Monitor Agent Passwords" .
Update the jagent.keystore and jagent.truststore values in the config.properties file; for example:
```
jagent.keystore.file=jagentKeyStore
jagent.truststore.file=jagentTrustStore
```

Note:

If you are using a self-signed certificate, you can use the same file for both keystore file and truststore. If you are using a third-party signed certificate, you need to update your property file with the appropriate keystore and trust store files.

Preparing the Oracle GoldenGate Monitor Agent Instance for Monitoring

Create a file named GLOBALS in the OGG_HOME directory, if this file does not exist.
Edit the GLOBALS file.
Add ENABLEMONITORING on a new line.
Close and save the file.

Note:
Starting with Oracle GoldenGate 12.3.x, the datastore is managed internally. Therefore, you can skip Step 5 for Oracle GoldenGate 12.3.x and newer versions.
Create the datastore using the CREATE DATASTORE command:

GGSCI> CREATE DATASTORE

Note:

All processes should be stopped before creating the datastore. You can also add autostart jagent to the mgr.prm file.

Note:

The SHM ID should be added with the CREATE DATASTORE command.

CREATE DATASTORE SHM ID <unique positive integer>

For example:

CREATE DATASTORE SHM ID 100

Note:
For Oracle GoldenGate 12.x and older, use the CREATE DATASTORE and DELETE DATASTORE commands to recreate datastore in case of BDB corruption.

Starting the Oracle GoldenGate Monitor Agent

Go to the Oracle GoldenGate GGSCI console and start Oracle GoldenGate Monitor Agent by executing the following commands:

start pmsrvr 
start manager 
start * 
start jagent

Monitor the new Agent log file, $AGENT_HOME/logs/ogg_agent.log and resolve any issues.

If you are using the Oracle GoldenGate Enterprise Manager Plug-In, after jAgent starts correctly you must restart the Oracle Enterprise Manager (OEM) Agent and then login to the OEM 12c console to ensure that the out of sync status issues for Oracle GoldenGate registered targets are resolved.

Note:

For Oracle GoldenGate Monitor 12.2 and older versions, you can skip the start pmsrvr line.

Check Oracle GoldenGate Monitor Agent Instance Log Files

Once you have completed the preceding steps and Oracle GoldenGate Monitor Agent is running, the Oracle GoldenGate Monitor Agent log details will be written to ogg_agent.log, which is in OGG_AGENT_INST_HOME/logs.

Starting with 12.2.1.2.0 release, Oracle GoldenGate Agent log file only includes errors and warnings. You can edit the oggmon/Monitor/jagent/src/main/cfg/logging-config.xml file to customize the log level.

Starting Multiple Oracle GoldenGate Monitor Instances

To monitor the Oracle GoldenGate Core instance through Oracle GoldenGate Monitor and Oracle GoldenGate Enterprise Manager Plug-in, multiple Oracle GoldenGate Monitor instances can be installed.

To run multiple Oracle GoldenGate Monitor Agent Instances from a single install Oracle GoldenGate Core instance:

Install the Oracle GoldenGate Core product.
Install standalone Oracle GoldenGate Monitor Agent instance 1 pointing to Oracle GoldenGate Core Instance. You can set the mode=OEM.
Configure Oracle GoldenGate Agent properties (Config.properties) as required for OGGPLG 12.1.0.2.0 which is under OGG_AGENT_HOME1/cfg directory.
- The absolute path of Oracle GoldenGate home directory: OGG_CORE_HOME
- absolute path of first OGG Agent instance directory: OGG_AGENT_HOME1
Change the mgr.host to the host name of the machine where Manager is running and mgr.port to the mgr port of the OGGCORE instance.
Make a copy of the JAVA command from OGG Core instance which is available in OGG_CORE_HOME/dirprm/jagent.prm file.
Create a standalone Oracle GoldenGate Monitor Agent Instance 2 pointing to the same Oracle GoldenGate Core Instance You can set the mode =OGGMON.
- The absolute path of Oracle GoldenGate home directory: OGG_CORE_HOME
- The absolute path of second OGG Agent instance directory: OGG_AGENT_HOME2
Note:

If the jagent.prm is already exists under OGG_CORE_HOME/dirprm/ the jagent.prm file will be replaced with the latest jagent.prm file.
Configure Oracle GoldenGate Agent properties (Config.properties) as need for Monitor 12.1.3 which is under OGG_AGENT_HOME2/cfg directory.
Start Oracle GoldenGate Monitor Agent instance 2 from GGSCI.
Execute the Java command copied in step 5 for the Monitor agent instance 1 from OGG_AGENT_HOME1 folder created in step 3 or run the script startMonitorAgentInstance_*.sh present under OGG_AGENT_HOME2/bin from the OGG_CORE_HOME location for starting the Monitor agent instance 1.

For example: OGG_AGENT_HOME2/bin/startMonitorAgentInstance_*.sh

Note:

JAgent should be always be started from the OGG_CORE_HOME location because internally based on the usr.dir (the directory where Java was run) system property are used from setting the OGGC CORE location.