Documentation Oracle Cloud Infrastructure

Evénements Data Catalog

Les événements Oracle Cloud Infrastructure sont des fichiers JSON émis avec certaines opérations de service qui contiennent des informations sur l'opération concernée.

Vous pouvez définir des règles déclenchant une action spécifique si un événement donné se produit. Pour plus d'informations, reportez-vous à Présentation d'Events et à Introduction à Events. Pour plus d'informations sur la gestion des règles pour les événements, reportez-vous à Gestion des règles pour Events.

Data Catalog émet un événement au cours de l'une des opérations suivantes :

  • Démarrage d'un travail de collecte
  • Fin d'un travail de collecte
  • Echec d'un travail de collecte
  • Mise à jour d'une entité de données logique
  • Mise à jour d'une valeur de propriété personnalisée

Types d'événement des travaux de collecte

Lorsque vous exécutez un travail de collecte, Data Catalog extrait les métadonnées techniques d'une source de données connectée dans votre référentiel de catalogue de données. Data Catalog émet des événements lorsqu'un travail de collecte commence et prend fin. Par exemple, vous pouvez configurer le service Oracle Cloud Infrastructure Events pour recevoir un courriel lors de la réussite des travaux de collecte.

Nom convivial Description Type d'événement
Collecte - Début

Lorsque Data Catalog démarre un travail de collecte, il émet un événement contenant des informations, telles que le nom de la ressource de données et l'ID du compartiment. Le statut de la collecte est IN_PROGRESS.

 com.oraclecloud.datacatalog.harvestjob.begin
Collecte - Fin

Lorsque le travail de collecte prend fin, Data Catalog émet un événement présentant le statut de collecte SUCCEEDED ou FAILED.

 com.oraclecloud.datacatalog.harvestjob.end
Exemple d'événement de travail de collecte

Voici un événement de référence pour un événement de collecte réussi :

{
    "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>"
    }
  }

Type d'événement pour les entités de données logiques

Une entité de données logique est un groupe de fichiers Object Storage dérivés par la création de modèles de nom de fichier et leur affectation à une ressource de données. Data Catalog émet des événements lorsqu'une entité de données logique est mise à jour. Par exemple, lorsque vous créez, mettez à jour ou supprimez une entité de données logique, Data Catalog émet un événement, sous la forme d'un fichier JSON. Vous pouvez configurer le service Oracle Cloud Infrastructure Events de façon à recevoir ce fichier JSON par courriel ou via Slack lorsque des entités de données logiques sont mises à jour dans un compartiment donné.

Nom convivial Description Type d'événement
Entités logiques - Modification

Lorsque vous mettez à jour une entité de données logique, Data Catalog émet un événement concernant vos modifications. Le fichier JSON de l'événement contient des informations sur les entités de données logiques créées, mises à jour et supprimées.

 com.oraclecloud.datacatalog.changedlogicalentities
Exemple d'événement d'entité de données logique

Voici un événement de référence pour une mise à jour des entités de données logiques :

{
    "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>"
    }
  }

Type d'événement pour la mise à jour d'une valeur de propriété personnalisée

Les propriétés personnalisées permettent de capturer le contexte métier des objets de catalogue de données. Data Catalog émet un événement, sous la forme d'un fichier JSON, lorsque la valeur d'une propriété personnalisée d'un objet de catalogue de données est mise à jour.

Vous pouvez configurer le service Oracle Cloud Infrastructure Events de sorte qu'il vous envoie ce fichier JSON par courriel ou via Slack chaque fois que la valeur d'une propriété personnalisée est mise à jour dans un compartiment spécifique.

Nom convivial Description Type d'événement

Valeur de propriété personnalisée - Mise à jour

Lorsque vous ajoutez, mettez à jour ou supprimez une valeur de propriété personnalisée d'un objet de catalogue de données, Data Catalog émet un événement. Le fichier JSON de l'événement inclut des informations sur l'objet mis à jour, la propriété personnalisée et la valeur de la propriété personnalisée.

 com.oraclecloud.datacatalog.object.customproperty.update
Exemple d'événement de mise à jour de valeur de propriété personnalisée

Voici un événement de référence pour la mise à jour d'une valeur de propriété personnalisée :

{
 "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>"
 }
}