Oracle Cloud Infrastructure GoldenGate Events

Events are structured messages that indicate changes in resources. You can create rules to subscribe to events and stay informed of any abnomal activity among your resources, when it's time to upgrade your deployment, or purge unused files.

Deployment Event Types

OCI GoldenGate deployments emit the following event types:

Friendly name Event type
Create Deployment Begin 
com.oraclecloud.goldengate.CreateDeployment.begin
Create Deployment End 
com.oraclecloud.goldengate.CreateDeployment.end
Delete Deployment Begin 
com.oraclecloud.goldengate.DeleteDeployment.begin
Delete Deployment End 
com.oraclecloud.goldengate.DeleteDeployment.end
Restore Deployment Begin 
com.oraclecloud.GoldenGate.RestoreDeployment.begin
Restore Deployment End 
com.oraclecloud.GoldenGate.RestoreDeployment.end
Start Deployment Begin 
com.oraclecloud.GoldenGate.StartDeployment.begin
Start Deployment End 
com.oraclecloud.GoldenGate.StartDeployment.end
Stop Deployment Begin 
com.oraclecloud.GoldenGate.StopDeployment.begin
Stop Deployment End 
com.oraclecloud.GoldenGate.StopDeployment.end
Update Deployment Begin 
com.oraclecloud.GoldenGate.UpdateDeployment.begin
Update Deployment End 
com.oraclecloud.GoldenGate.UpdateDeployment.end
Storage utilization 
com.oraclecloud.GoldenGate.StorageUtilization

Here's a reference event for deployments:

{
  "eventType": "com.oraclecloud.goldengate.updatedeployment.begin",
  "cloudEventsVersion": "0.1",
  "eventTypeVersion": "2.0",
  "source": "GoldenGate",
  "eventTime": "2021-06-23T12:00:00.000Z",
  "contentType": "application/json",
  "data": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID",
    "compartmentName": "example_compartment",
    "resourceName": "example_name",
    "resourceId": "ocid1.goldengatedeployment.<realm>.<region>..<unique_ID>",
    "availabilityDomain": "availability_domain",
    "freeFormTags": {},
    "definedTags": {}
  },
  "eventID": "unique_ID",
  "extensions": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID"
  }
}

Deployment Backup Event Types

OCI GoldenGate deployment backups emit the following event types:

Friendly name Event type
Create Deployment Backup Begin 
com.oraclecloud.GoldenGate.CreateDeploymentBackup.begin
Create Deployment Backup End 
com.oraclecloud.GoldenGate.CreateDeploymentBackup.end
Delete Deployment Backup Begin 
com.oraclecloud.GoldenGate.DeleteDeploymentBackup.begin
Delete Deployment Backup End 
com.oraclecloud.GoldenGate.DeleteDeploymentBackup.end
Update Deployment Backup Begin 
com.oraclecloud.GoldenGate.UpdateDeploymentBackup.begin
Update Deployment Backup End 
com.oraclecloud.GoldenGate.UpdateDeploymentBackup.end

Here's a reference event for Deployment Backups:

{
  "eventType": "com.oraclecloud.goldengate.deletedeploymentbackup.begin",
  "cloudEventsVersion": "0.1",
  "eventTypeVersion": "2.0",
  "source": "GoldenGate",
  "eventTime": "2021-06-23T12:00:00.000Z",
  "contentType": "application/json",
  "data": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID",
    "compartmentName": "example_compartment",
    "resourceName": "example_name",
    "resourceId": "ocid1.goldengatedeployment.<realm>.<region>..<unique_ID>",
    "availabilityDomain": "availability_domain",
    "freeFormTags": {},
    "definedTags": {}
  },
  "eventID": "unique_ID",
  "extensions": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID"
  }
}

Deployment Lifecycle Event Types

OCI GoldenGate deployment lifecycle states emit the following events:

Friendly name Event type
GoldenGate Deployment Active 
com.oraclecloud.goldengate.stateactive
GoldenGate Deployment Creating 
com.oraclecloud.goldengate.statecreating
GoldenGate Deployment Deleted 
com.oraclecloud.goldengate.statedeleted
GoldenGate Deployment Deleting 
com.oraclecloud.goldengate.statedeleting
GoldenGate Deployment Failed 
com.oraclecloud.goldengate.statefailed
GoldenGate Deployment Inactive 
com.oraclecloud.goldengate.stateinactive
GoldenGate Deployment Needs Attention 
com.oraclecloud.goldengate.stateneedsattention
GoldenGate Deployment Updating 
com.oraclecloud.goldengate.stateupdating

Here's a reference event for deployment lifecycle state:

{
  "eventType": "com.oraclecloud.goldengate.stateactive",
  "cloudEventsVersion": "0.1",
  "eventTypeVersion": "2.0",
  "source": "GoldenGate",
  "eventTime": "2021-06-23T12:00:00.000Z",
  "contentType": "application/json",
  "data": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID",
    "compartmentName": "example_compartment",
    "resourceName": "example_name",
    "resourceId": "ocid1.goldengatedeployment.<realm>.<region>..<unique_ID>"
  },
  "eventID": "unique_ID",
  "extensions": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID"
  }
}

Upgrade Event Type

The OCI GoldenGate upgrade emits the following event type:

Friendly name Event type
GoldeGate Upgrade Available 
com.oraclecloud.goldengate.upgradenewversion
GoldenGate Upgrade Maintenance Scheduled 
com.oraclecloud.goldengate.upgrademaintenanceschedule

Example of Upgrade maintenance scheduled event reference:

{  
"eventType": "com.oraclecloud.goldengate.upgrademaintenanceschedule",
"cloudEventsVersion": "0.1",
"eventTypeVersion": "2.0",
"source": "GoldenGate",
"eventTime": "2024-06-23T12:00:00.000Z",
"contentType": "application/json",
"data": {
    "compartmentId": "ocid1.compartment.<realm>.<region>..<unique_ID>",
    "compartmentName": "example_compartment",
    "resourceName": "example_name",
    "resourceId": "ocid1.goldengatedeployment.<realm>.<region>..<unique_ID>",
    "additionalDetails": {
      "goldengatedeploymentupgrade": "ocid1.goldengatedeploymentupgrade.<realm>.<region>..<unique_ID>",
      "message": "Maintenance schedule time: '<schedule_time>, OGG version:
        '<ogg_version>'.",
      "type": "UPGRADE_SCHEDULE"
    }
  },
  "eventID": "unique_ID",
  "extensions": {
    "compartmentId": "ocid1.compartment.<realm>.<region>..<unique_ID>"
  }
}

Example of Upgrade canceled event reference:

{ 
"eventType": "com.oraclecloud.goldengate.upgrademaintenanceschedule", 
"cloudEventsVersion": "0.1", 
"eventTypeVersion": "2.0", 
"source": "GoldenGate", 
"eventTime": "2024-06-23T12:00:00.000Z", 
"contentType": "application/json", 
"data": {
   "compartmentId": "ocid1.compartment.<realm>.<region>..<unique_ID>",
   "compartmentName": "example_compartment",
   "resourceName": "example_name",
   "resourceId": "ocid1.goldengatedeployment.<realm>.<region>..<unique_ID>",
   "additionalDetails": { 
      "goldengatedeploymentupgrade": "ocid1.goldengatedeploymentupgrade.<realm>.<region>..<unique_ID>", 
      "message": "Scheduled upgrade has been cancelled, <cancellation_reason>", 
        "type": "UPGRADE_SCHEDULE"
     }
 },
 "eventID": "unique_ID",
 "extensions": { 
    "compartmentId": "ocid1.compartment.<realm>.<region>..<unique_ID>" 
  }
}

Example of New GoldenGate version available event reference:

{
  "eventType": "com.oraclecloud.goldengate.upgradenewversion",
  "cloudEventsVersion": "0.1",
  "eventTypeVersion": "2.0",
  "source": "GoldenGate",
  "eventTime": "2024-06-23T12:00:00.000Z",
  "contentType": "application/json",
  "data": {
    "compartmentId": "ocid1.compartment.<realm>.<region>..<unique_ID>",
    "compartmentName": "example_compartment",
    "resourceName": "example_name",
    "resourceId": "ocid1.goldengatedeployment.<realm>.<region>..<unique_ID>",
    "additionalDetails": {
      "message": "New ogg version is available.",
      "version": "oggoracle:23..<unique_ID>"
    }
  },
  "eventID": "unique_ID",
  "extensions": {
    "compartmentId": "ocid1.compartment.<realm>.<region>..<unique_ID>"
  }
}

Pipeline Event Types

OCI GoldenGate pipelines emit the following event types:

Friendly name Event type
Create Pipeline Begin 
com.oraclecloud.goldengate.createpipeline.begin
Create Pipeline End 
com.oraclecloud.goldengate.createpipeline.end
Delete Pipeline Begin 
com.oraclecloud.goldengate.deletepipeline.begin
Delete Pipeline End 
com.oraclecloud.goldengate.deletepipeline.end
Deleted 
com.oraclecloud.goldengate.pipeline.statedeleted
Deleting 
com.oraclecloud.goldengate.pipeline.statedeleting
Failed 
com.oraclecloud.goldengate.pipeline.statefailed
Needs Attention 
com.oraclecloud.goldengate.pipeline.stateneedsattention
Running 
com.oraclecloud.goldengate.pipeline.staterunning
State Pipeline Begin 
com.oraclecloud.goldengate.startpipeline.begin
State Pipeline End 
com.oraclecloud.goldengate.startpipeline.end
Stop Pipeline Begin 
com.oraclecloud.goldengate.stoppipeline.begin
Stop Pipeline End 
com.oraclecloud.goldengate.stoppipeline.end
Stopped 
com.oraclecloud.goldengate.pipeline.statestopped
Update Pipeline Begin 
com.oraclecloud.goldengate.updatepipeline.begin
Update Pipeline End 
com.oraclecloud.goldengate.updatepipeline.end
Updating 
com.oraclecloud.goldengate.pipeline.stateupdating
   

Here's a reference event for pipelines:

{
  "eventType": "com.oraclecloud.goldengate.startpipeline.begin",
  "cloudEventsVersion": "0.1",
  "eventTypeVersion": "2.0",
  "source": "GoldenGate",
  "eventID": "unique_ID",
  "eventTime": "2025-02-13T06:29:10.357Z",
  "contentType": "application/json",
  "data": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID",
    "compartmentName": "example_compartment",
    "resourceName": "example_name",
    "resourceId": "ocid1.goldengatepipeline.<realm>.<region>..<unique_ID>",
    "availabilityDomain": "availability_domain",
    "freeformTags": {},
    "definedTags": {}
  },
  "extensions": {
    "compartmentId": "ocid1.compartment.oc1..unique_ID"
  }
}