Attiva i DAG utilizzando Cloud Functions e i messaggi Pub/Sub

Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3

Questa pagina illustra la creazione di un'architettura push basata sugli eventi mediante l'attivazione dei DAG di Cloud Composer in risposta alle modifiche all'argomento Pub/Sub. Gli esempi in questo tutorial mostrano la gestione dell'intero ciclo della gestione di Pub/Sub, inclusa la gestione degli abbonamenti, come parte del processo DAG. È adatto per alcuni dei casi d'uso comuni in cui devi attivare i DAG, ma non vuoi configurare autorizzazioni di accesso aggiuntive.

Ad esempio, i messaggi inviati tramite Pub/Sub possono essere utilizzati come soluzione se non si vuole fornire accesso diretto a un ambiente Cloud Composer per motivi di sicurezza. Puoi configurare una Cloud Function che crea messaggi Pub/Sub e li pubblica in un argomento Pub/Sub. Puoi quindi creare un DAG che estrae i messaggi Pub/Sub e li gestisce.

In questo esempio specifico, crei una Cloud Function ed esegui il deployment di due DAG. Il primo DAG esegue il pull dei messaggi Pub/Sub e attiva il secondo DAG in base al contenuto del messaggio Pub/Sub.

Questo tutorial presuppone che tu abbia familiarità con Python e con la console Google Cloud.

Obiettivi

Costi

Questo tutorial utilizza i seguenti componenti fatturabili di Google Cloud:

Dopo aver completato questo tutorial, puoi evitare la fatturazione continua eliminando le risorse che hai creato. Per ulteriori dettagli, consulta Pulizia.

Prima di iniziare

Per questo tutorial è necessario un progetto Google Cloud. Configura il progetto nel seguente modo:

  1. Nella console Google Cloud, seleziona o crea un progetto:

    Vai al selettore di progetti

  2. Verifica che la fatturazione sia attivata per il tuo progetto. Scopri come verificare se la fatturazione è abilitata per un progetto.

  3. Assicurati che l'utente del progetto Google Cloud disponga dei seguenti ruoli per creare le risorse necessarie:

    • Utente account di servizio (roles/iam.serviceAccountUser)
    • Editor Pub/Sub (roles/pubsub.editor)
    • Amministratore oggetti di ambiente e archiviazione (roles/composer.environmentAndStorageObjectAdmin)
    • Amministratore Cloud Functions (roles/cloudfunctions.admin)
    • Visualizzatore log (roles/logging.viewer)

  4. Assicurati che l'account di servizio che esegue la funzione Cloud Functions disponga di autorizzazioni sufficienti nel progetto per accedere a Pub/Sub. Per impostazione predefinita, Cloud Functions utilizza l'account di servizio predefinito di App Engine. Questo account di servizio ha il ruolo Editor, che dispone di autorizzazioni sufficienti per questo tutorial.

Abilita le API per il progetto

Console

Abilita le API Cloud Composer, Cloud Functions, and Pub/Sub.

Abilita le API

gcloud

Abilita le API Cloud Composer, Cloud Functions, and Pub/Sub. 

gcloud services enable composer.googleapis.com cloudfunctions.googleapis.com pubsub.googleapis.com

Terraform

Abilita l'API Cloud Composer nel progetto aggiungendo le seguenti definizioni delle risorse allo script Terraform:

resource "google_project_service" "composer_api" {
  project = "<PROJECT_ID>"
  service = "composer.googleapis.com"
  // Disabling Cloud Composer API might irreversibly break all other
  // environments in your project.
  // This parameter prevents automatic disabling
  // of the API when the resource is destroyed.
  // We recommend to disable the API only after all environments are deleted.
  disable_on_destroy = false
}

resource "google_project_service" "pubsub_api" {
  project = "<PROJECT_ID>"
  service = "pubsub.googleapis.com"
  disable_on_destroy = false
}

resource "google_project_service" "functions_api" {
  project = "<PROJECT_ID>"
  service = "cloudfunctions.googleapis.com"
  disable_on_destroy = false
}

Sostituisci <PROJECT_ID> con l'ID progetto del tuo progetto. Ad esempio: example-project.

crea il tuo ambiente Cloud Composer

Crea un ambiente Cloud Composer 2.

Nell'ambito di questa procedura, concedi il ruolo dell'estensione dell'agente di servizio API Cloud Composer v2 (roles/composer.ServiceAgentV2Ext) all'account dell'agente di servizio Composer. Cloud Composer usa l'account per eseguire operazioni nel progetto Google Cloud.

crea un argomento Pub/Sub

Questo esempio attiva un DAG in risposta a un messaggio inviato tramite push a un argomento Pub/Sub. Crea un argomento Pub/Sub da utilizzare in questo esempio:

Console

  1. Nella console Google Cloud, vai alla pagina Argomenti Pub/Sub.

    Vai agli argomenti Pub/Sub

  2. Fai clic su Crea argomento.

  3. Nel campo ID argomento, inserisci dag-topic-trigger come ID per l'argomento.

  4. Non modificare le altre impostazioni predefinite.

  5. Fai clic su Crea argomento.

gcloud

Per creare un argomento, esegui il comando gcloud pubsub topics create in Google Cloud CLI:

gcloud pubsub topics create dag-topic-trigger

Terraform

Aggiungi le seguenti definizioni di risorse allo script Terraform:

resource "google_pubsub_topic" "trigger" {
  project                    = "<PROJECT_ID>"
  name                       = "dag-topic-trigger"
  message_retention_duration = "86600s"
}

Sostituisci <PROJECT_ID> con l'ID progetto del tuo progetto. Ad esempio: example-project.

Carica i DAG

Carica i DAG nel tuo ambiente:

  1. Salva il seguente file DAG sul tuo computer locale.
  2. Sostituisci <PROJECT_ID> con l'ID progetto del tuo progetto. Ad esempio: example-project.
  3. Carica il file DAG modificato nel tuo ambiente.
from __future__ import annotations

from datetime import datetime
import time

from airflow import DAG
from airflow import XComArg
from airflow.operators.python import PythonOperator
from airflow.operators.trigger_dagrun import TriggerDagRunOperator
from airflow.providers.google.cloud.operators.pubsub import (
    PubSubCreateSubscriptionOperator,
    PubSubPullOperator,
)

PROJECT_ID = "<PROJECT_ID>"
TOPIC_ID = "dag-topic-trigger"
SUBSCRIPTION = "trigger_dag_subscription"


def handle_messages(pulled_messages, context):
    dag_ids = list()
    for idx, m in enumerate(pulled_messages):
        data = m.message.data.decode("utf-8")
        print(f"message {idx} data is {data}")
        dag_ids.append(data)
    return dag_ids


# This DAG will run minutely and handle pub/sub messages by triggering target DAG
with DAG(
    "trigger_dag",
    start_date=datetime(2021, 1, 1),
    schedule_interval="* * * * *",
    max_active_runs=1,
    catchup=False,
) as trigger_dag:
    # If subscription exists, we will use it. If not - create new one
    subscribe_task = PubSubCreateSubscriptionOperator(
        task_id="subscribe_task",
        project_id=PROJECT_ID,
        topic=TOPIC_ID,
        subscription=SUBSCRIPTION,
    )

    subscription = subscribe_task.output

    # Proceed maximum 50 messages in callback function handle_messages
    # Here we acknowledge messages automatically. You can use PubSubHook.acknowledge to acknowledge in downstream tasks
    # https://airflow.apache.org/docs/apache-airflow-providers-google/stable/_api/airflow/providers/google/cloud/hooks/pubsub/index.html#airflow.providers.google.cloud.hooks.pubsub.PubSubHook.acknowledge
    pull_messages_operator = PubSubPullOperator(
        task_id="pull_messages_operator",
        project_id=PROJECT_ID,
        ack_messages=True,
        messages_callback=handle_messages,
        subscription=subscription,
        max_messages=50,
    )

    # Here we use Dynamic Task Mapping to trigger DAGs according to messages content
    # https://airflow.apache.org/docs/apache-airflow/2.3.0/concepts/dynamic-task-mapping.html
    trigger_target_dag = TriggerDagRunOperator.partial(task_id="trigger_target").expand(
        trigger_dag_id=XComArg(pull_messages_operator)
    )

    (subscribe_task >> pull_messages_operator >> trigger_target_dag)


def _some_heavy_task():
    print("Do some operation...")
    time.sleep(1)
    print("Done!")


# Simple target DAG
with DAG(
    "target_dag",
    start_date=datetime(2022, 1, 1),
    # Not scheduled, trigger only
    schedule_interval=None,
    catchup=False,
) as target_dag:
    some_heavy_task = PythonOperator(
        task_id="some_heavy_task", python_callable=_some_heavy_task
    )

    (some_heavy_task)

Il codice campione contiene due DAG: trigger_dag e target_dag.

Il DAG trigger_dag sottoscrive un argomento Pub/Sub, esegue il pull dei messaggi Pub/Sub e attiva un altro DAG specificato nell'ID DAG dei dati dei messaggi Pub/Sub. In questo esempio, trigger_dag attiva il DAG target_dag, che invia i messaggi ai log delle attività.

Il DAG trigger_dag contiene le seguenti attività:

  • subscribe_task: iscriviti a un argomento Pub/Sub.
  • pull_messages_operator: leggi i dati di un messaggio Pub/Sub con PubSubPullOperator.
  • trigger_target_dag: attiva un altro DAG (in questo esempio, target_dag) in base ai dati nei messaggi estratti dall'argomento Pub/Sub.

Il DAG target_dag contiene una sola attività: output_to_logs. Questa attività stampa i messaggi nel log delle attività con un secondo di ritardo.

Esegui il deployment di una Cloud Function che pubblica messaggi in un argomento Pub/Sub

In questa sezione eseguirai il deployment di una Cloud Function che pubblica messaggi in un argomento Pub/Sub.

crea una Cloud Function e specificane la configurazione

Console

  1. Nella console Google Cloud, vai alla pagina Cloud Functions.

    Vai a Cloud Functions

  2. Fai clic su Crea funzione.

  3. Nel campo Ambiente, seleziona 1a generazione.

  4. Nel campo Nome funzione, inserisci il nome della funzione: pubsub-publisher.

  5. Nel campo Tipo di trigger, seleziona HTTP.

  6. Nella sezione Autenticazione, seleziona Consenti chiamate non autenticate. Questa opzione concede agli utenti non autenticati la possibilità di richiamare una funzione HTTP.

  7. Fai clic su Salva.

  8. Fai clic su Avanti per andare al passaggio Codice.

Terraform

Valuta la possibilità di utilizzare la console Google Cloud per questo passaggio, perché non esiste un modo semplice per gestire il codice sorgente della funzione da Terraform.

Questo esempio mostra come caricare una funzione Cloud Function da un file di archivio ZIP locale creando un bucket Cloud Storage, memorizzando il file in questo bucket e utilizzando il file del bucket come origine per la funzione Cloud Function. Se utilizzi questo approccio, Terraform non aggiorna automaticamente il codice sorgente della funzione, anche se crei un nuovo file di archivio. Per ricaricare il codice della funzione, puoi modificare il nome del file dell'archivio.

  1. Scarica i file pubsub_publisher.py e requirements.txt.
  2. Nel file pubsub_publisher.py, sostituisci <PROJECT_ID> con l'ID progetto del tuo progetto. Ad esempio, example-project.
  3. Crea un archivio ZIP denominato pubsub_function.zip con il file pbusub_publisner.py e requirements.txt.
  4. Salva l'archivio ZIP in una directory in cui è archiviato lo script Terraform.
  5. Aggiungi le seguenti definizioni di risorsa allo script Terraform e sostituisci <PROJECT_ID> con l'ID progetto del progetto.
resource "google_storage_bucket" "cloud_function_bucket" {
  project        = <PROJECT_ID>
  name           = "<PROJECT_ID>-cloud-function-source-code"
  location       = "US"
  force_destroy  = true
  uniform_bucket_level_access = true
}

resource "google_storage_bucket_object" "cloud_function_source" {
  name   = "pubsub_function.zip"
  bucket = google_storage_bucket.cloud_function_bucket.name
  source = "./pubsub_function.zip"
}

resource "google_cloudfunctions_function" "pubsub_function" {
  project = <PROJECT_ID>
  name    = "pubsub-publisher"
  runtime = "python310"
  region  = "us-central1"

  available_memory_mb   = 128
  source_archive_bucket = google_storage_bucket.cloud_function_bucket.name
  source_archive_object = "pubsub_function.zip"
  timeout               = 60
  entry_point           = "pubsub_publisher"
  trigger_http          = true
}

Specifica i parametri del codice della funzione Cloud Functions

Console

  1. Nel passaggio Codice, nel campo Runtime, seleziona il runtime della lingua utilizzato dalla funzione. In questo esempio, seleziona Python 3.10.

  2. Nel campo Punto di ingresso, inserisci pubsub_publisher. Questo è il codice che viene eseguito quando viene eseguita la Cloud Function. Il valore di questo flag deve essere il nome di una funzione o un nome completo di classe esistente nel codice sorgente.

Terraform

Ignora questo passaggio. I parametri della Cloud Function sono già definiti nella risorsa google_cloudfunctions_function.

Carica il codice della Cloud Function

Console

Nel campo Codice sorgente, seleziona l'opzione appropriata per la modalità di fornitura del codice sorgente della funzione. In questo tutorial, aggiungi il codice della funzione utilizzando l'editor incorporato di Cloud Functions. In alternativa, puoi caricare un file ZIP o utilizzare Cloud Source Repositories.

  1. Inserisci il seguente esempio di codice nel file main.py.
  2. Sostituisci <PROJECT_ID> con l'ID progetto del tuo progetto. Ad esempio: example-project.
from google.cloud import pubsub_v1

project = "<PROJECT_ID>"
topic = "dag-topic-trigger"


def pubsub_publisher(request):
    """Publish message from HTTP request to Pub/Sub topic.
    Args:
        request (flask.Request): HTTP request object.
    Returns:
        The response text with message published into Pub/Sub topic
        Response object using
        `make_response <http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>`.
    """
    request_json = request.get_json()
    print(request_json)
    if request.args and "message" in request.args:
        data_str = request.args.get("message")
    elif request_json and "message" in request_json:
        data_str = request_json["message"]
    else:
        return "Message content not found! Use 'message' key to specify"

    publisher = pubsub_v1.PublisherClient()
    # The `topic_path` method creates a fully qualified identifier
    # in the form `projects/{project_id}/topics/{topic_id}`
    topic_path = publisher.topic_path(project, topic)

    # The required data format is a bytestring
    data = data_str.encode("utf-8")
    # When you publish a message, the client returns a future.
    message_length = len(data_str)
    future = publisher.publish(topic_path, data, message_length=str(message_length))
    print(future.result())

    return f"Message {data} with message_length {message_length} published to {topic_path}."

Terraform

Ignora questo passaggio. I parametri della Cloud Function sono già definiti nella risorsa google_cloudfunctions_function.

Specifica le dipendenze della Cloud Function

Console

Specifica le dipendenze della funzione nel file di metadati requirements.txt:

requests-toolbelt==1.0.0
google-auth==2.19.1
google-cloud-pubsub==2.17.0

Quando esegui il deployment della funzione, Cloud Functions scarica e installa le dipendenze dichiarate nel file requirements.txt, una riga per pacchetto. Questo file deve trovarsi nella stessa directory del file main.py che contiene il codice della funzione. Per ulteriori dettagli, consulta File dei requisiti nella documentazione pip.

Terraform

Ignora questo passaggio. Le dipendenze della Cloud Function sono definite nel file requirements.txt nell'archivio pubsub_function.zip.

Esegui il deployment della Cloud Function

Console

Fai clic su Esegui il deployment. Al termine del deployment, la funzione viene visualizzata con un segno di spunta verde nella pagina Cloud Functions della console Google Cloud.

Assicurati che l'account di servizio che esegue la Cloud Function disponga di autorizzazioni sufficienti nel progetto per accedere a Pub/Sub.

Terraform

  1. Inizializza Terraform:

    terraform init

  2. Rivedi la configurazione e verifica che le risorse che Terraform creerà o aggiornerà soddisfino le tue aspettative:

    terraform plan

  3. Per verificare se la configurazione è valida, esegui questo comando:

    terraform validate

  4. Applica la configurazione Terraform eseguendo questo comando e inserendo sì al prompt:

    terraform apply

Attendi finché in Terraform non viene visualizzato il messaggio "Applicazione completata!".

Nella console Google Cloud, vai alle risorse nella UI per assicurarti che Terraform le abbia create o aggiornate.

Testa la Cloud Function

Per verificare che la funzione pubblichi un messaggio in un argomento Pub/Sub e che i DAG di esempio funzionino come previsto:

  1. Controlla che i DAG siano attivi:

    1. Nella console Google Cloud, vai alla pagina Ambienti.

      Vai ad Ambienti

    2. Nell'elenco degli ambienti, fai clic sul nome dell'ambiente. Si apre la pagina Dettagli ambiente.

    3. Vai alla scheda DAG.

    4. Controlla i valori nella colonna Stato per i DAG denominati trigger_dag e target_dag. Entrambi i DAG devono essere nello stato Active.

  2. Esegui il push di un messaggio Pub/Sub di prova. Puoi farlo in Cloud Shell:

    1. Nella console Google Cloud, vai alla pagina Funzioni.

      Vai a Cloud Functions

    2. Fai clic sul nome della funzione, pubsub-publisher.

    3. Vai alla scheda Test.

    4. Nella sezione Configura evento di attivazione, inserisci la seguente coppia chiave-valore JSON: {"message": "target_dag"}. Non modificare la coppia chiave-valore, perché questo messaggio attiva il DAG di test in un secondo momento.

    5. Nella sezione Comando di test, fai clic su Testa in Cloud Shell.

    6. Nel terminale Cloud Shell, attendi che venga visualizzato automaticamente un comando. Esegui questo comando premendo Enter.

    7. Se viene visualizzato il messaggio Autorizza Cloud Shell, fai clic su Autorizza.

    8. Verifica che il contenuto del messaggio corrisponda al messaggio Pub/Sub. In questo esempio, il messaggio di output deve iniziare con Message b'target_dag' with message_length 10 published to come risposta della tua funzione.

  3. Verifica che target_dag sia stato attivato:

    1. Attendi almeno un minuto, in modo che venga completata una nuova esecuzione di DAG trigger_dag.

    2. Nella console Google Cloud, vai alla pagina Ambienti.

      Vai ad Ambienti

    3. Nell'elenco degli ambienti, fai clic sul nome dell'ambiente. Si apre la pagina Dettagli ambiente.

    4. Vai alla scheda DAG.

    5. Fai clic su trigger_dag per passare alla pagina Dettagli DAG. Nella scheda Esecuzioni viene visualizzato un elenco di esecuzioni di DAG per il DAG trigger_dag.

      Questo DAG viene eseguito ogni minuto ed elabora tutti i messaggi Pub/Sub inviati dalla funzione. Se non è stato inviato nessun messaggio, l'attività trigger_target viene contrassegnata come Skipped nei log di esecuzione dei DAG. Se sono stati attivati i DAG, l'attività trigger_target viene contrassegnata come Success.

    6. Esamina diverse esecuzioni recenti di DAG per individuare un'esecuzione di DAG in cui tutte e tre le attività (subscribe_task, pull_messages_operator e trigger_target) sono in stato Success.

    7. Torna alla scheda DAG e controlla che la colonna Esecuzioni riuscite per il DAG target_dag elenca un'esecuzione riuscita.

Riepilogo

In questo tutorial hai imparato come utilizzare Cloud Functions per pubblicare messaggi in un argomento Pub/Sub ed eseguire il deployment di un DAG che sottoscrive un argomento Pub/Sub, esegue il pull di messaggi Pub/Sub e attiva un altro DAG specificato nell'ID DAG dei dati dei messaggi.

Esistono anche modi alternativi per creare e gestire le sottoscrizioni Pub/Sub e attivare i DAG che non rientrano nell'ambito di questo tutorial. Ad esempio, puoi utilizzare Cloud Functions per attivare i DAG Airflow quando si verifica un evento specificato. Dai un'occhiata ai nostri tutorial per provare in prima persona le altre funzionalità di Google Cloud.

Esegui la pulizia

Per evitare che al tuo account Google Cloud vengano addebitati costi relativi alle risorse utilizzate in questo tutorial, elimina il progetto che contiene le risorse oppure mantieni il progetto ed elimina le singole risorse.

Elimina il progetto

    Elimina un progetto Google Cloud:

    gcloud projects delete PROJECT_ID

Elimina singole risorse

Se prevedi di esplorare più tutorial e guide rapide, riutilizzare i progetti può aiutarti a evitare di superare i limiti di quota.

Console

  1. Eliminare l'ambiente Cloud Composer. Puoi anche eliminare il bucket dell'ambiente durante questa procedura.
  2. Elimina l'argomento Pub/Sub, dag-topic-trigger.

  3. Elimina la Cloud Function.

    1. Nella console Google Cloud, vai a Cloud Functions.

      Vai a Cloud Functions

    2. Fai clic sulla casella di controllo della funzione da eliminare, pubsub-publisher.

    3. Fai clic su Elimina e segui le istruzioni.

Terraform

  1. Assicurati che lo script Terraform non contenga voci per le risorse ancora richieste dal progetto. Ad esempio, potresti voler mantenere alcune API abilitate e le autorizzazioni IAM ancora assegnate (se hai aggiunto queste definizioni allo script Terraform).
  2. Esegui terraform destroy.
  3. Eliminare manualmente il bucket dell'ambiente. Cloud Composer non lo elimina automaticamente. Puoi farlo dalla console Google Cloud o da Google Cloud CLI.

Passaggi successivi