Documentación de Oracle Cloud Infrastructure

Eventos de Data Catalog

Oracle Cloud Infrastructure Events son archivos JSON que se emiten con algunas operaciones de servicio y contienen información sobre esa operación.

Puede definir reglas que disparen una acción específica cuando se produce un evento. Para obtener más información, consulte Visión general de Events e Introducción a Events. Para obtener información sobre la gestión de reglas para eventos, consulte Gestión de reglas de Events.

Data Catalog emite un evento durante una de las siguientes acciones:

  • Se inicia un trabajo de recopilación.
  • Finaliza un trabajo de recopilación.
  • Falla un trabajo de recogida.
  • Se actualiza una entidad de datos lógica.
  • Se actualiza el valor de una propiedad personalizada.

Tipos de eventos para trabajos de recogida

Al ejecutar un trabajo de recogida, Data Catalog extrae metadatos técnicos de un origen de datos conectado al repositorio de Data Catalog. Data Catalog emite eventos cuando se inicia y finaliza un trabajo de recogida. Por ejemplo, puede configurar el servicio Oracle Cloud Infrastructure Events para enviarle un correo electrónico cuando los trabajos de recogida se realicen correctamente.

Nombre descriptivo Descripción Tipo de evento
Harvest - Begin

Cuando Data Catalog inicia un trabajo de recogida, emite un evento que contiene información sobre el trabajo, como el nombre del activo de datos, el ID de compartimento y el estado de recogida IN_PROGRESS.

 com.oraclecloud.datacatalog.harvestjob.begin
Harvest - End

Una vez finalizado el trabajo de recogida, Data Catalog emite un evento con el estado de recogida SUCCEEDED o FAILED.

 com.oraclecloud.datacatalog.harvestjob.end
Ejemplo de evento de trabajo de recogida

A continuación, se incluye un evento de referencia para un evento de finalización de recogida realizada correctamente:

{
    "eventType": "com.oraclecloud.datacatalog.harvestjob.end",
    "eventID": "<unique_ID>",
    "cloudEventsVersion": "0.1",
    "eventTypeVersion": "2.0",
    "source": "DataCatalog",
    "eventTime": "2020-12-02T13:31:31.979Z",
    "contentType": "application/json",
    "data": {
      "eventGroupingId": "<JobExecutionKey>",
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>",
      "compartmentName": "<CompartmentName where the user's catalog resides>",
      "resourceId": "ocid1.datacatalog.oc1.<unique_ID>",
      "additionalDetails": {
        "dataAssetKey": "<DataAssetKey>",
        "dataAssetName": "<DataAssetName>",
        "jobDefinitionKey": "<JobDefinitionKey>",
        "jobDefinitionName": "<JobDefinitionName>",
        "connectionKey": "<ConnectionKey>",
        "connectionName": "<ConnectionName>",
        "jobKey": "<JobKey>",
        "jobExecutionKey": "<JobExecutionKey>",
        "harvestStatus": "SUCCEEDED",
        "jobUrl": "<Url to get the execution details of the job>"
        "HarvestedFoldersCount" : 0,
        "HarvestedEntitiesCount" : 0,
        "HarvestedLogicalEntitiesCount" : 0,
        "HarvestedPhysicalEntitiesCount" : 0,
        "HarvestedArchivedFilesCount" : 0,
        "SkippedFilesCount" : 0,
        "HarvestedUnrecognizedFilesCount" : 0,
        "HarvestedFoldersCountStr" : "0",
        "HarvestedEntitiesCountStr" : "0",
        "HarvestedLogicalEntitiesCountStr" : "0",
        "HarvestedPhysicalEntitiesCountStr" : "0",
        "HarvestedArchivedFilesCountStr" : "0",
        "SkippedFilesCountStr" : "0",
        "HarvestedUnrecognizedFilesCountStr" : "0"
      }
    },
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>"
    }
  }

Tipo de evento para entidades de datos lógicas

Una entidad de datos lógica es un grupo de archivos de Object Storage que se derivan mediante la creación y la asignación de patrones de nombre de archivo a un activo de datos. Data Catalog emite eventos cuando se actualiza una entidad de datos lógica. Por ejemplo, cuando se crea, actualiza o suprime una entidad de datos lógica, Data Catalog emite un evento en forma de archivo JSON. Puede configurar el servicio Oracle Cloud Infrastructure Events para enviarle este archivo JSON por correo electrónico o Slack cuando se actualicen las entidades de datos lógicas en un compartimento específico.

Nombre descriptivo Descripción Tipo de evento
Logical Entities - Change

Al actualizar una entidad de datos lógica, Data Catalog emite un evento sobre los cambios. El archivo JSON del evento incluye información sobre las entidades de datos lógicas creadas, actualizadas y suprimidas.

 com.oraclecloud.datacatalog.changedlogicalentities
Ejemplo de evento de entidad de datos lógica

A continuación, se incluye un evento de referencia para una actualización de entidades de datos lógicas:

{
    "eventType": "com.oraclecloud.datacatalog.changedlogicalentities",
    "eventID": "<unique_ID>"
,
    "cloudEventsVersion": "0.1",
    "eventTypeVersion": "2.0",
    "source": "DataCatalog",
    "eventTime": "2020-12-02T13:31:31.979Z",
    "contentType": "application/json",
    "data": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>",
      "compartmentName": "<CompartmentName where the user's catalog resides>",
      "resourceId": "ocid1.datacatalog.oc1.<unique_ID>"
,
      "additionalDetails": {
        "dataAssetKey": "<DataAssetKey>",
        "dataAssetName": "<DataAssetName>",
        "jobDefinitionKey": "<JobDefinitionKey>",
        "jobDefinitionName": "<JobDefinitionName>",
        "connectionKey": "<ConnectionKey>",
        "connectionName": "<ConnectionName>",
        "jobKey": "<JobKey>",
        "jobExecutionKey": "<JobExecutionKey>",
        "harvestStatus": "<IN_PROGRESS/SUCCEEDED/FAILED>",
        "createdLogicalEntities": ["LE_key1", "LE_key2"],
        "updatedLogicalEntities": ["LE_key3", "LE_key4"],
        "deletedLogicalEntities": ["LE_key5", "LE_key6"]
      }
    },
    "extensions": {
      "compartmentId": "ocid1.compartment.oc1.<unique_ID>"
    }
  }

Tipo de evento para la actualización del valor de propiedad personalizada

Las propiedades personalizadas se utilizan para capturar el contexto de negocio de los objetos del catálogo de datos. Data Catalog emite un evento, en forma de archivo JSON, cuando se actualiza el valor de la propiedad personalizada de un objeto de catálogo de datos.

Puede configurar el servicio Oracle Cloud Infrastructure Events de modo que se le envíe este archivo JSON por correo electrónico o a través de Slack siempre que se actualice el valor de una propiedad personalizada en un compartimento específico.

Nombre descriptivo Descripción Tipo de evento

Valor de propiedad personalizada: Actualizar

Cuando se agrega, actualiza o suprime el valor de la propiedad personalizada de un objeto de catálogo de datos, Data Catalog emite un evento. El archivo JSON del evento incluye información sobre el objeto actualizado, la propiedad personalizada y el valor de la propiedad personalizada.

 com.oraclecloud.datacatalog.object.customproperty.update
Ejemplo de evento de actualización de valor de propiedad personalizada

A continuación se incluye un evento de referencia de una actualización del valor de una propiedad personalizada:

{
 "eventType" : "com.oraclecloud.datacatalog.object.customproperty.update",
 "eventID" : "<unique_ID>",
 "cloudEventsVersion" : "0.1",
 "eventTypeVersion" : "2.0",
 "source" : "DataCatalog",
 "eventTime" : "2021-06-21T11:12:15Z",
 "contentType" : "application/json",
 "data" : {
   "compartmentId" : "ocid1.compartment.oc1.<unique_ID>",
   "compartmentName" : "<CompartmentName where the user's catalog resides>",
   "resourceName" : "",
   "resourceId" : "ocid1.datacatalog.oc1.<unique_ID>",
   "additionalDetails" : {
     "associatedObjectKey" : "<AssociatedObjectKey>",
     "associatedObjectType" : "<AssociatedObjectType>",
     "customPropertyKey" : "<CustomPropertyKey>",
     "customPropertyDataType" : "<CustomPropertyDataType>",
     "associatedValue" : "<AssociatedValue>"
   }
 },
  "extensions" : {
   "compartmentId" : "ocid1.compartment.oc1.<unique_ID>"
 }
}