1 Getting Started with Enterprise Manager Plug-In for Oracle GoldenGate

This document provides a brief description of the Enterprise Manager Plug-in for Oracle GoldenGate, details on the releases the plug-in supports, prerequisites for deploying the plug-in, and step-by-step instructions on how to configure Oracle GoldenGate for the Enterprise Manager Plug-in for Oracle GoldenGate.

1.1 What is Enterprise Manager Plug-In for Oracle GoldenGate

The Oracle GoldenGate Enterprise Manager Plug-In extends the Oracle Enterprise Manager (EM) Cloud Control to support monitoring and managing Oracle GoldenGate processes. By deploying it in your Cloud Control environment, you gain the following features:

  • Visually monitor current Oracle GoldenGate metrics and historical trends.

  • Generate automatic alerts and incidents when thresholds are breached.

  • Start, stop, and kill individual processes.

  • Modify existing configuration files.

  • View error logs, Oracle GoldenGate error logs, report files, and discard files.

  • Audit user access of privileged EM Plug-in features and instance-level security for user creation.

1.2 Supported Platforms and Releases

This topic discusses the platforms and releases that are supported by Enterprise Manager Plug-In for Oracle GoldenGate.

Supported Platforms

  • Make sure that you are installing your product on a supported hardware or software configuration.

    See the Certifications tab on My Oracle Support for details.

  • Oracle has tested and verified the performance of your product on all certified systems and environments; whenever new certifications occur, they are added to the proper certification document right away. New certifications can occur at any time, and for this reason the certification documents are kept outside of the documentation libraries and are available on Oracle Technology Network.

  • The Enterprise Manager Plug-In for Oracle GoldenGate supports monitoring of all platforms where both Oracle GoldenGate Release 11.2.1 and later and Oracle Enterprise Manager Cloud Control 13c Agent and later instances can run.

  • DB2 z/OS and DB2 for I do not support the installation of the Enterprise Manager and EM Agent. Monitoring of Oracle GoldenGate instances is achieved through remote EM Agent and Oracle GoldenGate Monitor Agent installed on these operating systems (supported with changes in the OEM and Oracle GoldenGate configuration).

  • For DB2 for i, the Java Platform Standard Edition (Java SE) Development Kit (JDK) 7 Update 2 or later is required to support Transport Layer Security (TLS) 1.2 specification (supported with changes in the OEM and Oracle GoldenGate configuration).

  • Oracle GoldenGate for HP NonStop is not supported.

Supported Releases

The Oracle GoldenGate Enterprise Manager Plug-In supports the following product releases:

  • Enterprise Manager Cloud Control 13c Release 2 (13.2.0.0) and later.

  • Oracle GoldenGate versions supported include:

    • Oracle GoldenGate Monitor Agent 12c (12.1.3.0.4) and later is required and is the minimum version required to support Start, Stop, Kill, and Edit features.

    • Oracle GoldenGate 12c (12.1.2.0.1).

    • Oracle GoldenGate 12c (12.1.2.0.0).

    • Oracle GoldenGate 11g Release 2 (11.2.1.0.10) and higher.

    • Support for non-core Oracle GoldenGate.

      If you want to use a specific version of Oracle GoldenGate other than the default version, (for example, version 11.2.1.0.23) , then add a MinOGGCoreVersion entry for each Feature element in the omsOracleHome/plugins/oracle.fmw.gg.oms.plugin_13.2.1.0.0/metadata/versionmgmt/feature_version.xml file as follows:

      <Document>
         <VersionCacheResetSchedule>
            <Interval>1</Interval>
            <TimeUnit>Hour</TimeUnit>
         </VersionCacheResetSchedule>
         <FeatureList>
            <Feature>
               <FeatureName>ExecuteCommands</FeatureName>
               <MinPluginOMSVersion>12.1.0.4.0</MinPluginOMSVersion>
               <MinPluginEMAgentVersion>.0</MinPluginEMAgentVersion>
               <MinOGGCoreVersion>11.2.1.0.23</MinOGGCoreVersion>
            </Feature>
            <Feature>
               <FeatureName>ViewLogs</FeatureName>
               <MinPluginOMSVersion>12.1.0.4.0</MinPluginOMSVersion>
               <MinPluginEMAgentVersion>.0</MinPluginEMAgentVersion>
               <MinOGGCoreVersion>11.2.1.0.23</MinOGGCoreVersion>
            </Feature>
            <Feature>
               <FeatureName>ViewEditConfig</FeatureName>
               <MinPluginOMSVersion>12.1.0.4.0</MinPluginOMSVersion>
               <MinPluginEMAgentVersion>.0</MinPluginEMAgentVersion>
               <MinOGGCoreVersion>11.2.1.0.23</MinOGGCoreVersion>
            </Feature>
         </FeatureList>
      </Document>
      

1.3 Before You Begin with Enterprise Plug-In for Oracle GoldenGate

Oracle Enterprise Manager for Oracle GoldenGate has a number of prerequisites that must be performed before you can get started with deploying and using the product.

Software Requirements

  • The following must be installed and running:

    • Oracle GoldenGate 12c (12.1.2.0.1) and later or Oracle GoldenGate 11g Release 11.2.1.0.17 and later to support monitoring by Enterprise Manager Cloud Control.

    • Oracle GoldenGate Monitor Agent 12c (12.1.3.0.4) and later; the installation location you chose is referred to as OGG_AGENT_ORA_HOME in this document. This location is not necessarily the Oracle GoldenGate 12c installation location.

    • Oracle Enterprise Manager (OEM) Cloud Control 13c Release 2 (13.2.0.0) and later (Oracle Management Service and Oracle Management agent).

  • An Oracle Management agent must be installed on each system, which are hosting Oracle GoldenGate instances, and you wish to monitor.

  • Verify that Java JRE 1.7.0_80 and greater is installed on each system where Oracle GoldenGate is installed. To verify your Java version, navigate to the Oracle GoldenGate installation directory and run the following command:

    Shell> java -version
    

    The version is displayed and should be similar to the following:

    java version "1.7.0_85"
    Java(TM) SE Runtime Environment (build 1.7.0_85-b18)
    Java HotSpot(TM) Client VM (build 25.25-b02, mixed mode)
    

    If this doesn’t return a 1.7 version of Java, check that the PATH environmental variable includes java.exe and java.

    If you require the latest version of Java, you can download it from:

    http://www.oracle.com/technetwork/java/javase/downloads/.
    • You can download either the Java Development Kit (JDK) or Java Runtime Environment (JRE).

    • For the Windows x64 platform, you must use the x64 version of JDK or Enterprise Manager is unable to load the Java agent.

  • To configure the Software Library, see Configuring a Software Library in Enterprise Manager Cloud Control Administrator’s Guide.

Verify Your Environment Meets Certification Requirements

Make sure that you are installing your product on a supported hardware or software configuration. For more information, see the certification document for your release on the Oracle Fusion Middleware Supported System Configurations page.

Attention:

Oracle has tested and verified the performance of your product on all certified systems and environments; whenever new certifications occur, they’re added to the proper certification document right away. New certifications can occur at any time, and for this reason the certification documents are kept outside of the documentation libraries and are available on Oracle Technology Network.

Set Environment Variables to Point to the Java Installation

Perform the following steps to ensure that your environment is ready for monitoring:

Caution:

If you set the LD_LIBRARY_PATH for monitoring for Oracle GoldenGate Release 11.1.1 instances, you must remove the setting when monitoring 11.2.1 and later instances.

Windows:

  1. Set the JAVA_HOME variable to the location of the Java installation.

  2. Set the PATH variable to the jre\bin of the Java installation location:

    . . .;%JAVA_HOME%\jre\bin
    

Oracle Solaris and Linux:

  1. Set the JAVA_HOME environment variable to the location of the Java installation.

  2. Set the PATH environment variable to the jre/bin directory of the Java installation.

For example (using the bash shell):

export JAVA_HOME= PATH to JDK installation
export PATH = $PATH:$JAVA_HOME/jre/bin

Configure Oracle GoldenGate Instances

To configure your Oracle GoldenGate instances:

  1. Enable monitoring by navigating to the Oracle GoldenGate installation directory and editing the GLOBALS parameter file.

    Shell> ./ggsci
    GGSCI> EDIT PARAMS ./GLOBALS
    

    Add the ENABLEMONITORING parameter to the GLOBALS parameters and save the file. The parameter are activated when you start the Manager after configuring the Oracle GoldenGate instance.

  2. Create the Oracle Wallet to store passwords using the steps listed in How do I Create the Oracle Wallet.

  3. Use the steps listed in How do I Configure Oracle GoldenGate to Run with Oracle Enterprise Manager to configure the Oracle GoldenGate instances for monitoring by Oracle Enterprise Manager.

  4. Use the steps listed in How do I Start the Oracle GoldenGate Instances to:

    • Create the data store used to store monitoring data.

    • Start the monitor or jAgent agent that collects monitoring data to pass to the OEM Management agent.

Downloading the Plug-In

You can download plug-ins in online or offline mode. Online refers to an environment where you have Internet connectivity to the Enterprise Manager Store. Offline refers to an environment where you don’t have Internet connectivity. See Downloading Plug-Ins in Oracle Enterprise Manager Cloud Control Administrator's Guide.