Diffuser les modifications dans Pub/Sub à l'aide du déclencheur de fonction Cloud Run facultatif


Ce tutoriel explique comment utiliser le modèle Flux de modifications Bigtable vers Pub/Sub, y compris comment configurer un sujet et le modèle. Vous pouvez également créer une fonction Cloud Run dans le langage de programmation de votre choix, qui est déclenchée par le flux d'événements.

Ce tutoriel s'adresse aux utilisateurs techniques qui connaissent Bigtable, la programmation et les services de streaming d'événements.

Objectifs

Ce tutoriel vous explique comment effectuer les tâches suivantes :

  • Créez une table Bigtable avec un flux de modifications activé.
  • Créez un sujet Pub/Sub avec le schéma de flux de modifications Bigtable.
  • Déployez un flux de modifications Bigtable vers un pipeline Pub/Sub sur Dataflow à l'aide du modèle.
  • Affichez le flux d'événements directement dans Pub/Sub ou dans les journaux d'une fonction Cloud Run.

Coûts

Dans ce document, vous utilisez les composants facturables de Google Cloudsuivants :

Obtenez une estimation des coûts en fonction de votre utilisation prévue à l'aide du simulateur de coût.

Les nouveaux utilisateurs de Google Cloud peuvent bénéficier d'un essai gratuit.

Une fois que vous avez terminé les tâches décrites dans ce document, supprimez les ressources que vous avez créées pour éviter que des frais vous soient facturés. Pour en savoir plus, consultez la section Effectuer un nettoyage.

Avant de commencer

    Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

    In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

    Verify that billing is enabled for your Google Cloud project.

    Enable the Dataflow, Cloud Bigtable API, Cloud Bigtable Admin API, Pub/Sub, Cloud Run functions, and Cloud Storage APIs.

    Enable the APIs

    In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

    Verify that billing is enabled for your Google Cloud project.

    Enable the Dataflow, Cloud Bigtable API, Cloud Bigtable Admin API, Pub/Sub, Cloud Run functions, and Cloud Storage APIs.

    Enable the APIs

    In the Google Cloud console, activate Cloud Shell.

    Activate Cloud Shell

    At the bottom of the Google Cloud console, a Cloud Shell session starts and displays a command-line prompt. Cloud Shell is a shell environment with the Google Cloud CLI already installed and with values already set for your current project. It can take a few seconds for the session to initialize.

  1. Mettez à jour et installez la CLI cbt.
    gcloud components update
    gcloud components install cbt
  2. Créer un sujet Pub/Sub

    1. Dans la console Google Cloud , accédez à la page Sujets de Pub/Sub.

      Accéder aux sujets

    2. Cliquez sur Create topic (Créer un sujet).

    3. Définissez bigtable-change-stream-topic comme ID.

    4. Sélectionnez Utiliser un schéma.

    5. Dans le menu déroulant Sélectionner un schéma Pub/Sub, cliquez sur Créer un schéma. Un nouvel onglet s'ouvre, dans lequel vous définissez le schéma.

      1. Définissez l'ID du schéma sur bigtable-change-stream-schema.
      2. Définissez le type de schéma sur Avro.
      3. Collez le code suivant en tant que définition du schéma. Pour en savoir plus sur le schéma, consultez la page de documentation sur les modèles.
        {
            "name" : "ChangelogEntryMessage",
            "type" : "record",
            "namespace" : "com.google.cloud.teleport.bigtable",
            "fields" : [
              { "name" : "rowKey", "type" : "bytes"},
              {
                "name" : "modType",
                "type" : {
                  "name": "ModType",
                  "type": "enum",
                  "symbols": ["SET_CELL", "DELETE_FAMILY", "DELETE_CELLS", "UNKNOWN"]}
              },
              { "name": "isGC", "type": "boolean" },
              { "name": "tieBreaker", "type": "int"},
              { "name": "columnFamily", "type": "string"},
              { "name": "commitTimestamp", "type" : "long"},
              { "name" : "sourceInstance", "type" : "string"},
              { "name" : "sourceCluster", "type" : "string"},
              { "name" : "sourceTable", "type" : "string"},
              { "name": "column", "type" : ["null", "bytes"]},
              { "name": "timestamp", "type" : ["null", "long"]},
              { "name": "timestampFrom", "type" : ["null", "long"]},
              { "name": "timestampTo", "type" : ["null", "long"]},
              { "name" : "value", "type" : ["null", "bytes"]}
          ]
        }
      
      1. Cliquez sur Créer pour créer le schéma.
    6. Fermez l'onglet Créer un schéma, actualisez la liste des schémas, puis sélectionnez le schéma que vous venez de définir.

    7. Cliquez sur Créer pour créer le sujet.

    Facultatif : Créer une fonction Cloud Run

    Vous pouvez traiter le flux Pub/Sub avec une fonction Cloud Run.

    1. Sur la page Détails du sujet bigtable-change-stream-topic, cliquez sur Déclencher une fonction Cloud .
    2. Dans le champ Nom de la fonction, saisissez le nom bt-ps-tutorial-function.
    3. Dans la section Code source, cliquez sur le menu déroulant Environnement d'exécution, puis sélectionnez l'environnement d'exécution et le langage de programmation de votre choix. Un hello world est généré et affiche le flux de modifications à mesure qu'il arrive. Pour en savoir plus sur l'écriture des fonctions Cloud Run, consultez la documentation.
    4. Utilisez les valeurs par défaut pour tous les autres champs.
    5. Cliquez sur Déployer la fonction.

    Créer une table avec un flux de modifications activé

    1. Dans la console Google Cloud , accédez à la page Instances de Bigtable.

      Accéder à la page "Instances"

    2. Cliquez sur l'ID de l'instance que vous utilisez pour ce tutoriel.

      Si vous ne disposez pas d'instance, créez-en une avec les configurations par défaut dans une région proche de vous.

    3. Dans le volet de navigation de gauche, cliquez sur Tables.

    4. Cliquez sur Créer une table.

    5. Nommez la table change-streams-pubsub-tutorial.

    6. Ajoutez une famille de colonnes nommée cf.

    7. Sélectionnez Activer le flux de modifications.

    8. Cliquez sur Créer.

    Initialiser un pipeline de données pour capturer le flux de modifications

    1. Sur la page Tables de Bigtable, recherchez votre table change-streams-pubsub-tutorial.
    2. Dans la colonne Flux de modifications, cliquez sur Connecter.
    3. Dans la boîte de dialogue, sélectionnez Pub/Sub.
    4. Cliquez sur Créer un job Dataflow.
    5. Sur la page Dataflow Créer un job, définissez le nom du sujet Pub/Sub de sortie sur bigtable-change-stream-topic.
    6. Définissez l'ID du profil d'application Bigtable sur default.
    7. Cliquez sur Run Job (Exécuter la tâche).
    8. Attendez que l'état du job soit Démarrage ou En cours d'exécution avant de continuer. Une fois le job mis en file d'attente, il faut environ cinq minutes pour qu'il soit exécuté.

    Écrire des données dans Bigtable

    1. Dans Cloud Shell, écrivez quelques lignes dans Bigtable afin que le journal des modifications puisse écrire des données dans le flux Pub/Sub. Tant que vous écrivez les données après la création du job, les modifications apparaissent. Vous n'avez pas besoin d'attendre que l'état du job devienne running.

      cbt -instance=BIGTABLE_INSTANCE_ID -project=YOUR_PROJECT_ID \
          set change-streams-pubsub-tutorial user123 cf:col1=abc
      cbt -instance=BIGTABLE_INSTANCE_ID -project=YOUR_PROJECT_ID \
          set change-streams-pubsub-tutorial user546 cf:col1=def
      cbt -instance=BIGTABLE_INSTANCE_ID -project=YOUR_PROJECT_ID \
          set change-streams-pubsub-tutorial user789 cf:col1=ghi
      

    Afficher les journaux des modifications dans Pub/Sub

    1. Dans la console Google Cloud , accédez à la page Abonnements de Pub/Sub.

      Accéder aux abonnements

    2. Cliquez sur l'abonnement créé automatiquement pour votre sujet bigtable-change-stream-topic. Il doit être nommé bigtable-change-stream-topic-sub.

    3. Accédez à l'onglet Messages.

    4. Cliquez sur Extraire.

    5. Explorez la liste des messages et affichez les données que vous avez écrites.

      Messages du journal des modifications dans Pub/Sub

    (Facultatif) Afficher les modifications dans les journaux Cloud Run Functions

    Si vous avez créé une fonction Cloud Run Functions, vous pouvez afficher les modifications dans les journaux.

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

      Accéder aux fonctions Cloud Run

    2. Cliquez sur votre fonction bt-ps-tutorial-function.

    3. Accédez à l'onglet Journaux.

    4. Assurez-vous que Severity (Gravité) est défini sur au moins Info (Info) pour pouvoir consulter les journaux.

    5. Explorez les journaux et affichez les données que vous avez écrites.

    La sortie ressemble à ceci :

    Pub/Sub message: {"rowKey":"user789","modType":"SET_CELL","isGC":false,"tieBreaker":0,"columnFamily":"cf","commitTimestamp":1695653833064548,"sourceInstance":"YOUR-INSTANCE","sourceCluster":"YOUR-INSTANCE-c1","sourceTable":"change-streams-pubsub-tutorial","column":{"bytes":"col1"},"timestamp":{"long":1695653832278000},"timestampFrom":null,"timestampTo":null,"value":{"bytes":"ghi"}}
    

    Effectuer un nettoyage

    Pour éviter que les ressources utilisées lors de ce tutoriel soient facturées sur votre compte Google Cloud, supprimez le projet contenant les ressources, ou conservez le projet et supprimez les ressources individuelles.

    Supprimer la table Bigtable

    1. Dans la console Google Cloud , accédez à la page Instances de Bigtable.

      Accéder à la page "Instances"

    2. Cliquez sur l'ID de l'instance que vous utilisez pour ce tutoriel.

    3. Dans le volet de navigation de gauche, cliquez sur Tables.

    4. Recherchez la table change-streams-pubsub-tutorial.

    5. Cliquez sur Modifier.

    6. Décochez la case Activer le flux de modifications.

    7. Cliquez sur Enregistrer.

    8. Ouvrez le menu à développer du tableau.

    9. Cliquez sur Supprimer, puis saisissez le nom de la table pour confirmer.

    Arrêter le pipeline de flux de modifications

    1. Dans la console Google Cloud , accédez à la page Tâches Dataflow.

      Accéder aux tâches

    2. Sélectionnez votre tâche de traitement par flux dans la liste des tâches.

    3. Dans la barre de navigation, cliquez sur Arrêter.

    4. Dans la boîte de dialogue Arrêter la tâche, annulez votre pipeline, puis cliquez sur Arrêter la tâche.

    Supprimez le sujet et l'abonnement Pub/Sub.

    1. Dans la console Google Cloud , accédez à la page Sujets de Pub/Sub.

      Accéder aux sujets

    2. Sélectionnez le sujet bigtable-change-stream-topic.

    3. Cliquez sur Supprimer, puis confirmez la suppression.

    4. Cliquez sur Abonnements dans la barre latérale.

    5. Sélectionnez l'abonnement bigtable-change-stream-topic-sub.

    6. Cliquez sur Supprimer, puis confirmez la suppression.

    Supprimer la fonction Cloud Run

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

      Accéder aux fonctions Cloud Run

    2. Sélectionnez la fonction bt-ps-tutorial-function.

    3. Cliquez sur Supprimer, puis confirmez la suppression.

    Étapes suivantes