Ingérer des données à partir de Box

info

Bêta

Cette fonctionnalité est en version Bêta. Pour l’utiliser, un administrateur de workspace doit activer Lakeflow Connect for Box Audit Logs depuis la page Prévisualisations . Consultez Gérer les aperçus Databricks.

Créez un pipeline d’ingestion managé des logs d’audit Box dans Lakeflow Connect pour ingérer les événements d’audit de l’entreprise dans Databricks.

Conditions requises

• Pour créer un pipeline d’ingestion, vous devez d’abord remplir les conditions suivantes :

  • Votre workspace doit être activé pour Unity Catalog.

  • Le compute serverless doit être activé pour votre workspace. Voir Exigences du compute serverless.

  • Pour créer une nouvelle connexion, vous devez disposer des privilèges CREATE CONNECTION sur le métastore. Consultez Gérer les privilèges dans Unity Catalog.

    Si le connecteur prend en charge la création de pipelines à partir de l’interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes décrites sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipelines à partir de l’API ou ne sont pas des administrateurs, un administrateur doit d’abord créer la connexion dans l’Explorateur de catalogue. Voir Connexion aux sources d’ingestion gérées.

  • Pour utiliser une connexion existante, vous devez disposer des privilèges USE CONNECTION ou ALL PRIVILEGES sur l’objet de connexion.

  • Vous devez disposer des privilèges USE CATALOG sur le catalogue cible.

  • Vous devez avoir les privilèges USE SCHEMA et CREATE TABLE sur un schéma existant ou les privilèges CREATE SCHEMA sur le catalogue cible.

• Pour ingérer des données depuis Box, commencez par configurer l'authentification depuis Databricks et créez une connexion. Voir Configurer l'authentification à Box et Créer une connexion aux Logs d'audit Box.

Créer un pipeline d’ingestion

Pour obtenir la liste des tables sources prises en charge, consultez la section Tables sources prises en charge.

Databricks UI

1. Dans la barre latérale du workspace Databricks, cliquez sur Ingestion de données .
2. Sur la page Ajouter des données , sous Connecteurs Databricks , cliquez sur Logs d'audit Box .
3. Sur la page Connexion de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants Box. Si vous disposez du privilège CREATE CONNECTION sur le métastore, cliquez sur Créer une connexion pour créer une connexion avec les identifiants de Configurer l'authentification pour Box.
4. Cliquez sur Suivant .
5. Sur la page Configuration de l’ingestion , entrez un nom pour le pipeline.
6. Sélectionnez un catalogue et un schéma pour y écrire les logs des événements du pipeline. Si vous avez des privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
7. Cliquez sur Créer un pipeline et continuer .
8. Sur la page Source , sélectionnez les tables à ingérer.
9. Cliquez sur Enregistrer et continuer .
10. Sur la page Destination , sélectionnez un catalogue et un schéma dans lesquels charger les données. Si vous avez les privilèges USE CATALOG et CREATE SCHEMA sur le catalogue, cliquez sur Créer un schéma dans le menu déroulant pour créer un schéma.
11. Cliquez sur Enregistrer et continuer .
12. (Facultatif) Sur la page Calendriers et notifications , cliquez sur Créer un calendrier . Définissez la fréquence de refresh des tables de destination.
13. (Facultatif) Cliquez sur Ajouter une notification pour configurer les notifications par e-mail en cas de succès ou d’échec de l’opération du pipeline.
14. Cliquez sur Enregistrer et exécuter le pipeline .

Declarative Automation Bundles

Utilisez les Declarative Automation Bundles pour gérer les pipelines Box Audit Logs en tant que code. Les bundles peuvent contenir des définitions YAML de Jobs et de tâches, sont gérés à l'aide de la CLI Databricks et peuvent être partagés et exécutés dans différents Workspace cibles (tels que le développement, la pré-production et la production). Pour plus d'informations, consultez Que sont les Declarative Automation Bundles ?.

1. Créer un bundle à l'aide de la CLI Databricks :

   Bash

   databricks bundle init

2. Ajouter deux nouveaux fichiers de ressources au bundle :

   • Un fichier de définition de pipeline (par exemple, resources/box_audit_logs_pipeline.yml). Voir pipeline.ingestion_definition et Exemples.
   • Un fichier de définition de job qui contrôle la fréquence d’ingestion des données (par exemple, resources/box_audit_logs_job.yml).

3. Déployer le pipeline avec la CLI Databricks :

   Bash

   databricks bundle deploy

Databricks notebook

1. Importez le notebook suivant dans votre workspace Databricks :

Ouvrir le notebook dans un nouvel ongletOuvrir dans Databricks

2. Ne modifiez pas les cellules un et deux. Ne pas modifier.

3. Modifiez la cellule trois avec les détails de configuration de votre pipeline. Consultez pipeline.ingestion_definition et exemples.

4. Configurez éventuellement les paramètres avancés du pipeline. Voir Modèles courants pour les pipelines d'ingestion gérés.

5. Cliquez sur Tout exécuter .

Exemples

Le connecteur Box Audit Logs fournit une table source dans le schéma source default. Ingérer la table ou le schéma entier.

Ingérer la table event_logs

Utilisez cette option pour personnaliser le nom de destination de la table.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère la table Logs d’audit Box :

YAML

resources:
  pipelines:
    box_audit_logs_pipeline:
      name: box_audit_logs_pipeline
      catalog: 'main'
      target: 'box_audit_logs_data'
      ingestion_definition:
        connection_name: box_audit_logs_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'event_logs'
              destination_catalog: 'main'
              destination_schema: 'box_audit_logs_data'
              destination_table: 'event_logs'

Databricks notebook

La spécification de pipeline suivante ingère la table Box Audit Logs :

Python

pipeline_name = "box_audit_logs_pipeline"
connection_name = "<box-audit-logs-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "event_logs",
          "destination_catalog": "main",
          "destination_schema": "box_audit_logs_data",
          "destination_table": "event_logs"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Ingérer le schéma entier

Utilisez cette option pour ingérer toutes les tables sources des journaux d'audit Box Logs dans un seul schéma de destination avec une seule déclaration.

Declarative Automation Bundles

Le fichier de définition de pipeline suivant ingère toutes les tables des Logs d'audit Box prises en charge dans un schéma de destination :

YAML

resources:
  pipelines:
    box_audit_logs_pipeline:
      name: box_audit_logs_pipeline
      catalog: 'main'
      target: 'box_audit_logs_data'
      ingestion_definition:
        connection_name: box_audit_logs_connection
        objects:
          - schema:
              source_schema: 'default'
              destination_catalog: 'main'
              destination_schema: 'box_audit_logs_data'

Databricks notebook

La spécification de pipeline suivante ingère toutes les tables de Logs d'audit Box prises en charge dans un schéma de destination :

Python

pipeline_name = "box_audit_logs_pipeline"
connection_name = "<box-audit-logs-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "schema": {
          "source_schema": "default",
          "destination_catalog": "main",
          "destination_schema": "box_audit_logs_data"
        }
      }
    ]
  }
}
json_payload = json.dumps(pipeline_spec, indent=2)
create_pipeline(json_payload)

Fichier de définition de job Declarative Automation Bundles

Voici un exemple de fichier de définition de job à utiliser avec Declarative Automation Bundles. Le job s’exécute quotidiennement.

Declarative Automation Bundles

YAML

resources:
  jobs:
    box_audit_logs_job:
      name: box_audit_logs_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: box_audit_logs_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.box_audit_logs_pipeline.id}

Modèles courants

Pour des configurations de pipeline avancées, voir Modèles courants pour les pipelines d’ingestion gérés.

Étapes suivantes

Start, planifiez et configurez des alertes sur votre pipeline. Consultez les tâches courantes de maintenance du pipeline.

Ressources supplémentaires

• FAQ du connecteur Logs d'audit Box
• Limitations du connecteur des Logs d'audit Box
• Référence du connecteur des Logs d'audit Box
• Dépanner le connecteur Box Audit Logs