Ingérer des données depuis Amplitude

info

bêta

Cette fonctionnalité est en version bêta. Les administrateurs de workspace peuvent contrôler l’accès à cette fonctionnalité depuis la page Previews en optant pour l’aperçu de Lakeflow Connect for Amplitude . Consultez Gérer les aperçus Databricks.

Cette page explique comment créer un pipeline d'ingestion Amplitude géré à l'aide de Lakeflow Connect.

Exigences

Pour créer un pipeline d'ingestion, remplissez d'abord les conditions suivantes :
- Votre workspace doit être activé pour Unity Catalog.
- Le compute serverless doit être activé pour votre workspace. Voir les exigences du compute serverless.
- Pour créer une nouvelle connexion, vous devez disposer des privilèges CREATE CONNECTION sur le métastore. Voir Gérer les privilèges dans Unity Catalog.
  
  Si le connecteur prend en charge la création de pipeline basée sur l'interface utilisateur, un administrateur peut créer la connexion et le pipeline en même temps en suivant les étapes sur cette page. Cependant, si les utilisateurs qui créent des pipelines utilisent la création de pipeline basée sur API ou ne sont pas des utilisateurs administrateurs, un administrateur doit d'abord créer la connexion dans Catalog Explorer. Voir Se connecter à des 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 disposer des privilèges USE SCHEMA et CREATE TABLE sur un schéma existant ou des privilèges CREATE SCHEMA sur le catalogue cible.
Pour ingérer des données depuis Amplitude, configurez d’abord l’authentification depuis Databricks et créez une connexion. Consultez Configurer l’authentification auprès d’Amplitude et Créer une connexion Amplitude.

Options du connecteur

Définissez les options au niveau de la table sur l’objet individuel dans le bloc connector_options. Voir les exemples pour l’utilisation.

Option	Périmètre	Obligatoire	S'applique à	Description
`start_datetime`	Table	Non	`events`	Timestamp de l'événement le plus ancien à ingérer lors de la première synchronisation, au format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Default sur `1970-01-01T00:00:00Z`.
`request_time_range`	Table	Non	`events`	Taille de chaque fenêtre d’exportation, sous forme de durée ISO-8601. Default to `PT24H`. Le minimum est `PT2H`.

Option	Périmètre	Obligatoire	S'applique à	Description
`start_datetime`	Table	Non	`events`	Timestamp de l'événement le plus ancien à ingérer lors de la première synchronisation, au format `yyyy-MM-dd'T'HH:mm:ss'Z'`. Default sur `1970-01-01T00:00:00Z`.
`request_time_range`	Table	Non	`events`	Taille de chaque fenêtre d’exportation, sous forme de durée ISO-8601. Default to `PT24H`. Le minimum est `PT2H`.

Créer un pipeline d'ingestion

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

Databricks UI
Declarative Automation Bundles
Databricks notebook

Dans la barre latérale du workspace Databricks, cliquez sur Data Ingestion .
Sur la page Add data , sous Connecteurs Databricks , cliquez sur Amplitude .
Sur la page Connexion de l’assistant d’ingestion, sélectionnez la connexion qui stocke vos identifiants Amplitude. 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 provenant de Configurer l’authentification auprès d’Amplitude.
Cliquez sur Suivant .
Sur la page Ingestion setup , saisissez un nom pour le pipeline.
Sélectionnez un catalogue et un schéma dans lesquels écrire les logs des événements. Si vous disposez 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.
Cliquez sur Créer un pipeline et continuer .
Sur la page Source , sélectionnez les tables à ingérer.
Cliquez sur Enregistrer et continuer .
Sur la page Destination , sélectionnez un catalogue et un schéma dans lesquels charger les données. Si vous disposez 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.
Cliquez sur Enregistrer et continuer .
(Facultatif) Sur la page Calendriers et notifications , cliquez sur Créer un calendrier . Définissez la fréquence de refresh des tables de destination.
(Facultatif) Cliquez sur Ajouter une notification pour définir des notifications par e-mail en cas de succès ou d'échec de l'opération de pipeline, puis cliquez sur Enregistrer et exécuter le pipeline .

Utilisez les Declarative Automation Bundles pour gérer les pipelines Amplitude 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 ?.

Créez un bundle à l'aide de la CLI Databricks :
Bash
```
databricks bundle init
```
Ajoutez deux nouveaux fichiers de ressources au bundle :
- Un fichier de définition de pipeline (par exemple, resources/amplitude_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/amplitude_job.yml).
Déployez le pipeline à l’aide de la CLI Databricks :
Bash
```
databricks bundle deploy
```

Exemples

Le connecteur Amplitude met à disposition quatre tables sources dans le schéma source default. Ingérez des tables individuelles ou le schéma entier.

remarque

Pendant que le connecteur Amplitude est en version bêta, pin le pipeline sur le canal de distribution PREVIEW, comme indiqué dans les exemples. Maintenez le champ channel défini sur PREVIEW jusqu'à ce que le connecteur soit disponible pour le plus grand nombre.

Ingérer des tables spécifiques

Utilisez cette option pour ingérer un sous-ensemble spécifique de tables ou pour personnaliser le nom de destination par table. La table events accepte l’option connector_options indiquée ci-dessous ; les autres tables ne déclarent aucune option par table.

Declarative Automation Bundles
Databricks notebook

Le fichier de définition de pipeline suivant ingère des tables Amplitude individuelles :

YAML
resources:
  pipelines:
    amplitude_pipeline:
      name: amplitude_pipeline
      catalog: 'main'
      target: 'amplitude_data'
      channel: PREVIEW
      ingestion_definition:
        connection_name: amplitude_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'events'
              destination_catalog: 'main'
              destination_schema: 'amplitude_data'
              destination_table: 'events'
              connector_options:
                api_source_connector_options:
                  options:
                    start_datetime: '<start-datetime>'
                    request_time_range: '<request-time-range>'
          - table:
              source_schema: 'default'
              source_table: 'events_list'
              destination_catalog: 'main'
              destination_schema: 'amplitude_data'
              destination_table: 'events_list'
          - table:
              source_schema: 'default'
              source_table: 'cohorts'
              destination_catalog: 'main'
              destination_schema: 'amplitude_data'
              destination_table: 'cohorts'
          - table:
              source_schema: 'default'
              source_table: 'annotations'
              destination_catalog: 'main'
              destination_schema: 'amplitude_data'
              destination_table: 'annotations'

La spécification de pipeline suivante ingère des tables Amplitude individuelles :

Python
pipeline_name = "amplitude_pipeline"
connection_name = "<amplitude-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "catalog": "main",
  "schema": "amplitude_data",
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "table": {
          "source_schema": "default",
          "source_table": "events",
          "destination_catalog": "main",
          "destination_schema": "amplitude_data",
          "destination_table": "events",
          "connector_options": {
            "api_source_connector_options": {
              "options": {
                "start_datetime": "<start-datetime>",
                "request_time_range": "<request-time-range>"
              }
            }
          }
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "events_list",
          "destination_catalog": "main",
          "destination_schema": "amplitude_data",
          "destination_table": "events_list"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "cohorts",
          "destination_catalog": "main",
          "destination_schema": "amplitude_data",
          "destination_table": "cohorts"
        }
      },
      {
        "table": {
          "source_schema": "default",
          "source_table": "annotations",
          "destination_catalog": "main",
          "destination_schema": "amplitude_data",
          "destination_table": "annotations"
        }
      }
    ]
  },
  "channel": "PREVIEW"
}
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 Amplitude dans un schéma de destination unique avec une seule déclaration.

Declarative Automation Bundles
Databricks notebook

Le fichier de définition de pipeline suivant ingère toutes les tables Amplitude prises en charge dans un schéma de destination :

YAML
resources:
  pipelines:
    amplitude_pipeline:
      name: amplitude_pipeline
      catalog: 'main'
      target: 'amplitude_data'
      channel: PREVIEW
      ingestion_definition:
        connection_name: amplitude_connection
        objects:
          - schema:
              source_schema: 'default'
              destination_catalog: 'main'
              destination_schema: 'amplitude_data'

La spécification de pipeline suivante ingère toutes les tables Amplitude prises en charge dans un schéma de destination :

Python
pipeline_name = "amplitude_pipeline"
connection_name = "<amplitude-connection>"
pipeline_spec = {
  "name": pipeline_name,
  "catalog": "main",
  "schema": "amplitude_data",
  "ingestion_definition": {
    "connection_name": connection_name,
    "objects": [
      {
        "schema": {
          "source_schema": "default",
          "destination_catalog": "main",
          "destination_schema": "amplitude_data"
        }
      }
    ]
  },
  "channel": "PREVIEW"
}
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 les Declarative Automation Bundles. Le job s'exécute quotidiennement.

Declarative Automation Bundles

YAML
resources:
  jobs:
    amplitude_job:
      name: amplitude_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: amplitude_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.amplitude_pipeline.id}

Modèles courants

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

Étapes suivantes

start, planifiez et configurez des alertes sur votre pipeline. Voir Tâches courantes de maintenance des pipelines.

Exigences​

Options du connecteur​

Créer un pipeline d'ingestion​

Exemples​

Ingérer des tables spécifiques​

Ingérer le schéma entier​

Fichier de définition de job Declarative Automation Bundles​

Modèles courants​

Étapes suivantes​

Ressources supplémentaires​