2 Setting Up Enterprise Manager Plug-In for Oracle GoldenGate

After deploying the Enterprise Manager plug-in, there are a number of tasks that you must complete before you begin to use the plug-in to monitor the Oracle GoldenGate instances.

This topic details the following:

Topics

• Configuring Oracle GoldenGate Instances for Enabling Monitoring in the Oracle Enterprise Manager

• Discovering Oracle GoldenGate Targets

• Verifying and Validating the Plug-in Deployment

• How do I Configure Instance-Level Security

• Monitoring the High Availability Features

Configuring Oracle GoldenGate Instances for Enabling Monitoring in the Oracle Enterprise Manager

To configure your Oracle GoldenGate instances:

1. Configure the Oracle GoldenGate monitoring agent to run with Oracle Enterprise Manager. See Installing and Configuring Oracle GoldenGate Monitor Agent to configure the agent for the Oracle Enterprise Manager.

   You need to do this configuration only for Oracle GoldenGate classic instance and is not required for Oracle GoldenGate microservices architecture (MA).

2. Create the Oracle Wallet to store passwords using the steps listed in Creating the Oracle Wallet.

Creating the Oracle Wallet

You must perform the following steps to create the Oracle Wallet and to add the password that the Oracle Management agent uses to connect to the Oracle GoldenGate agent to receive metric values. This is applicable for the Oracle GoldenGate classic instance only as the Oracle GoldenGate monitoring agent (jAgent) is used by classic instance.

To create the Oracle Wallet:

1. Navigate to the OGG_AGENT_ORA_HOME directory.

   Note:

   Oracle GoldenGate 12c (12.1.2.0.0) introduced the storing of passwords for extract and replicats in Oracle Wallets. However, both the Oracle GoldenGate core replication and Oracle GoldenGate monitoring agent wallets cannot reside in the same location. If both Oracle GoldenGate core and the Oracle GoldenGate monitoring agent are using the Oracle Wallet then Oracle GoldenGate core must use a non-default location. This configuration can be set by using the GLOBALS parameter WALLETLOCATION.

2. Run the appropriate pw_agent_util script using the runtime argument specifying that you’re using only the Java agent (and not Oracle GoldenGate Monitor Server):
   • Windows: Go to the command line and enter Shell> pw_agent_util.bat -jagentonly
   • UNIX: Enter the command Shell>./pw_agent_util.sh -jagentonly

   If a wallet doesn't exist, then one is created.

3. Enter and confirm the Oracle Enterprise Manager agent password when you see this prompt:

   Please create a password for Java Agent:

   Please confirm password for Java Agent:

   Attention:

   If a wallet already exists in the dirwlt directory, a message is returned and the utility stops. If this happens go to the next step.

4. Optional: Run the utility to create the JAgent password by entering one of the following commands. (Note that the command options are not case sensitive):

   Caution:

   Only perform this step if the wallet already exists in the dirwlt directory.
   • Windows: Go to the command line and enter: Shell> pw_agent_util.bat -updateAgentJMX
   • UNIX: Enter the command Shell> ./pw_agent_util.sh -updateAgentJMX

Discovering Oracle GoldenGate Targets

After successfully deploying the Enterprise Manager Plug-In for Oracle GoldenGate, you must add the plug-in target to Enterprise Manager Cloud Control for central monitoring and management.

To discover Oracle GoldenGate targets:

1. In the OGG Home page, select Setup, click Add Target, and then select Configure Auto Discovery to display the Setup Discovery page.
2. In Setup Discovery page, click Advanced: Discovery Module to go to modules page. In the Discovery Module page, you can find GoldenGate Discovery Module.
3. Click GoldenGate Discovery Module to display the Configure Target Discovery for Target Types page, select the agent host name and click Edit Parameters to display the Edit Parameters: GoldenGate Discovery dialog box.
4. Enter the following information required to connect to the Oracle GoldenGate agent:

   • JAgent/Service Manager Username: Enter the Service Manager User Name in case of the MA instance. In case of a classic instance, enter the jAgent username.

   • JAgent/Service Manager Password: Enter the Service Manager Password in case of the MA instance. In case of a classic instance, enter the jAgent password.

   • JAgent RMI Port/Service Manager Port: Enter the service manager port for the connection in case of the MA instance. In case of a classic instance, enter the jAgent RMI Port.

   • JAgent/Service Manager Host Name: Enter the hostname of the Oracle GoldenGate instance or Cluster Virtual IP (VIP) of high availability cluster environment (HA/RAC).

     Note:

     To monitor multiple Oracle GoldenGate instances where individual Oracle Enterprise Manager agent is installed on each of the same host as Oracle GoldenGate, do not use LOCALHOST.

     Note:

     For HA/RAC environments, when the targets are promoted, the host property of the targets is updated with VIP. When these targets are relocated or failed over to another node, they are still accessible using the same monitoring details. This is because the Enterprise Manager agent continues monitoring the Oracle GoldenGate instance irrespective of where the Oracle GoldenGate instance is actually running.

   • GoldenGate (Classic or Microservices): Enter microservices if you want to discover Oracle GoldenGate microservices instance or else enter classic.

5. Click OK when finished.

   Target discovery has been configured on this host.

6. Click Discover Now to discover targets immediately, and click Yes in the Confirmation dialog box.
7. After the discovery job executes, check for discovered hosts that may contain potential targets. You can do this in either of the following two ways:
   • Select the job in the Host Discovery page, then click View Discovered Targets.
   • Select Setup, Add Target, Auto Discovery Results.
8. In the Setup Discovery page, on the Target on Hosts tab, select the (number) under Discovered Targets to view the processes that have been discovered.
9. Select a target to promote, then click Promote to open a promotion wizard for this target type.
10. Select the Targets on Hosts tab, and choose one or several OGG targets to promote. All the targets (except for Service Manager) are listed in the Custom Promotion for GoldenGate Targets page.
    You need to promote the service manager and all deployments separately in order to manage all the targets of a service manager.
11. Select the other targets and click Promote .
12. Click Yes in the Confirmation dialog box.
13. Click Close.
14. In the Manage EM Agents for OGG Instance page, click Submit, and then click OK.
15. Click OGG Home to display all the targets discovered.
    Once a target is successfully promoted, the target is displayed on the Home page, and the Management Agent installed on the target host begins collecting metric data on the target. The Extract and Replicat, containing both the derived and direct metrics are displayed on the Home page. Derived metrics are those that are derived from the direct metrics. The following are the metrics supported in Oracle GoldenGate:

    • Delta Operation Per Second

    • Delta Operations

    • End of File

    • Lag (Sec)

    • Last OGG Checkpoint Timestamp

    • Last Operation Timestamp

    • Name

    • Status Running

    • Start Time

    • Total Deletes

    • Total Discards

    • Total Executed DDLs

    • Total Ignores

    • Total Inserts

    • Total Operations

    • Total Truncates

    • Total Updates

    Note:

    For the alert template, ensure to use the stored metric value in milliseconds (since Unix Epoch) to all the following metrics: last_checkpoint_ts, last_processed_ts, last_operation_ts, start_time, last_checkpoint_ts, last_processed_ts, last_operation_ts, start_time.

For more details. see Discovering, Promoting, and Adding Targets

Promoting the Service Manager for Microservices Architecture

To promote the service manager:

1. In the OGG Home page, click Settings, click Add Target, and then select Configure Auto Discovery.
2. In the Target on Hosts tab, click the EM Agent, and then click Discovered Targets, to display the Auto Discovery Results page.
3. In the Targets on Hosts tab, click the service manager, and click Promote.
4. In the Custom Promotion for GoldenGate Targets page, click Promote, and then click OK in the Confirmation dialog box. If the service manager has 3 deployments, then you need to select each of them and promote them separately.
5. Go to the OGG Home page to view all the targets that are discovered.

Verifying and Validating the Plug-in Deployment

Before verifying and validating the Enterprise Manager Plug-In for Oracle GoldenGate, you must promote the Oracle GoldenGate target that is found during auto-discovery.

For more details, see Discovering, Promoting, and Adding Targets.

After waiting a few minutes for the Enterprise Manager Plug-In for Oracle GoldenGate to start collecting data, use these steps to verify and validate that Enterprise Manager is properly monitoring the plug-in target:

1. Click the Oracle GoldenGate target link from the All Target page to open theOracle GoldenGate Home Page.
2. Select Target, Monitoring and then Metric Collection Errors to verify that no metric collection errors are reported.
3. Select Target, Information Publisher Reports to view reports for the Oracle GoldenGate target type, and ensure that no errors are reported.
4. Select Target, Configuration, Last Collected Ensure that configuration data can be seen. If configuration data doesn’t immediately appear, click Refresh on the Latest Configuration page.

How do I Configure Instance-Level Security

Enterprise Manager provides instance-level security flexibility to provide target-level privileges to administrators. For example, if an Enterprise Manager Plug-In for Oracle GoldenGate is managing three Oracle GoldenGate (OGG) instances (for example, OGG1, OGG2, and OGG3), a user can be granted privileges to any of these instances and their sub-targets (that is, their OGG processes).

To grant target-level access:

1. Log in as a super admin (for example, sysman).
2. Select Setup, Security, Administrators to open the Administrators page.
3. Click Edit to modify access for an existing user.
4. Click Create/Create Like to create a new user and to assign the appropriate user roles.
5. Select the Properties tab, enter the required credentials for the new user, and click Next to open the Create Administrator userName: Roles page.

   This page lets you to assign roles to the named user by moving the role from the Available Roles column to the Selected Roles column.

6. Select one or more roles from the Available Roles list and click Move to add them to the new user.

   At a minimum, you must select the EM_BASIC_SUPPORT_REP role in addition to the preselected roles. This table shows the different roles.

   RM Role Name	Edit/View Parameter	View Report	View Discard
   EM_ALL_ADMINISTRATOR	Yes	No	No
   EM_ALL_OPERATOR	Yes	No	No
   EM_ALL_VIEWER	No	No	No
   PUBLIC	No	No	No
   EM_PLUGIN_USER	No	No	No

   Do not select any ALL roles in this step, such as EM_ALL_ADMINISTRATOR, EM_ALL_OPERATOR, and so on, else the user role you’re creating will be entitled to all OGG instances.

   Enterprise Manager (EM) supports object-level access control so administrators can be given roles for specific targets only. See Creating Roles for Systems Infrastructure Administration in Enterprise Manager Cloud Control Administrator’s Guide.

7. Click Next to open the Target Privileges page.
8. Select the Target Privileges tab, scroll down to the Target Privileges section and select the Execute Command Anywhere and Monitor Enterprise Manager roles, and then click Add.

   These two roles are required for full functionality and multi-version support.

9. Scroll below the Privileges Applicable to All Targets table to the Target Privileges section. This section gives the Administrator the right to perform particular actions on targets. Click Add to open the Search and Add: Targets page appears in a new browser window.
10. Select the instances you want the user to have access.

    Remember:

    You’re only assigning Oracle GoldenGate instances at this time. You’re not assigning Manager, Extract, or Replicat processes.

    Here is an example of two Oracle GoldenGate instances ( port numbers 5559 and 5560). Access to only one of them (port number 5560) is being assigned to this user.

    
    Description of the illustration inst_sec_select_target.gif
11. Click Select to save the changes.

    You’re returned to the Add Targets page and the Target Privileges list is refreshed to show your selection.

12. Click the Edit Individual Privileges link, in the right-most column for each target, to set the required privileges for the target.

    Select from the following privileges:

    Privilege Name	Description
    Full	Perform all operations on the target, including delete the target.
    View contents of OGG report file	View content of the report files for OGG targets.
    View contents of OGG discard file	View content of the discard files for OGG targets.
    Run OGG command	Run OGG commands (Start, Stop, Kill, and Resume) for OGG targets. You can also select these control operations from the Target drop-down list in the Oracle GoldenGate Home page. Select a control operation to display a confirmation dialog box. Once you click Yes in the confirmation dialog box, the action is sent to Oracle GoldenGate Core for execution. The dialog box refreshes automatically to check the progress of the command. An Error or Success of the command is displayed in the same dialog box. When you click OK, the Home page is refreshed with the latest status of the target.
    Edit OGG parameter file	Edit parameter files for OGG targets.
    Connect Target	Connect and manage target.

    Don’t select both the Full and Connect Target privileges because Full includes Connect Target .

13. Click Continue.
14. Click Review to review your user's privileges, then click Finish.

    The user now has access to the selected instance(s).

    These privileges are automatically assigned from top to bottom in the hierarchy. For example, if the Run OGG Command privilege is assigned to an OGG instance, it’s automatically assigned to all its child processes. However, you can also provide process specific privileges. Suppose the Edit OGG parameter file privilege is assigned to a process, it’s specific to that process and is not assigned to other processes in the instance.

15. Test the instance-level security to confirm that all edited processes are operating with their assigned privileges:
    1. Log in as the newly created or edited user.
    2. Select Targets, GoldenGate to open the Oracle GoldenGate page.
    3. Confirm that only the OGG instances that you have access to are visible.
    4. Log out and log in again as root.
    5. Select Targets, GoldenGate to open the Oracle GoldenGate page.
    6. You should now see all the managed OGG instances.

For more details, see Security.

Authorizing Users with Permissions

As an administrator user, you can provide the following permissions to the users: Editing an Oracle GoldenGate parameter file, running an Oracle GoldenGate command, viewing the contents of any Oracle GoldenGate discard file, and viewing contents of any Oracle GoldenGate report file.

To provide permissions to the users:

1. Log in as a super admin (for example, sysman).
2. Select Setup, Security, Administrators to open the Administrators page.
3. Click Edit to modify access for an existing user.
4. Click Next to display the Privileges applicable to all Targets page to view all the four permissions.
5. Select the required permission and click Submit.

Note:

• The buttons are disabled for the users if they don't have the required permission. For example, if the user doesn't have Edit Parameters permission, then the Edit button in the Configuration tab for all the targets is disabled.

• If the users are already logged-in and their permissions are changed by the super administrator, then new permissions are reflected in the user interface (UI) once the logged-in user refreshes the page.

• If you happen to remove permissions for a logged-in user who has the command privileges, then when the user clicks any of the command buttons, such as Start, Stop, Kill, or Resume, then an error message is displayed that says that the user doesn't have sufficient permissions.

Monitoring the High Availability Features

This topic explains the monitoring of High Availability features for Oracle GoldenGate Management Pack. For the High Availability feature to properly function with Oracle GoldenGate plug-in, virtual IP (not the physical IP) of the Oracle GoldenGate host must be provided at the time of Oracle GoldenGate target discovery.

There can be two scenarios where High Availability is required:

• Oracle GoldenGate instance is failed over from one node to another in the cluster: In this scenario, the existing Master Agent continues monitoring the Oracle GoldenGate instance in a seamless manner and the Host Name parameter in the Oracle GoldenGate Manager page displays the physical host name of the new node.

• Current Master Agent stops functioning: In this scenario, the EM Agents that are currently running, must be marked as Slave for this Oracle GoldenGate instance. When the current Master Agent stops functioning, one of the Slave agents is assigned as Master for the Oracle GoldenGate instance, and monitoring continues.

This procedure uses both the Oracle Enterprise Manager Cloud Control portal and a console connection.

1. Start Oracle Enterprise Manager Cloud Control.
2. Login using the provided credentials.

   The user must have sysman privilege.

3. Select Setup, Manage Cloud Control, Agents to open the Agents page.

   All the agents are listed on this page.

4. Select Targets, GoldenGate.
5. Select Setup, Add target, Configure Auto Discovery.
6. Select the host and click Discovery Modules to provide credentials details by selecting Goldengate discovery.
   See Discovering Oracle GoldenGate Targets.
7. Click Discovered Targets for a particular Agent Host Name.
   The dialog lists all the targets on hosts, select a particular host.
   1. Click Promote to promote the particular process to display a confirmation dialog box (that says Do You Want to Manage Agents now?) when the promotion process is completed.
   2. In the confirmation dialog box, click Yes to Manage Agents.

      Note:

      You can bypass the Manage Agents page that displays a confirmation page. By bypassing this page, the promotion of the Oracle GoldenGate targets happens quickly.
8. Click Submit from the Manage Agents page to display a confirmation page. However, this is an optional step.

   This page displays after successful completion of the promotion of the targets. It includes the recently promoted Oracle GoldenGate instance with a list of all EM agents where Oracle GoldenGate plug-in is deployed.

   The agent through which these targets were discovered and promoted, is shown as Master for this Oracle GoldenGate instance. All other agents are marked as None, which means that they’re not associated with this Oracle GoldenGate instance. You can select any number of these agents as Slave, and click Submit to save the changes.

   If you don't want to make any such changes, you can click Oracle GoldenGate Home and navigate back to the Oracle GoldenGate plug-in home page.

   After the process promotion, you can see the promoted target in the Oracle GoldenGate Home page.
9. If you want to start, stop, or kill the process, then navigate to the corresponding process page and then select appropriate controls.
10. Click Targets, select GoldenGate, and then select the process, which you want to either start or stop.
    You can select any of the processes, such as Extract, Replicat, or Data Pump to start or stop.
    The status of the Oracle GoldenGate processes is reflected according to the option you selected (Start/Stop/Kill) and it gets reflected in both the OGG Home page as well as Process Details page. Click Refresh to view the updates.