Monitor Oracle Goldengate with Oracle Enterprise Manager

In this guide we will configure

Oracle Goldengate (OGG) Plug-in for Oracle Enterprise Manager (OEM)
OGG monitor agent which is used by OEM for monitoring.

Deploy Oracle GoldenGate System Monitoring Plug-In

Official documentation:

https://docs.oracle.com/en/middleware/goldengate/emplugin/13.5.1/empug/index.html

Identify OEM version to download compatible version of OGG plug-in

https://edelivery.oracle.com.

Extract and copy plug-in to a temporary folder at OEM OMS host and import the plug-in

# OEM OMS server is emcc.example.com
# 13.5.1.0.0_oracle.fmw.gg_2000_0.opar is under /tmp

[oracle@emcc]$  cd /u01/OracleHomes/Middleware/bin
[oracle@emcc bin]$ ./emcli login -username=sysman
Enter password
Login successful

[oracle@emcc bin]$ ./emcli sync
Synchronized successfully

[oracle@emcc bin]$ ./emcli import_update -file="/tmp/13.5.1.0.0_oracle.fmw.gg_2000_0.opar" -omslocal
Processing update: Plug-in - GoldenGate Plug-in now supports monitoring of Oracle GoldenGate Microservices, in addition to the Oracle GoldenGate Classic
Successfully uploaded the update to Enterprise Manager. Use the Self Update Console to manage this update.

Deploy plug-in to management server

Go to OEM Plug-ins and deploy plug-in to management server.

You can monitor deployment from job activity:

From terminal:

[oracle@emcc ~]$ cd /u01/OracleHomes/Middleware/bin
[oracle@emcc bin]$ ./emcli login -username=sysman
Enter password :
Login successful
[oracle@emcc bin]$ ./emcli sync
Synchronized successfully
[oracle@emcc bin]$ ./emcli list_plugins_on_server|grep GoldenGate
Oracle GoldenGate                            oracle.fmw.gg                 13.5.1.0.0

Deploy plug-in to management agent

Setting up OEM agents on OGG servers is not covered in this guidance. It is assumed that OEM agents are already deployed and ready on hosts where OGG processes are running. Plug-in can be deployed to these agents. In this guide, to make it simple, plugin will be deployed to agent running on OMS host. It will be tested with a basic OGG installation on the same host.

After deployment, check plug-in:

$ ./emcli login -username=sysman
Enter password :
Login successful
[oracle@emcc bin]$ ./emcli list_plugins_on_agent
The Agent URL is https://emcc.example.com:3872/emd/main/ -
Plug-in Name                                 Plugin-id                     Version [revision]
Oracle GoldenGate                            oracle.fmw.gg                 13.5.1.0.0
Oracle Home                                  oracle.sysman.oh              13.5.0.0.0
Management Services and Repository           oracle.sysman.emrep           13.5.0.0.0
Oracle Fusion Middleware                     oracle.sysman.emas            13.5.1.0.0
Oracle Beacon                                oracle.sysman.beacon          13.5.0.0.0
Oracle CSA                                   oracle.sysman.csa             13.5.0.0.0
Oracle Database                              oracle.sysman.db              13.5.1.0.0

Installing and Configuring Oracle GoldenGate Monitor Agent

Official documentation:

https://docs.oracle.com/en/middleware/goldengate/monitor/12.2.1.2.0/ggain/installing-and-configuring-oracle-goldengate-monitor-agent.html

Download and extract agent software

https://www.oracle.com/middleware/technologies/goldengate-downloads.html

[oracle@emcc ~]$ cd /u01
[oracle@emcc u01]$ unzip fmw_12.2.1.2.0_ogg_Disk1_1of1.zip
Archive:  fmw_12.2.1.2.0_ogg_Disk1_1of1.zip
  inflating: fmw_12.2.1.2.0_ogg.jar
  inflating: fmw_12212_readme.htm

Install agent. In this guide installation is done using GUI. Silent installation is also possible. Check official documentation.

Create agent base home:

[oracle@emcc u01]$ mkdir /u01/oggagent

Proceed with installation (requires X11)


[oracle@emcc u01]$export JAVA_HOME=/u01/OracleHomes/agent/agent_13.5.0.0.0/oracle_common/jdk
[oracle@emcc u01]$export PATH=/u01/OracleHomes/agent/agent_13.5.0.0.0/oracle_common/jdk/bin:$PATH
[oracle@emcc u01]$java -jar -Xmx1024m  fmw_12.2.1.2.0_ogg.jar

Apply Patch

Following error occurred after agent instance is created and configured:

[oracle@emcc]$ tail -f /u01/oggagent/oggmon/<AGENT_INSTANCE>/logs/ogg_agent.log
[2024-07-31T21:48:55.861+02:00] [JAGENT] [ERROR] [OGGMON-20603] [com.goldengate.monitor.jagent.comm.ws.ManagerService] [tid: MessageCollector] [ecid: 0000P4AHc7fFw000jzwkno1aed46000002,0] RESTful Web Service with name messages/last has become unresponsive
[2024-07-31T22:01:53.593+02:00] [JAGENT] [ERROR] [OGGMON-20272] [com.goldengate.monitor.jagent.jmx.MBeansContainerImpl] [tid: StatusCollector] [ecid: 0000P4AOc7oFw000jzwkno1aedWl000001,0] unable to register the OGG instance. Due to null

Applied Patch 34362913: Oracle GoldenGate Monitor 12.2.1.2.221115 (PS2 BP9) (Server+Agent) to solve the problem.

Configure OGG monitoring agent

Create agent instance directory under OGG_AGENT_BASE_HOME/oggmon:

[oracle@emcc]$ mkdir /u01/oggagent/oggmon/agent01

Create agent instance. Create script will also configure OGG software home.

[oracle@emcc]$ cd /u01/oggagent/oggmon/ogg_agent
[oracle@emcc ogg_agent]$ ./createMonitorAgentInstance.sh
Please enter absolute path of Oracle GoldenGate home directory : /u01/ogg21bdc
Please enter absolute path of OGG Agent instance : /u01/oggagent/oggmon/agent01
Please enter unique name to replace timestamp in startMonitorAgent script (startMonitorAgentInstance_20240731200653.sh) : ogg21bdc
Successfully created OGG Agent instance.

Update agent config.properties. Refer to documentation https://docs.oracle.com/en/middleware/goldengate/monitor/12.2.1.2.0/ggain/installing-and-configuring-oracle-goldengate-monitor-agent.html#GUID-663EFDDE-AEAD-4D4B-8E17-4782B3589742

Create wallet:

[oracle@emcc]$ cd /u01/oggagent/oggmon/agent01/bin
[oracle@emcc bin]$ ./pw_agent_util.sh -jagentonly
Please create a password for Java Agent:
Please confirm password for Java Agent:
Jul 31, 2024 8:21:24 PM oracle.security.jps.JpsStartup start
INFO: Jps initializing.
Jul 31, 2024 8:21:25 PM oracle.security.jps.JpsStartup start
INFO: Jps started.
Wallet is created successfully.

Configure Oracle GoldenGate

Add ENABLEMONITORING to GLOBALS:


[oracle@emcc ogg21bdc]$ cd /u01/ogg21bdc
[oracle@emcc ogg21bdc]$ ./ggsci

Oracle GoldenGate for Big Data
Version 21.4.0.0.0 (Build 002)

Oracle GoldenGate Command Interpreter
Version 21.4.0.0.0 OGGCORE_21.4.0.0.0OGGRU_PLATFORMS_211022.1803
Oracle Linux 7, x64, 64bit (optimized), Generic  on Oct 22 2021 23:14:43
Operating system character set identified as US-ASCII.

Copyright (C) 1995, 2021, Oracle and/or its affiliates. All rights reserved.

GGSCI (emcc.example.com) 3> edit params ./GLOBALS

GGSCI (emcc.example.com) 3> view params ./GLOBALS

ENABLEMONITORING

GGSCI (emcc.example.com) 4> start mgr
Manager started.
GGSCI (emcc.example.com) 1> start jagent

Sending START request to Manager ...
Application GGCMD JAGENT starting.

GGSCI (emcc.example.com) 6> start PMSRVR
PM Service started.

GGSCI (emcc.example.com) 2> info all

Program     Status      Group       Lag at Chkpt  Time Since Chkpt

MANAGER     RUNNING
JAGENT      RUNNING
PMSRVR      RUNNING
...