Recepción de notificaciones para eventos de recopilación de Data Catalog

En este tutorial, configurará el servicio Oracle Cloud Infrastructure Events para enviarle un correo electrónico cada vez que se inicie, se realice correctamente o falle un trabajo de recogida de Data Catalog en un compartimento específico. Entre las tareas principales se incluyen los siguientes procedimientos:

  • Crear temas y suscripciones.
  • Escribir reglas para recibir notificaciones de eventos por correo electrónico.
  • Crear buckets con datos.
  • Recoger datos en Data Catalog.

Antes de empezar

Para realizar correctamente este tutorial, debe tener lo siguiente:

Si tiene derechos administrativos en su cuenta, omita el resto de esta sección. De lo contrario, pida al administrador que agregue la siguiente política a su cuenta:
allow group <the-group-your-username-belongs> to manage all-resources in compartment catalog-compartment

Consulte Políticas comunes para obtener más ejemplos.

Nota

En la siguiente sección, creará un compartimento para las instancias de Data Catalog denominado catalog-compartment.

1. Configuración de una notificación

En esta sección, configurará el servicio de notificaciones para registrar su correo electrónico para una suscripción personalizada. Posteriormente, utilizará esta suscripción para recibir notificaciones en su cuenta de correo electrónico.

Crear un compartimento

Cree un compartimento para instancias, eventos y notificaciones de Data Catalog.

  1. Abra el menú de navegación y seleccione Identidad y seguridad. En Identidad, seleccione Compartimentos.
  2. Seleccione Create Compartment.
  3. Rellene la siguiente información:
    • Nombre: catalog-compartment
    • Descripción: Compartment for data catalogs.
    • Compartimento principal: <your-tenancy>(root)
  4. Seleccione Create Compartment.

Ha creado correctamente un compartimento para los recursos de Data Catalog.

Creación de un tema
  1. Abra el menú de navegación y seleccione Servicios para desarrolladores. En Integración de aplicaciones, seleccione Notificaciones.
  2. En el panel del extremo izquierdo, para Compartimento, seleccione catalog-compartment.
    Refresque la navegación del extremo izquierdo si no se muestra la sección Compartimento catalog-compartment.
    Nota

    Asegúrese de seleccionar este compartimento para todos los recursos que cree en este tutorial.
  3. Seleccione Crear tema.
  4. Rellene la siguiente información:
    • Nombre: catalog-topic
    • Descripción: Topic for data catalog harvest events.
  5. Seleccione Crear.
Ha creado correctamente un tema para las notificaciones.
Creación de una suscripción
  1. En el servicio Notificaciones, en la lista de temas, seleccione catalog-topic.
  2. Seleccione Crear suscripción.
  3. Rellene la siguiente información:
    • Protocolo: Correo electrónico
    • Email: <your-email>
  4. Seleccione Crear.
  5. Consulte su cuenta de correo electrónico para ver si ha recibido un mensaje con el asunto noreply@notification.<your-region>.oci.oraclecloud.com
  6. Seleccione el enlace Confirmar suscripción del correo electrónico.
    En el explorador, se abrirá una página con el siguiente mensaje:

    Suscribió <su-email> al tema: catalog-topic.

  7. En la consola, espere a que el estado de la suscripción cambie de pendiente a activa.
Ha creado correctamente una suscripción de correo electrónico al tema.

2. Configuración de una regla de evento

En esta sección, configurará una regla en el servicio Events que le enviará un correo electrónico cada vez que se inicie, se realice correctamente o falle un trabajo de recopilación en el compartimento.

Creación de una regla
  1. Abra el menú de navegación y seleccione Observación y gestión. En Servicio de eventos, seleccione Reglas.
  2. Seleccione Create Rule.
  3. Rellene la siguiente información:
    • Nombre mostrado: catalog-harvest-rule
    • Descripción: Receive an email when a harvest job starts, succeeds or fails in the catalog-compartment.
    • Condiciones de Regla:
      • Condición: Tipo de evento
      • Nombre del servicio: Data Catalog
      • Tipo de evento: Harvest - Begin
      • Tipo de evento: Harvest-End
      Nota

      Asegúrese de seleccionar Harvest-Begin y Harvest-End.
  4. Seleccione + Otra condición.
  5. Rellene la siguiente información:
    • Condiciones de Regla:
      • Condición: Atributo
      • Nombre de atributo: CompartmentName
      • Valores de atributo: catalog-compartment

    La lógica de regla se rellena automáticamente:

    MATCH event WHERE (
    eventType EQUALS ANY OF (
    com.oraclecloud.datacatalog.harvestjob.end,
    com.oraclecloud.datacatalog.harvestjob.begin
    )
    AND (
    compartmentName MATCHES ANY OF (
    laleh-catalog-compartment
    )
    )
    )
  6. En la sección Acciones, rellene la siguiente información:
    • Tipo de acción: Notifications
    • Compartimento de notificaciones: catalog-compartment
    • Tema: catalog-topic
  7. Seleccione Create Rule.
Ha creado correctamente una regla de evento para los trabajos de recogida de Data Catalog.

3. Creación de un bucket con datos

En esta sección, creará un bucket en el servicio Object Storage. A continuación, agregará datos al bucket.

Creación de un bucket

Cree un bucket en el servicio Object Storage.

  1. Abra el menú de navegación y seleccione Storage. En Almacenamiento de objetos y archivos, seleccione Cubos.
  2. Seleccione Create Bucket.
  3. Rellene la siguiente información:
    • Nombre: catálogo-bloque
    • Deje el valor por defecto en los otros campos.
  4. Seleccione Create Bucket.
Ha creado correctamente un bucket para los datos.
Adición de datos al bucket
  1. En el servicio Object Storage, en la lista de cubos, seleccione catalog-bucket.
  2. Seleccione Cargar.
  3. Seleccione las dos imágenes que preparó en la sección Antes de comenzar.
  4. Seleccione Cargar y, a continuación, Cerrar.
    Las dos imágenes aparecerán en la lista Objetos.
Ha agregado correctamente datos al bucket.
Concesión de acceso a Data Catalog al bucket
En esta sección, proporcionará al servicio de Data Catalog acceso a los recursos de Object Storage en catalog-compartment. Esta política permite a las instancias de Data Catalog descargar metadatos de catalog-bucket.
  1. Abra el menú de navegación y seleccione Identidad y seguridad. En Identidad, seleccione Políticas.
  2. Seleccione Crear política.
  3. Rellene la siguiente información:
    • Nombre: catalog-policy
    • Descripción: Allow Data Catalog to access Object Storage resources.
    • En la sección Creador de políticas, seleccione Personalizar (avanzado).
  4. Pegue la siguiente política en el creador de política:
    allow service datacatalog to read object-family in compartment catalog-compartment
  5. Seleccione Crear.
Ha creado correctamente una política para que Data Catalog pueda acceder a los recursos de Object Storage, incluidos los buckets.

4. Recogida del bucket

En esta sección, creará una instancia de Data Catalog. A continuación, conectará la instancia de Data Catalog al bucket y recogerá los metadatos del bucket. Por último, revisará las notificaciones de correo electrónico sobre los trabajos de recogida.

Recopilación de la información necesaria

Preparar la información que necesita y copiarla en un bloc de notas.

Recopile la siguiente información de la consola:

  • ID de compartimento: <compartment-ocid>
    • En la barra de búsqueda de la consola, escriba catalog-compartment.
    • Seleccione catalog-compartment en los resultados de búsqueda.
    • Copie el OCID.
  • (OCI) Región: <region-identifier>
    • En la barra de navegación superior, busque <your-region>. Ejemplo: Oeste de EE. UU. (Phoenix).
    • En la barra de navegación superior, vaya al icono Perfil y seleccione Tenancy: <your tenancy>.
    • Seleccione Gestionar regiones.
    • En la lista de regiones, busque el <region-identifier> de <your-region>. Ejemplo: us-phoenix-1.
  • URL: <object-storage-swift-URI>
    • Copie la siguiente cadena:
      https://swiftobjectstorage.<region-identifier>.oraclecloud.com
    • Sustituya <region-identifier> por la información recopilada para Región.
  • Espace: <object-storage-namespace>
    • En la barra de navegación superior, vaya al icono Perfil y seleccione Tenancy: <your tenancy>.
    • Copie el valor para Espacio de nombres de almacenamiento de objetos.
Creación de una instancia de Data Catalog
  1. Abra el menú de navegación y seleccione Análisis e IA. En Lago , seleccione Data Catalog.
  2. Seleccione Crear Data Catalog.
  3. Rellene la siguiente información:
    • Crear en compartimento: catalog-compartment
    • Nombre: catalog-instance-1
    • Deje el valor por defecto en los otros campos.
  4. Seleccione Crear Data Catalog.
Ha creado correctamente una instancia de Data Catalog.
Creación de un activo de datos
  1. En el servicio Data Catalog, en la lista de instancias del catálogo de datos, seleccione catalog-instance-1.
  2. En el mosaico Acciones rápidas, seleccione Crear activo de datos.
  3. Rellene la siguiente información:
    • Nombre: object-storage-data-asset
  4. En Tipo, seleccione Oracle Object Storage
  5. Utilice la información de la sección Recopilar la información necesaria para los siguientes campos:
    • URL: https://swiftobjectstorage.<region-identifier>.oraclecloud.com
    • Espace: <object-storage-namespace>
  6. Seleccione Crear.
Ha creado correctamente un activo de datos en la instancia de Data Catalog.
Conexión al bucket
Conecte catalog-bucket a catalog-instance-1.
  1. En la página Inicio de catalog-instance-1, vaya al mosaico Actualizado recientemente y seleccione object-storage-data-asset.
  2. En Conexiones, seleccione Agregar conexión.
  3. Rellene la siguiente información:
    • Nombre: catalog-bucket-connection
  4. En Tipo, seleccione S2S Principal
  5. Utilice la información de la sección Recopilar la información necesaria para los siguientes campos:
    • Región OCI: <region-identifier>
    • OCID de compartimento: <compartment-ocid>
  6. Seleccione Convertir esta conexión en el valor por defecto para el activo de datos.
  7. Seleccione Probar conexión.
  8. Seleccione Agregar.
Ha conectado correctamente un bucket a la instancia de Data Catalog.
Recogida del bucket
  1. En la página Inicio de catalog-instance-1, vaya al mosaico Actualizado recientemente y seleccione object-storage-data-asset.
  2. Seleccione Recogida.
  3. En el paso Seleccionar conexión, seleccione catalog-bucket-connection y, a continuación, seleccione Siguiente.
  4. En el paso Seleccionar entidades de datos, realice lo siguiente:
    • Visualice el contenido del cubo: seleccione catalog-bucket.
    • Agregue los metadatos de todas las imágenes al catálogo: seleccione Agregar todo.
    • Seleccione Next (Siguiente).
  5. Rellene o seleccione los siguientes campos:
    • Nombre del trabajo: harvest-catalog-bucket
    • Incluir Archivos No Reconocidos: seleccionado
    • Deje el valor por defecto en los otros campos.
  6. Seleccione Crear trabajo.
  7. Seleccione el trabajo cosecha-catálogo-cubo.
  8. Confirme el siguiente resumen:
    • Estado: Succeeded
    • Filiales de datos recogidas: 2
    • Archivos Harvested no reconocidos: 2 (las imágenes son archivos no reconocidos).
Ha creado correctamente un trabajo de recogida para el bucket en la instancia de Data Catalog.
Consulta del correo electrónico
  1. Compruebe si ha recibido un correo electrónico con el siguiente asunto:

    OCI Event Notification :com.oraclecloud.datacatalog.harvestjob.begin

  2. Revise el contenido del correo electrónico.

    De: noreply@notification.<region-identifier>.oci.oraclecloud.com

    Ejemplo de cuerpo del correo electrónico:

    {
      "eventType" : "com.oraclecloud.datacatalog.harvestjob.end",
      "cloudEventsVersion" : "0.1",
      "eventTypeVersion" : "2.0",
      "source" : "DataCatalog",
      "eventTime" : "<time-harvest-job-began>",
      "contentType" : "application/json",
      "data" : {
        "compartmentId" : "ocid1.compartment.oc1..aaaaxxxx",
        "compartmentName" : "catalog-compartment",
        "resourceName" : "",
        "resourceId" : "ocid1.datacatalog.oc1.iad.aaaaxxxx",
        "additionalDetails" : {
          "harvestStatus" : "IN_PROGRESS",
          "dataAssetKey" : "<data-asset-key>",
          "dataAssetName" : "object-storage-data-asset",
          "connectionKey" : "<connection-key",
          "jobKey" : "<job-key>",
          "jobUrl" : "",
          "jobDefinitionKey" : "<job-definition-key>",
          "connectionName" : "catalog-bucket-connection",
          "jobDefinitionName" : "harvest-catalog-bucket",
          "jobExecutionKey" : "<job-execution-key>"
        }
      },
      "eventID" : "<event-ocid>",
      "extensions" : {
        "compartmentId" : "ocid1.compartment.oc1..aaaaxxxx"
      }
    }
    
  3. Busque el valor de "harvestStatus".
    "harvestStatus" : "IN_PROGRESS"
  4. Compruebe si ha recibido un correo electrónico con el asunto:
    OCI Event Notification :com.oraclecloud.datacatalog.harvestjob.end
  5. Revise el contenido del correo electrónico.

    De: noreply@notification.<region-identifier>.oci.oraclecloud.com

    Ejemplo de cuerpo del correo electrónico:

    {
      "eventType" : "com.oraclecloud.datacatalog.harvestjob.end",
      "cloudEventsVersion" : "0.1",
      "eventTypeVersion" : "2.0",
      "source" : "DataCatalog",
      "eventTime" : "<time-harvest-job-ended>",
      "contentType" : "application/json",
      "data" : {
        "compartmentId" : "ocid1.compartment.oc1..aaaaxxxx",
        "compartmentName" : "catalog-compartment",
        "resourceName" : "",
        "resourceId" : "ocid1.datacatalog.oc1.iad.aaaaxxxx",
        "additionalDetails" : {
          "harvestStatus" : "SUCCEEDED",
          "dataAssetKey" : "<data-asset-key>",
          "dataAssetName" : "object-storage-data-asset",
          "connectionKey" : "<connection-key",
          "jobKey" : "<job-key>",
          "jobUrl" : "",
          "jobDefinitionKey" : "<job-definition-key>",
          "connectionName" : "catalog-bucket-connection",
          "jobDefinitionName" : "harvest-catalog-bucket",
          "jobExecutionKey" : "<job-execution-key>"
        }
      },
      "eventID" : "<event-ocid>",
      "extensions" : {
        "compartmentId" : "ocid1.compartment.oc1..aaaaxxxx"
      }
    }
    
  6. Busque el valor de "harvestStatus".
    "harvestStatus" : "SUCCEEDED"
    El estado es Completado:
    Nota

    El valor de "harvestStatus" para un evento harvestjob.begin es "IN_PROGRESS" y para un evento harvestjob.end, es "SUCCEEDED" o "FAILED".