Activer l'intégration de la traçabilité des données

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

À propos de l'intégration de la traçabilité des données

La traçabilité des données est une fonctionnalité Dataplex qui vous permet de suivre la manière dont les données transitent par vos systèmes : leur origine, la cible de transmission, et les transformations qui leur sont appliquées. La traçabilité des données est disponible pour :

Une fois la fonctionnalité activée dans votre environnement Cloud Composer, l'exécution de DAG qui utilisent l'un des opérateurs compatibles entraîne l'envoi d'informations sur la lignée à l'API Data Lineage.

Vous pouvez ensuite accéder à ces informations à l'aide des éléments suivants :

Opérateurs compatibles

Les opérateurs suivants sont compatibles avec les rapports de lignée automatiques dans Cloud Composer :

  • airflow.providers.google.cloud.operators.bigquery.BigQueryExecuteQueryOperator
  • airflow.providers.google.cloud.operators.bigquery.BigQueryInsertJobOperator
  • airflow.providers.google.cloud.transfers.bigquery_to_bigquery.BigQueryToBigQueryOperator
  • airflow.contrib.operators.bigquery_to_gcs.BigQueryToCloudStorageOperator
  • airflow.providers.google.cloud.transfers.bigquery_to_gcs.BigQueryToGCSOperator
  • airflow.providers.google.cloud.transfers.gcs_to_bigquery.GCSToBigQueryOperator
  • airflow.contrib.operators.gcs_to_bq.GoogleCloudStorageToBigQueryOperator
  • airflow.providers.google.cloud.operators.dataproc.DataprocSubmitJobOperator

Par exemple, vous pouvez exécuter la tâche suivante:

task = BigQueryInsertJobOperator(
    task_id='snapshot_task',
    dag=dag,
    location='<dataset-location>',
    configuration={
        'query': {
            'query': 'SELECT * FROM dataset.tableA',
            'useLegacySql': False,
            'destinationTable': {
                'project_id': GCP_PROJECT,
                'dataset_id': 'dataset',
                'table_id': 'tableB',
            },
        }
    },
)

Cela se traduit par la création du graphique de traçabilité suivant dans l'UI Dataplex:

Exemple de graphique de traçabilité dans l&#39;UI Dataplex.
Figure 1. Exemple de graphique de traçabilité pour une table BigQuery dans l'interface utilisateur de Dataplex.

Remarques concernant les fonctionnalités de Cloud Composer

Chaque exécution de tâche Airflow qui génère un rapport sur la lignée des données effectue les opérations suivantes :

  • Créer ou mettre à jour une requête RPC pour un processus de traçabilité
  • Créer ou mettre à jour une requête RPC pour une exécution de traçabilité
  • Une ou plusieurs requêtes RPC pour créer des événements de traçabilité (la plupart du temps 0 ou 1)

Pour en savoir plus sur ces entités, consultez modèle d'information de traçabilité et Documentation de référence de l'API de traçabilité dans Dataplex dans la documentation Google Cloud.

Le trafic de la traçabilité émis est soumis à des quotas dans l'API Data Lineage. Cloud Composer utilise le quota d'écriture.

Les tarifs associés à la gestion des données de filiation sont soumis à la tarification de la filiation. Consultez les considérations relatives à la traçabilité des données.

Implications en termes de performance

La traçabilité des données est signalée à la fin de l'exécution de la tâche Airflow. En moyenne, la création de rapports sur la lignée des données prend environ une à deux secondes.

Cela n'affecte pas les performances de la tâche elle-même: les tâches Airflow n'affectent pas échouer si la traçabilité n'est pas correctement signalée à l'API Lineage. La logique de l'opérateur principal n'est pas affectée, mais l'exécution de l'instance de tâche entière prend un peu plus de temps pour tenir compte des données de lignée de rapports.

Un environnement qui génère des rapports sur la lignée des données entraînera une augmentation mineure des coûts associés, en raison du temps supplémentaire nécessaire pour générer ces rapports.

Conformité

La traçabilité des données offre différents niveaux de compatibilité VPC Service Controls. Consultez les considérations sur la lignée des données pour vous assurer que les niveaux d'assistance correspondent aux exigences de votre environnement.

Utiliser l'intégration de la traçabilité des données

L'intégration de la traçabilité des données pour Cloud Composer est gérée par environnement. Par conséquent, l'activation de cette fonctionnalité se fait en deux étapes:

  1. Activez l'API Data Lineage dans votre projet.
  2. Activez l'intégration de la traçabilité des données dans un environnement Cloud Composer spécifique.

Avant de commencer

Lorsque vous créez un environnement, l'intégration de la lignée de données est automatiquement activée si les conditions suivantes sont remplies :

  • L'API Data Lineage est activée dans votre projet. Pour en savoir plus, consultez la section Activer l'API Data Lineage dans la documentation Dataplex.

  • Une configuration Backend de traçabilité n'est pas configurée dans Airflow.

Pour un environnement existant, vous pouvez activer ou désactiver l'intégration de la traçabilité des données à tout moment.

Rôles requis

Pour intégrer la traçabilité des données, vous devez ajouter les autorisations suivantes au compte de service de votre environnement Cloud Composer :

  • Pour les comptes de service par défaut: aucune modification n'est nécessaire. Comptes de service par défaut incluent les autorisations requises.
  • Pour les comptes de service gérés par l'utilisateur : attribuez le rôle Worker Composer (roles/composer.worker) à votre compte de service. Ce rôle inclut toutes les autorisations de traçabilité des données requises.

Pour en savoir plus, consultez Rôles et autorisations de traçabilité dans la documentation Dataplex.

Activer la traçabilité des données dans Cloud Composer

Console

  1. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

  3. Sélectionnez l'onglet Configuration de l'environnement.

  4. Dans la section Intégration de la traçabilité des données Dataplex, cliquez sur Modifier.

  5. Dans le panneau Intégration de la traçabilité des données Dataplex, sélectionnez Activer l'intégration avec la traçabilité des données Dataplex, puis cliquez sur Enregistrer.

gcloud

Utilisez l'argument --enable-cloud-data-lineage-integration.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --enable-cloud-data-lineage-integration

Remplacez :

  • ENVIRONMENT_NAME par le nom de l'environnement.

    Le nom doit commencer par une lettre minuscule suivie d'un maximum de 62 caractères (lettres minuscules, chiffres ou traits d'union) et ne peut pas se terminer par un trait d'union. Le nom de l'environnement est utilisé pour créer des sous-composants pour l'environnement. Vous devez donc indiquer un nom également valide pour les buckets Cloud Storage. Pour obtenir une liste des restrictions, consultez la page Consignes de dénomination des buckets.

  • LOCATION par la région de l'environnement.

    L'emplacement correspond à la région dans laquelle se trouve le cluster GKE de l'environnement.

Exemple :

gcloud composer environments update example-environment \
    --location us-central1 \
    --enable-cloud-data-lineage-integration

Envoyer des événements de traçabilité personnalisés

Vous pouvez envoyer des événements de traçabilité personnalisés si vous souhaitez signaler la traçabilité pour un opérateur qui n'est pas compatible avec les rapports de traçabilité automatiques.

Par exemple, pour envoyer des événements personnalisés avec :

  • BashOperator : modifiez le paramètre inlets ou outlets dans la tâche. définition.
  • PythonOperator, modifiez le paramètre task.inlets ou task.outlets. dans la définition de la tâche. L'utilisation de AUTO pour le paramètre inlets définit sa égale à la valeur outlets de sa tâche en amont.

Par exemple, l'exécution de cette tâche:


from airflow.composer.data_lineage.entities import BigQueryTable
from airflow.lineage import AUTO

…

bash_task = BashOperator(
   task_id='bash_task',
   dag=dag,
   bash_command='sleep 0',
   inlets=[BigQueryTable(
       project_id=GCP_PROJECT,
       dataset_id='dataset',
       table_id='table1',
   )],
   outlets=[BigQueryTable(
       project_id=GCP_PROJECT,
       dataset_id='dataset',
       table_id='table2',
   )]
)


def _python_task(task):
   task.inlets.append(BigQueryTable(
       project_id=GCP_PROJECT,
       dataset_id='dataset',
       table_id='table3',
   ))

   task.outlets.append(BigQueryTable(
       project_id=GCP_PROJECT,
       dataset_id='dataset',
       table_id='table4',
   ))


python_task = PythonOperator(
   task_id='python_task',
   dag=dag,
   python_callable=_python_task,
   inlets=[AUTO],
)

bash_task >> python_task

Cela se traduit par la création du graphique de traçabilité suivant dans l'UI Dataplex:

Exemple de graphique de traçabilité pour des événements personnalisés dans l&#39;UI Dataplex
Figure 2. Exemple de graphique de traçabilité pour plusieurs tables BigQuery dans l'interface utilisateur de Dataplex.

Désactiver la traçabilité des données dans Cloud Composer

Désactiver l'intégration de la traçabilité dans un environnement Cloud Composer désactiver l'API Data Lineage. Si vous souhaitez désactiver complètement la traçabilité de votre projet, désactivez également l'API Data Lineage. Voir Désactiver des services

Console

  1. Dans la console Google Cloud, accédez à la page Environnements.

    Accéder à la page Environnements

  2. Dans la liste des environnements, cliquez sur le nom de votre environnement. La page Détails de l'environnement s'ouvre.

  3. Sélectionnez l'onglet Configuration de l'environnement.

  4. Dans la section Intégration de la traçabilité des données Dataplex, cliquez sur Modifier.

  5. Dans le panneau Intégration de la traçabilité des données Dataplex, sélectionnez Désactiver l'intégration avec la traçabilité des données Dataplex, puis cliquez sur Enregistrer.

gcloud

Utilisez l'argument --disable-cloud-data-lineage-integration.

gcloud composer environments update ENVIRONMENT_NAME \
    --location LOCATION \
    --disable-cloud-data-lineage-integration

Remplacez :

  • ENVIRONMENT_NAME par le nom de l'environnement.

    Le nom doit commencer par une lettre minuscule suivie d'un maximum de 62 caractères (lettres minuscules, chiffres ou traits d'union) et ne peut pas se terminer par un trait d'union. Le nom de l'environnement est utilisé pour créer des sous-composants pour l'environnement. Vous devez donc indiquer un nom également valide pour les buckets Cloud Storage. Pour obtenir une liste des restrictions, consultez la page Consignes de dénomination des buckets.

  • LOCATION par la région de l'environnement.

    L'emplacement correspond à la région dans laquelle se trouve le cluster GKE de l'environnement.

Exemple :

gcloud composer environments update example-environment \
    --location us-central1 \
    --disable-cloud-data-lineage-integration

Afficher les journaux de lignée dans Cloud Composer

Vous pouvez inspecter les journaux liés à la lignée des données à l'aide du lien sur la page Configuration de l'environnement, dans la section Intégration de la lignée des données Dataplex.

Dépannage

Si les données de traçabilité ne sont pas signalées à l'API Lineage ou si vous ne les voyez pas dans Dataplex, suivez ces étapes de dépannage:

  • Assurez-vous que l'API Data Lineage est activée dans le projet de votre environnement Cloud Composer.
  • Vérifiez si l'intégration de la lignée de données est activée dans l'environnement Cloud Composer.
  • Vérifiez si l'opérateur que vous utilisez est inclus dans la compatibilité avec les rapports de lignée automatiques. Consultez la page Opérateurs Airflow compatibles.
  • Consultez les journaux de traçabilité dans Cloud Composer pour identifier les problèmes éventuels.