Memicu DAG Cloud Composer dengan Cloud Functions dan Airflow REST API

Cloud Composer 1 | Cloud Composer 2

Halaman ini menjelaskan cara menggunakan Cloud Functions untuk memicu DAG Cloud Composer sebagai respons terhadap peristiwa.

Apache Airflow dirancang untuk menjalankan DAG sesuai jadwal rutin, tetapi Anda juga dapat memicu DAG sebagai respons terhadap peristiwa. Salah satu cara untuk melakukannya adalah dengan menggunakan Cloud Functions untuk memicu DAG Cloud Composer saat peristiwa tertentu terjadi.

Contoh dalam panduan ini menjalankan DAG setiap kali terjadi perubahan di bucket Cloud Storage. Perubahan pada objek dalam bucket akan memicu fungsi. Fungsi ini membuat permintaan ke Airflow REST API di lingkungan Cloud Composer Anda. Airflow memproses permintaan ini dan menjalankan DAG. DAG menghasilkan informasi tentang perubahan tersebut.

Sebelum memulai

Memeriksa konfigurasi jaringan lingkungan Anda

Solusi ini tidak berfungsi dalam konfigurasi IP Pribadi dan Kontrol Layanan VPC karena konfigurasi ini tidak dapat dikonfigurasi dari Cloud Functions ke server web Airflow.

Di Cloud Composer 2, Anda dapat menggunakan pendekatan lain: Memicu DAG menggunakan Cloud Functions dan Pesan Pub/Sub

Mengaktifkan API untuk project Anda

Konsol

Enable the Cloud Composer and Cloud Functions APIs.

Enable the APIs

gcloud

Enable the Cloud Composer and Cloud Functions APIs: 

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

Mengaktifkan Airflow REST API

Untuk Airflow 2, REST API stabil sudah diaktifkan secara default. Jika lingkungan Anda menonaktifkan API stabil, aktifkan REST API stabil.

Izinkan panggilan API ke Airflow REST API menggunakan Kontrol Akses Webserver

Cloud Functions dapat menjangkau Airflow REST API menggunakan alamat IPv4 atau IPv6.

Jika Anda tidak yakin apa yang akan menjadi rentang IP panggilan, gunakan opsi konfigurasi default di Webserver Access Control All IP addresses have access (default) untuk tidak memblokir Cloud Functions Anda secara tidak sengaja.

Membuat bucket Cloud Storage

Contoh ini memicu DAG sebagai respons terhadap perubahan di bucket Cloud Storage. buat bucket baru untuk digunakan dalam contoh ini.

Mendapatkan URL server web Airflow

Contoh ini membuat permintaan REST API ke endpoint server web Airflow. Anda menggunakan URL server web Airflow di kode Cloud Function.

Konsol

  1. Di konsol Google Cloud, buka halaman Environments.

    Buka Lingkungan

  2. Klik nama lingkungan Anda.

  3. Di halaman Environment details, buka tab Environment configuration.

  4. URL server web Airflow tercantum dalam item UI web Airflow.

gcloud

Jalankan perintah berikut:

gcloud composer environments describe ENVIRONMENT_NAME \
    --location LOCATION \
    --format='value(config.airflowUri)'

Ganti:

  • ENVIRONMENT_NAME dengan nama lingkungan.
  • LOCATION dengan region tempat lingkungan berada.

Mengupload DAG ke lingkungan Anda

Upload DAG ke lingkungan Anda. Contoh DAG berikut menghasilkan output konfigurasi run DAG yang diterima. Anda memicu DAG ini dari fungsi yang akan Anda buat nanti dalam panduan ini.

import datetime

import airflow
from airflow.operators.bash_operator import BashOperator

with airflow.DAG(
    "composer_sample_trigger_response_dag",
    start_date=datetime.datetime(2021, 1, 1),
    # Not scheduled, trigger only
    schedule_interval=None,
) as dag:
    # Print the dag_run's configuration, which includes information about the
    # Cloud Storage object change.
    print_gcs_info = BashOperator(
        task_id="print_gcs_info", bash_command="echo {{ dag_run.conf }}"
    )

Men-deploy Cloud Function yang memicu DAG

Anda dapat men-deploy Cloud Function menggunakan bahasa pilihan Anda yang didukung oleh Cloud Functions atau Cloud Run. Tutorial ini menunjukkan Cloud Function yang diimplementasikan dalam Python dan Java.

Menentukan parameter konfigurasi Cloud Function

  • Pemicu. Untuk contoh ini, pilih pemicu yang berfungsi saat objek baru dibuat di dalam bucket, atau objek yang sudah ada akan ditimpa.

    • Jenis Pemicu. yang sesuai di Cloud Storage.

    • Jenis Peristiwa. Selesaikan / Buat.

    • Bucket. Pilih bucket yang harus memicu fungsi ini.

    • Coba lagi jika gagal. Sebaiknya nonaktifkan opsi ini untuk tujuan contoh ini. Jika Anda menggunakan fungsi Anda sendiri di lingkungan produksi, aktifkan opsi ini untuk menangani error sementara.

  • Akun layanan runtime, di bagian Setelan runtime, build, koneksi dan keamanan. Gunakan salah satu opsi berikut, bergantung pada preferensi Anda:

    • Pilih Akun layanan default Compute Engine. Dengan izin IAM default, akun ini dapat menjalankan fungsi yang mengakses lingkungan Cloud Composer.

    • Buat akun layanan kustom yang memiliki peran Composer User dan tentukan sebagai akun layanan runtime untuk fungsi ini. Opsi ini mengikuti prinsip hak istimewa minimum.

  • Runtime dan titik entri, pada langkah Code:

    • (Python) Saat menambahkan kode untuk contoh ini, pilih runtime Python 3.7 atau yang lebih baru dan tentukan trigger_dag_gcf sebagai titik entri.

    • (Java) Saat menambahkan kode untuk contoh ini, pilih runtime Java 17 dan tentukan com.example.Example sebagai titik entri.

Tambahkan persyaratan

Python

Tentukan dependensi dalam file requirements.txt:

google-auth==2.19.1
requests==2.31.0

Java

Tambahkan dependensi berikut ke bagian dependencies di pom.xml yang dihasilkan oleh UI Google Cloud Functions.

    <dependency>
      <groupId>com.google.apis</groupId>
      <artifactId>google-api-services-docs</artifactId>
      <version>v1-rev20210707-1.32.1</version>
    </dependency>
    <dependency>
      <groupId>com.google.api-client</groupId>
      <artifactId>google-api-client</artifactId>
      <version>1.32.1</version>
    </dependency>
    <dependency>
      <groupId>com.google.auth</groupId>
      <artifactId>google-auth-library-credentials</artifactId>
      <version>1.14.0</version>
    </dependency>
    <dependency>
      <groupId>com.google.auth</groupId>
      <artifactId>google-auth-library-oauth2-http</artifactId>
      <version>1.14.0</version>
    </dependency>

Python

Tambahkan kode untuk memicu DAG menggunakan Airflow REST API. Buat file bernama composer2_airflow_rest_api.py dan masukkan kode untuk membuat panggilan Airflow REST API ke dalam file ini.

Jangan ubah variabel apa pun. Cloud Function mengimpor file ini dari file main.py.

from __future__ import annotations

from typing import Any

import google.auth
from google.auth.transport.requests import AuthorizedSession
import requests

# Following GCP best practices, these credentials should be
# constructed at start-up time and used throughout
# https://cloud.google.com/apis/docs/client-libraries-best-practices
AUTH_SCOPE = "https://www.googleapis.com/auth/cloud-platform"
CREDENTIALS, _ = google.auth.default(scopes=[AUTH_SCOPE])

def make_composer2_web_server_request(
    url: str, method: str = "GET", **kwargs: Any
) -> google.auth.transport.Response:
    """
    Make a request to Cloud Composer 2 environment's web server.
    Args:
      url: The URL to fetch.
      method: The request method to use ('GET', 'OPTIONS', 'HEAD', 'POST', 'PUT',
        'PATCH', 'DELETE')
      **kwargs: Any of the parameters defined for the request function:
                https://github.com/requests/requests/blob/master/requests/api.py
                  If no timeout is provided, it is set to 90 by default.
    """

    authed_session = AuthorizedSession(CREDENTIALS)

    # Set the default timeout, if missing
    if "timeout" not in kwargs:
        kwargs["timeout"] = 90

    return authed_session.request(method, url, **kwargs)

def trigger_dag(web_server_url: str, dag_id: str, data: dict) -> str:
    """
    Make a request to trigger a dag using the stable Airflow 2 REST API.
    https://airflow.apache.org/docs/apache-airflow/stable/stable-rest-api-ref.html

    Args:
      web_server_url: The URL of the Airflow 2 web server.
      dag_id: The DAG ID.
      data: Additional configuration parameters for the DAG run (json).
    """

    endpoint = f"api/v1/dags/{dag_id}/dagRuns"
    request_url = f"{web_server_url}/{endpoint}"
    json_data = {"conf": data}

    response = make_composer2_web_server_request(
        request_url, method="POST", json=json_data
    )

    if response.status_code == 403:
        raise requests.HTTPError(
            "You do not have a permission to perform this operation. "
            "Check Airflow RBAC roles for your account."
            f"{response.headers} / {response.text}"
        )
    elif response.status_code != 200:
        response.raise_for_status()
    else:
        return response.text

Masukkan kode berikut ke file main.py. Ganti nilai variabel web_server_url dengan alamat server web Airflow yang Anda peroleh sebelumnya.

# Copyright 2021 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     https://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
Trigger a DAG in a Cloud Composer 2 environment in response to an event,
using Cloud Functions.
"""

from typing import Any

import composer2_airflow_rest_api

def trigger_dag_gcf(data, context=None):
    """
    Trigger a DAG and pass event data.

    Args:
      data: A dictionary containing the data for the event. Its format depends
      on the event.
      context: The context object for the event.

    For more information about the arguments, see:
    https://cloud.google.com/functions/docs/writing/background#function_parameters
    """

    # TODO(developer): replace with your values
    # Replace web_server_url with the Airflow web server address. To obtain this
    # URL, run the following command for your environment:
    # gcloud composer environments describe example-environment \
    #  --location=your-composer-region \
    #  --format="value(config.airflowUri)"
    web_server_url = (
        "https://example-airflow-ui-url-dot-us-central1.composer.googleusercontent.com"
    )
    # Replace with the ID of the DAG that you want to run.
    dag_id = 'composer_sample_trigger_response_dag'

    composer2_airflow_rest_api.trigger_dag(web_server_url, dag_id, data)

Java

Masukkan kode berikut ke file Example.java. Ganti nilai variabel webServerUrl dengan alamat server web Airflow yang Anda peroleh sebelumnya.


// Copyright 2022 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.example;

import com.example.Example.GcsEvent;
import com.google.api.client.http.GenericUrl;
import com.google.api.client.http.HttpContent;
import com.google.api.client.http.HttpRequest;
import com.google.api.client.http.HttpRequestFactory;
import com.google.api.client.http.HttpResponse;
import com.google.api.client.http.HttpResponseException;
import com.google.api.client.http.javanet.NetHttpTransport;
import com.google.api.client.http.json.JsonHttpContent;
import com.google.api.client.json.gson.GsonFactory;
import com.google.auth.http.HttpCredentialsAdapter;
import com.google.auth.oauth2.GoogleCredentials;
import com.google.cloud.functions.BackgroundFunction;
import com.google.cloud.functions.Context;
import java.util.HashMap;
import java.util.Map;
import java.util.logging.Logger;

/**
 * Cloud Function that triggers an Airflow DAG in response to an event (in
 * this case a Cloud Storage event).
 */
public class Example implements BackgroundFunction<GcsEvent> {
  private static final Logger logger = Logger.getLogger(Example.class.getName());

  // TODO(developer): replace with your values
  // Replace webServerUrl with the Airflow web server address. To obtain this
  // URL, run the following command for your environment:
  // gcloud composer environments describe example-environment \
  //  --location=your-composer-region \
  //  --format="value(config.airflowUri)"
  @Override
  public void accept(GcsEvent event, Context context) throws Exception {
    String webServerUrl = "https://example-airflow-ui-url-dot-us-central1.composer.googleusercontent.com";
    String dagName = "composer_sample_trigger_response_dag";
    String url = String.format("%s/api/v1/dags/%s/dagRuns", webServerUrl, dagName);

    logger.info(String.format("Triggering DAG %s as a result of an event on the object %s.",
      dagName, event.name));
    logger.info(String.format("Triggering DAG via the following URL: %s", url));

    GoogleCredentials googleCredentials = GoogleCredentials.getApplicationDefault()
        .createScoped("https://www.googleapis.com/auth/cloud-platform");
    HttpCredentialsAdapter credentialsAdapter = new HttpCredentialsAdapter(googleCredentials);
    HttpRequestFactory requestFactory =
      new NetHttpTransport().createRequestFactory(credentialsAdapter);

    Map<String, Map<String, String>> json = new HashMap<String, Map<String, String>>();
    Map<String, String> conf = new HashMap<String, String>();
    conf.put("bucket", event.bucket);
    conf.put("name", event.name);
    conf.put("generation", event.generation);
    conf.put("operation", context.eventType());
    json.put("conf", conf);
    HttpContent content = new JsonHttpContent(new GsonFactory(), json);
    HttpRequest request = requestFactory.buildPostRequest(new GenericUrl(url), content);
    request.getHeaders().setContentType("application/json");
    HttpResponse response;
    try {
      response = request.execute();
      int statusCode = response.getStatusCode();
      logger.info("Response code: " + statusCode);
      logger.info(response.parseAsString());
    } catch (HttpResponseException e) {
      // https://cloud.google.com/java/docs/reference/google-http-client/latest/com.google.api.client.http.HttpResponseException
      logger.info("Received HTTP exception");
      logger.info(e.getLocalizedMessage());
      logger.info("- 400 error: wrong arguments passed to Airflow API");
      logger.info("- 401 error: check if service account has Composer User role");
      logger.info("- 403 error: check Airflow RBAC roles assigned to service account");
      logger.info("- 404 error: check Web Server URL");
    } catch (Exception e) {
      logger.info("Received exception");
      logger.info(e.getLocalizedMessage());
    }
  }

  /** Details of the storage event. */
  public static class GcsEvent {
    /** Bucket name. */
    String bucket;
    /** Object name. */
    String name;
    /** Object version. */
    String generation;
  }
}

Menguji fungsi

Untuk memeriksa apakah fungsi dan DAG berfungsi sebagaimana mestinya:

  1. Tunggu hingga fungsi Anda di-deploy.
  2. Mengupload file ke bucket Cloud Storage Anda. Sebagai alternatif, Anda dapat memicu fungsi secara manual dengan memilih tindakan Test the function untuknya di Konsol Google Cloud.
  3. Periksa halaman DAG di antarmuka web Airflow. DAG harus memiliki satu pengoperasian DAG yang aktif atau sudah selesai.
  4. Di UI Airflow, periksa log tugas untuk operasi ini. Anda akan melihat bahwa tugas print_gcs_info menghasilkan output data yang diterima dari fungsi ke log:

Python 

[2021-04-04 18:25:44,778] {bash_operator.py:154} INFO - Output:
[2021-04-04 18:25:44,781] {bash_operator.py:158} INFO - Triggered from GCF:
    {bucket: example-storage-for-gcf-triggers, contentType: text/plain,
    crc32c: dldNmg==, etag: COW+26Sb5e8CEAE=, generation: 1617560727904101,
    ... }
[2021-04-04 18:25:44,781] {bash_operator.py:162} INFO - Command exited with
    return code 0h

Java 

[2023-02-08, 08:00:09 UTC] {subprocess.py:86} INFO - Output:
[2023-02-08, 08:00:09 UTC] {subprocess.py:93} INFO - {bucket: example-storage-for-gcf-triggers, generation: 1675843189006715, name: file.txt, operation: google.storage.object.create}
[2023-02-08, 08:00:09 UTC] {subprocess.py:97} INFO - Command exited with return code 0

Langkah selanjutnya