Gérer les pipelines

Ce document explique comment gérer les pipelines BigQuery, y compris comment les afficher, les planifier, les déployer et les supprimer.

Ce document explique également comment afficher et gérer les métadonnées de pipeline dans Knowledge Catalog.

Les pipelines sont alimentés par Dataform. Vous pouvez organiser et gérer les pipelines stockés dans Fichiers et dossiers (dossiers utilisateur et dossiers d'équipe) ou dans les dépôts Git BigQuery Studio (dossiers Git) (preview).

Avant de commencer

  1. Créez un pipeline BigQuery.
  2. Pour gérer les métadonnées de pipeline dans Knowledge Catalog, assurez-vous que l'API Dataplex est activée dans votre Google Cloud projet.

Rôles requis

Pour obtenir les autorisations nécessaires pour gérer les pipelines, demandez à votre administrateur de vous accorder les rôles IAM suivants :

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Vous pouvez également obtenir les autorisations requises via des rôles personnalisés ou d'autres rôles prédéfinis.

Pour en savoir plus sur IAM pour Dataform, consultez la section Contrôler l'accès avec IAM. Pour en savoir plus sur les rôles pour les dossiers, consultez Créer et gérer des dossiers. Pour en savoir plus sur les rôles pour les dépôts Git, consultez Gérer le code avec les dépôts Git BigQuery Studio.

Si vous utilisez un compte de service personnalisé pour exécuter des pipelines, vous devez accorder les rôles suivants à ce compte de service :

Afficher les pipelines

Vous pouvez afficher et inspecter les pipelines stockés dans des dossiers ou des dossiers Git dans le volet Fichiers. Vous pouvez afficher les pipelines autonomes et les pipelines stockés dans des dossiers dans le volet Explorateur. Les pipelines stockés dans des dossiers Git ne s'affichent pas dans le volet Explorateur.

Afficher les pipelines dans le volet "Fichiers"

Les pipelines stockés dans des dossiers ou des dossiers Git apparaissent directement dans le volet Fichiers.

Pour afficher un pipeline stocké dans un dossier ou un dossier Git, procédez comme suit :

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

    Accéder à BigQuery

  2. Dans le volet de gauche, cliquez sur Fichiers pour ouvrir l'explorateur de fichiers.

    Si le volet de gauche ne s'affiche pas, cliquez sur Développer le volet de gauche pour l'ouvrir.

  3. Développez votre dossier Utilisateur , un dossier d'équipe ou un dossier de dépôt Git connecté.

    Les pipelines s'affichent avec une icône Pipeline au lieu d'une icône de dossier standard.

  4. Cliquez sur un dossier de pipeline pour ouvrir le lecteur de pipeline.

    Le lecteur de pipeline affiche le graphe orienté acyclique (DAG) compilé de vos tâches de pipeline, l'état d'exécution et les onglets de configuration.

  5. Développez le répertoire de pipeline dans l'explorateur de fichiers pour parcourir les répertoires imbriqués (tels que definitions/) et les fichiers de tâches individuels.

Afficher les pipelines dans le volet "Explorateur"

Pour afficher la liste des pipelines autonomes et des pipelines stockés dans des dossiers, procédez comme suit :

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

    Accéder à BigQuery

  2. Dans le volet de gauche, cliquez sur Explorateur:

    Bouton du volet Explorateur mis en évidence.

    Si le volet de gauche ne s'affiche pas, cliquez sur Développer le volet de gauche pour l'ouvrir.

  3. Dans le volet Explorateur, développez votre projet et cliquez sur Pipelines.

  4. Sélectionnez un pipeline pour l'ouvrir dans le lecteur de pipeline.

Afficher les exécutions manuelles passées

Pour afficher les exécutions manuelles passées d'un pipeline sélectionné, procédez comme suit :

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

    Accéder à BigQuery

  2. Dans le volet de gauche, cliquez sur Explorateur:

    Bouton du volet Explorateur mis en évidence.

  3. Dans le volet Explorateur, développez votre projet, cliquez sur Pipelines, puis sélectionnez un pipeline.

  4. Cliquez sur Exécutions.

  5. Facultatif : Pour actualiser la liste des exécutions passées, cliquez sur Actualiser.

Configurer des alertes pour les exécutions de pipeline ayant échoué

Chaque pipeline possède un ID de dépôt Dataform correspondant. Chaque exécution de pipeline BigQuery est enregistrée dans Cloud Logging à l'aide de l'ID de dépôt Dataform correspondant. Vous pouvez utiliser Cloud Monitoring pour observer les tendances dans les journaux Cloud Logging pour les exécutions de pipeline BigQuery et vous avertir lorsque les conditions que vous décrivez apparaissent.

Pour recevoir des alertes lorsqu'une exécution de pipeline BigQuery échoue, vous pouvez créer une règle d'alerte basée sur les journaux pour l'ID de dépôt Dataform correspondant. Pour obtenir des instructions, consultez Configurer des alertes pour les appels de workflow ayant échoué.

Pour trouver l'ID de dépôt Dataform de votre pipeline, procédez comme suit :

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

    Accéder à BigQuery

  2. Dans le volet de gauche, cliquez sur Explorateur:

    Bouton du volet Explorateur mis en évidence.

  3. Dans le volet Explorateur, développez votre projet, cliquez sur Pipelines, puis sélectionnez un pipeline.

  4. Cliquez sur Paramètres.

    L'ID de dépôt Dataform de votre pipeline s'affiche en bas de l'onglet Paramètres.

Supprimer un pipeline

Pour supprimer définitivement un pipeline, procédez comme suit :

  1. Dans la Google Cloud console, accédez à la BigQuery BigQuery. Accéder à BigQuery

  • Pour supprimer un pipeline stocké dans un dossier ou un dossier Git, procédez comme suit :

    1. Dans le volet de gauche, cliquez sur Fichiers.

    2. Dans l'arborescence des fichiers, recherchez le dossier de pipeline que vous souhaitez supprimer.

    3. Cliquez sur Afficher les actions à côté du dossier de pipeline, puis sur Supprimer.

    4. Dans la boîte de dialogue de confirmation, cliquez sur Supprimer.

      Le dossier de pipeline, ainsi que toutes les tâches et tous les fichiers qu'il contient, sont supprimés de votre espace de travail.

  • Pour supprimer un pipeline listé dans le volet Explorateur, procédez comme suit :

    1. Dans le volet de gauche, cliquez sur Explorateur:

      Bouton du volet Explorateur mis en évidence.

    2. Dans le volet Explorateur, développez votre projet et cliquez sur Pipelines.

    3. Recherchez le pipeline que vous souhaitez supprimer.

    4. Cliquez sur Afficher les actions à côté du pipeline, puis sur Supprimer.

    5. Cliquez sur Supprimer.

Gérer les métadonnées dans Knowledge Catalog

Knowledge Catalog vous permet de stocker et de gérer les métadonnées des pipelines. Les pipelines sont disponibles dans Knowledge Catalog par défaut, sans configuration supplémentaire.

Vous pouvez utiliser Knowledge Catalog pour gérer les pipelines dans tous les emplacements de pipeline. La gestion des pipelines dans Knowledge Catalog est soumise aux quotas et limites de Knowledge Catalog et aux tarifs de Knowledge Catalog.

Knowledge Catalog récupère automatiquement les métadonnées suivantes à partir des pipelines :

  • Nom de l'élément de données
  • Élément de données parent
  • Emplacement de l'élément de données
  • Type d'élément de données
  • Projet correspondant Google Cloud

Knowledge Catalog enregistre les pipelines en tant qu' entrées avec les valeurs d'entrée suivantes :

Groupe d'entrées système
Le groupe d'entrées système pour les pipelines est @dataform. Pour afficher les détails des entrées de pipeline dans Knowledge Catalog, vous devez afficher le groupe d'entrées système dataform. Pour savoir comment afficher la liste de toutes les entrées d'un groupe d'entrées, consultez Afficher les détails d'un groupe d'entrées dans la documentation Knowledge Catalog.
Type d'entrée système
Le type d'entrée système pour les pipelines est dataform-code-asset. Pour afficher les détails de pipelines,vous devez afficher le type d'entrée système dataform-code-asset, filtrer les résultats avec un filtre basé sur les aspects, et définir le champ type dans l'aspect dataform-code-asset sur WORKFLOW. Sélectionnez ensuite une entrée du pipeline sélectionné. Pour savoir comment afficher les détails d'un type d'entrée sélectionné, consultez Afficher les détails d'un type d'entrée dans la documentation Knowledge Catalog. Pour savoir comment afficher les détails d'une entrée sélectionnée, consultez Afficher les détails d'une entrée dans la documentation Knowledge Catalog.
Type d'aspect système
Le type d'aspect système pour les pipelines est dataform-code-asset. Pour fournir un contexte supplémentaire aux pipelines dans Knowledge Catalog en annotant les entrées de pipeline de données avec des aspects, affichez le dataform-code-asset type d'aspect, filtrez les résultats avec un filtre basé sur les aspects, et définissez le champ type dans l'aspect dataform-code-asset sur WORKFLOW. Pour savoir comment annoter des entrées avec des aspects, consultez Gérer les aspects et enrichir les métadonnées dans la documentation Knowledge Catalog.
Type
Le type des canevas de données est WORKFLOW. Ce type vous permet de filtrer les pipelines dans le dataform-code-asset type d'entrée système et le dataform-code-asset type d'aspect à l'aide de la aspect:dataplex-types.global.dataform-code-asset.type=WORKFLOW requête dans un filtre basé sur les aspects.

Pour savoir comment rechercher des éléments dans Knowledge Catalog, consultez Rechercher des éléments de données dans Knowledge Catalog dans la documentation Knowledge Catalog.

Enrichissement des métadonnées et intégration de la fiche d'évaluation sur la qualité des données

Dataform peut publier les métadonnées suivantes dans Knowledge Catalog :

  • Type d'aspect "Aperçu"
  • Type d'aspect générique
  • Type d'aspect "Fiche d'évaluation sur la qualité des données"

Les assertions Dataform sont automatiquement intégrées à la fiche d'évaluation sur la qualité des données de Knowledge Catalog. Lors de l'exécution du pipeline, les résultats de toutes les assertions Dataform sont automatiquement publiés dans Knowledge Catalog. Ces résultats remplissent la fiche d'évaluation sur la qualité des données de Knowledge Catalog avec un état de réussite ou d'échec.

Pour vérifier l'état d'une mise à jour des métadonnées, suivez les instructions de la section Afficher les exécutions manuelles passées.

Une fois les métadonnées synchronisées, vous pouvez rechercher et afficher l'entrée dans Knowledge Catalog. Pour en savoir plus, consultez Rechercher des ressources.

Étape suivante