2 Installing and Configuring Oracle GoldenGate Monitor Agent

This chapter walks you through the process of installing and configuring Oracle GoldenGate Monitor Agent for all non-z/OS platforms (if you are installing Oracle GoldenGate Monitor Agent on a z/OS platform, see Chapter 3, "Installing and Configuring Oracle GoldenGate Monitor Agent for z/OS").

This chapter contains the following sections:

2.1 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:

  1. Start the Installer

  2. Install the Product

  3. Install Available Patches

2.1.1 Start the Installer

To start the installation program:

  1. Log in to your system.

  2. Go to the directory where you downloaded the installation program.

  3. 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 Section 2.1.2, "Install the Product" for a description of each installation program screen.

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

  1. Type or browse and select the Oracle Home location (that is, the path where you have installed WebLogic Server+JRF) and Coherence.

  2. Click View to see the products installed under the selected Oracle Home.

  3. Click Next.
Installation Type Use this screen to select an installation type.

  1. Select Oracle Golden Gate Monitor Agent.

  2. 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 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 OGG_AGENT_INST_HOME directory.

2.1.3 Install Available Patches

  1. Enter the My Oracle Support link into a web browser:

    http://support.oracle.com

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

  3. Click the Patches & Updates tab.

  4. Search for Management Pack for Oracle GoldenGate patches for your operating system.

  5. Download at least Patch 19916072.

  6. Unzip the downloaded file.

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

2.2 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:

  1. Create the Instance

  2. Update the Configuration Properties

  3. Create Wallet Credentials

  4. Copy the SSL Certificate Files

  5. Start the Oracle GoldenGate Monitor Agent

  6. Check Oracle GoldenGate Monitor Agent Instance Log Files

Note:

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

2.2.1 Create the Instance

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

    cd /u01/app/oracle/product/wls/oggmon/ogg_agent

  2. 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 :

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

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

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

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

2.2.2 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:

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

  2. Edit the OGG_AGENT_INST_HOME/cfg/Config.properties file.

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

  4. Close and save the file.

The oggmon.properties file is required to create the wallet. For instructions, see "Edit Monitor Properties" in Installing and Configuring Oracle GoldenGate Monitor Server.

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

2.2.3.1 Creating an Oracle GoldenGate Monitor Wallet

  1. Delete any existing dirwlt directory.

  2. Ensure that the oggmon.properties file is copied into the cfg directory.

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


  4.

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

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

  6. Enter and confirm a user password for your monitor.jmx.username property.

    Please enter Monitor Server JMX password: 

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

2.2.3.2 Creating an Oracle GoldenGate Enterprise Management Plug-In Wallet

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

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

2.2.4 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:

  1. 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" in Administering Oracle GoldenGate Monitor.

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

2.2.5 Prepare the Oracle GoldenGate Monitor Agent Instance for Monitoring

  1. Create a file named GLOBALS in the OGG_AGENT_INST_HOME directory, if this file does not exist.

  2. Edit the GLOBALS file.

  3. Add ENABLEMONITORING on a new line.

  4. Close and save the file.

2.2.6 Start the Oracle GoldenGate Monitor Agent

Go to the Oracle GoldenGate GGSCI console and start Oracle GoldenGate Monitor Agent by executing the start jagent command:

GGSCI> start jagent

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