Cloud Composer 1 | Cloud Composer 2 | Cloud Composer 3
In diesem Leitfaden erfahren Sie, wie Sie einen gerichteten azyklischen Graphen in Apache Airflow schreiben (DAG), der in einer Cloud Composer-Umgebung ausgeführt wird.
Da Apache Airflow keine strikte DAG- und Aufgabenisolierung bietet, empfehlen wir, separate Produktions- und Testumgebungen zu verwenden, um DAG-Interferenzen zu vermeiden. Weitere Informationen finden Sie unter DAGs testen.
Airflow-DAG strukturieren
Ein Airflow-DAG wird in einer Python-Datei definiert und besteht aus den folgenden Komponenten:
- DAG-Definition
- Airflow-Operatoren
- Beziehungen zu Betreibern
Die folgenden Code-Snippets zeigen Beispiele für die einzelnen Komponenten außerhalb des Kontexts.
Eine DAG-Definition
Im folgenden Beispiel wird ein Airflow-DAG veranschaulicht: Definition:
Airflow 2
Airflow 1
Operatoren und Aufgaben
Airflow-Operatoren beschreiben die auszuführende Arbeit. Eine Aufgabe ist eine bestimmte Instanz eines Operators.
Airflow 2
Airflow 1
Aufgabenbeziehungen
Aufgabenbeziehungen beschreiben die Reihenfolge, in der die Arbeit ausgeführt werden muss.
Airflow 2
Airflow 1
Vollständiger DAG-Workflow in Python
Der folgende Workflow ist eine vollständige DAG-Vorlage, die aus zwei Aufgaben besteht: einer hello_python
- und einer goodbye_bash
-Aufgabe:
Airflow 2
Airflow 1
Weitere Informationen zum Definieren von Airflow-DAGs finden Sie in der Airflow-Anleitung und in den Airflow-Konzepten.
Airflow-Operatoren
Die folgenden Beispiele enthalten einige beliebte Airflow-Operatoren. Eine verbindliche Referenz zu den Airflow-Operatoren finden Sie in der Referenz zu Operatoren und Hooks und im Index der Anbieter.
BashOperator
Mit dem BashOperator können Sie Befehlszeilenprogramme ausführen.
Airflow 2
Airflow 1
Cloud Composer führt die bereitgestellten Befehle in einem Bash-Script auf einem Airflow-Worker aus. Der Worker ist ein Docker-Container auf Basis von Debian und enthält mehrere Pakete.
gcloud
-Befehl, einschließlich desgcloud storage
-Unterbefehls für die Arbeit mit Cloud Storage-Bucketsbq
-Befehlszeilentoolkubectl
-Befehlszeilentool
PythonOperator
Verwenden Sie die Methode PythonOperator verwendet, um beliebigen Python-Code auszuführen.
Cloud Composer führt den Python-Code in einem Container aus, der Folgendes enthält: Pakete für die Cloud Composer-Image-Version, die in für Ihre Umgebung.
Informationen zum Installieren weiterer Python-Pakete finden Sie unter Python-Abhängigkeiten installieren.
Google Cloud-Operatoren
Verwenden Sie zum Ausführen von Aufgaben, die Google Cloud-Produkte verwenden, den Google Cloud Airflow-Operatoren. Beispielsweise fragen und verarbeiten BigQuery-Operatoren Daten in BigQuery.
Es gibt viele weitere Airflow-Operatoren für Google Cloud und einzelne von Google Cloud bereitgestellte Dienste. Weitere Informationen finden Sie unter Eine vollständige Liste der Google Cloud-Operatoren finden Sie hier.
Airflow 2
Airflow 1
EmailOperator
Verwenden Sie den EmailOperator, um E-Mails von einem DAG zu senden. Senden E-Mails aus einer Cloud Composer-Umgebung zu senden, Konfigurieren Sie Ihre Umgebung für die Verwendung von SendGrid.
Airflow 2
Airflow 1
Benachrichtigungen bei Fehlern des Mobilfunkanbieters
Zum Senden einer E-Mail-Benachrichtigung, wenn ein Operator im DAG fehlerhaft ist, legen Sie für email_on_failure
den Wert True
fest. Zum Senden von E-Mails aus einer Cloud Composer-Umgebung müssen Sie Ihre Umgebung für die Verwendung von SendGrid konfigurieren.
Airflow 2
Airflow 1
Richtlinien für DAG-Workflows
Platzieren Sie benutzerdefinierte Python-Bibliotheken im ZIP-Archiv eines DAG in einem verschachtelten Verzeichnis. Platzieren Sie Bibliotheken nicht auf der obersten Ebene des DAG-Verzeichnisses.
Airflow prüft den Ordner
dags/
nur auf DAGs in Python-Modulen, die sich auf der obersten Ebene des Ordners „DAGs“ und auf der obersten Ebene eines ZIP-Archivs befinden, das ebenfalls im Ordnerdags/
auf oberster Ebene enthalten ist. Wenn Airflow in einem ZIP-Archiv ein Python-Modul ermittelt, das wederairflow
- nochDAG
-Teilstrings enthält, beendet Airflow die Verarbeitung des ZIP-Archivs. Airflow gibt nur die DAGs zurück, die bis zu diesem Zeitpunkt gefunden wurden.Verwenden Sie Airflow 2 anstelle von Airflow 1.
Die Airflow-Community veröffentlicht keine neuen Neben- oder Patchversionen für Airflow 1.
Achten Sie aus Gründen der Fehlertoleranz darauf, nicht mehrere DAG-Objekte im gleichen Python-Modul zu definieren.
Verwenden Sie SubDAGs nicht. Stattdessen Aufgaben in DAGs gruppieren.
Platzieren Sie Dateien, die zum Zeitpunkt des DAG-Parsens erforderlich sind, im Ordner
dags/
und nicht im Ordnerdata/
.Testen Sie entwickelte oder geänderte DAGs wie in der Anleitung zum Testen von DAGs empfohlen.
Achten Sie darauf, dass sich entwickelte DAGs nicht erhöhen DAG-Analysezeiten zu oft.
Airflow-Aufgaben können aus verschiedenen Gründen fehlschlagen. Um Ausfälle der ganze DAG-Ausführungen ausführen möchten, sollten Sie Wiederholungsversuche für Aufgaben aktivieren. Wenn Sie die maximale Anzahl von Wiederholungsversuchen auf
0
festlegen, werden keine Wiederholungen ausgeführt.Wir empfehlen, die Option
default_task_retries
mit einem anderen Wert für die Wiederholungen von Aufgaben als0
zu überschreiben. Darüber hinaus können Sie die Parameterretries
auf Aufgabenebene.Wenn Sie GPUs in Ihren Airflow-Aufgaben verwenden möchten, erstellen Sie einen separaten GKE-Cluster, der auf Knoten mit Maschinen mit GPUs basiert. Verwenden Sie GKEStartPodOperator, um Ihre Aufgaben auszuführen.
Führen Sie keine CPU- und speicherintensiven Aufgaben im Knotenpool des Clusters aus, in dem andere Airflow-Komponenten (Planer, Worker, Webserver) ausgeführt werden. Verwenden Sie stattdessen KubernetesPodOperator oder GKEStartPodOperator.
Wenn Sie DAGs in einer Umgebung bereitstellen, laden Sie nur die Dateien in den Ordner
/dags
hoch, die für die Interpretation und Ausführung von DAGs unbedingt erforderlich sind.Begrenzen Sie die Anzahl der DAG-Dateien im Ordner
/dags
.Airflow parset kontinuierlich DAGs im Ordner
/dags
. Beim Parsen wird der DAGs-Ordner durchlaufen. Die Anzahl der Dateien, die geladen werden müssen (mit ihren Abhängigkeiten), wirkt sich auf die Leistung des DAG-Parsings und der Aufgabenplanung aus. Es ist viel effizienter, 100 Dateien mit jeweils 100 DAGs zu verwenden als 10.000 Dateien mit jeweils 1 DAG. Daher wird eine solche Optimierung empfohlen. Bei dieser Optimierung wird ein Gleichgewicht zwischen Parsingzeit und Effizienz der DAG-Erstellung und -Verwaltung hergestellt.Sie können auch 10.000 DAG-Dateien bereitstellen, 100 ZIP-Dateien mit jeweils 100 DAG-Dateien erstellen
Zusätzlich zu den oben genannten Hinweisen kann es bei mehr als 10.000 DAG-Dateien sinnvoll sein, DAGs programmatisch zu generieren. Beispiel: können Sie eine einzelne Python-DAG-Datei implementieren, DAG-Objekte (z. B. 20 oder 100 DAG-Objekte)
Eingestellte Airflow-Operatoren nicht mehr verwenden
Die in der folgenden Tabelle aufgeführten Operatoren wurden eingestellt. Einige dieser Operatoren wurden in frühen Versionen von Cloud Composer 1 unterstützt. Verwenden Sie sie nicht in Ihren DAGs. Verwenden Sie stattdessen die bereitgestellten aktuellen Alternativen.
Eingestellter Operator | Zu verwendender Operator |
---|---|
BigQueryExecuteQueryOperator | BigQueryInsertJobOperator |
BigQueryPatchDatasetOperator | BigQueryUpdateTableOperator |
DataflowCreateJavaJobOperator | BeamRunJavaPipelineOperator |
DataflowCreatePythonJobOperator | BeamRunPythonPipelineOperator |
DataprocScaleClusterOperator | DataprocUpdateClusterOperator |
DataprocSubmitPigJobOperator | DataprocSubmitJobOperator |
DataprocSubmitSparkSqlJobOperator | DataprocSubmitJobOperator |
DataprocSubmitSparkJobOperator | DataprocSubmitJobOperator |
DataprocSubmitHadoopJobOperator | DataprocSubmitJobOperator |
DataprocSubmitPySparkJobOperator | DataprocSubmitJobOperator |
MLEngineManageModelOperator | MLEngineCreateModelOperator, MLEngineGetModelOperator |
MLEngineManageVersionOperator | MLEngineCreateVersion, MLEngineSetDefaultVersion, MLEngineListVersions, MLEngineDeleteVersion |
GCSObjectsWtihPrefixExistenceSensor | GCSObjectsWithPrefixExistenceSensor |
FAQs zum Schreiben von DAGs
Wie minimiere ich Codewiederholungen, wenn ich die gleichen oder ähnliche Aufgaben in mehreren DAGs ausführen möchte?
Wir empfehlen, Bibliotheken und Wrapper für Codewiederholungen zu minimieren.
Wie kann ich Code in mehreren DAG-Dateien wiederverwenden?
Binden Sie Hilfsfunktionen in eine lokale Python-Bibliothek ein und importieren Sie die Funktionen. Sie können in allen DAGs, die sich im dags/
-Ordner Ihres Buckets befinden, auf die Funktionen verweisen.
Wie minimiere ich das Risiko unterschiedlicher Definitionen?
Angenommen, es gibt zwei Teams, die Rohdaten zu Umsatzkennzahlen zusammenfassen möchten. Die Teams schreiben zwei geringfügig unterschiedliche Aufgaben für den gleichen Sachverhalt. Definieren Sie Bibliotheken für die Arbeit mit den Umsatzdaten, sodass diejenigen, die DAGs implementieren, die Definition des zusammengefassten Umsatzes eindeutig festlegen müssen.
Wie lege ich Abhängigkeiten zwischen DAGs fest?
Das hängt davon ab, wie Sie die Abhängigkeit definieren möchten.
Wenn Sie zwei DAGs haben (DAG A und DAG B) und DAG B nach dem DAG ausgelöst werden soll
A: Sie können eine
TriggerDagRunOperator
am Ende von DAG A.
Wenn DAG B nur von einem von DAG A generierten Artefakt abhängt (z. B. eine Pub/Sub-Meldung), ist ein Sensor möglicherweise besser geeignet.
Wenn DAG B eng mit DAG A integriert ist, können Sie die beiden DAGs möglicherweise in einen DAG zusammenführen.
Wie übergebe ich eindeutige Ausführungs-IDs an einen DAG und die zugehörigen Aufgaben?
Angenommen, es sollen Dataproc-Clusternamen und -Dateipfade übergeben werden.
In diesem Fall können Sie eine zufällige eindeutige ID generieren und dafür str(uuid.uuid4())
in einem PythonOperator
zurückgeben. Dadurch wird die ID
XComs
, damit Sie in anderen Operatoren auf die ID verweisen können
mithilfe von Vorlagenfeldern.
Prüfen Sie vor dem Generieren einer uuid
, ob eine DagRun-spezifische ID sinnvoller wäre. Sie können auf diese IDs in Jinja-Substitutionen auch mit Makros verweisen.
Wie trenne ich Aufgaben in einem DAG?
Eine Aufgabe sollte eine idempotente Arbeitseinheit sein. Vermeiden Sie es deshalb, einen aus mehreren Schritten bestehenden Workflow in eine einzelne Aufgabe aufzunehmen, z. B. in ein komplexes Programm, das in einem PythonOperator
ausgeführt wird.
Soll ich mehrere Aufgaben in einem einzelnen DAG definieren, um Daten aus mehreren Quellen zusammenzufassen?
Angenommen, ich habe mehrere Tabellen mit Rohdaten und möchte tägliche Zusammenfassungen für jede einzelne Tabelle erstellen. Die Aufgaben sind nicht voneinander abhängig. Soll ich eine Aufgabe und einen DAG für jede Tabelle oder einen allgemeinen DAG erstellen?
Wenn es für Sie kein Problem ist, dass jede Aufgabe die gleichen Attribute auf DAG-Ebene verwendet (z. B. schedule_interval
), ist es sinnvoll, mehrere Aufgaben in einem einzigen DAG zu definieren. Andernfalls können zur Minimierung der Codewiederholung mehrere DAGs aus einem einzigen Python-Modul generiert werden. Dazu platzieren Sie diese in den globalen globals()
des Moduls.
Wie beschränke ich die Anzahl gleichzeitiger Aufgaben, die in einem DAG ausgeführt werden?
Ich möchte z. B. vermeiden, dass API-Nutzungslimits und -kontingente überschritten oder zu viele Prozesse gleichzeitig ausgeführt werden.
Sie können Airflow-Pools in der Airflow-Web-UI und verknüpfte Aufgaben mit vorhandenen Pools in Ihren DAGs.
FAQs zur Verwendung von Operatoren
Soll ich den DockerOperator
verwenden?
Wir raten von der Verwendung des DockerOperator
ab, es sei denn, er wird zum Starten von Containern in einer Remote-Docker-Installation verwendet (nicht im Cluster einer Umgebung). In einer Cloud Composer-Umgebung hat der Operator keinen Zugriff auf Docker-Daemons.
Verwenden Sie stattdessen KubernetesPodOperator
oder GKEStartPodOperator
. Diese Operatoren starten Kubernetes-Pods in Kubernetes- bzw. GKE-Clustern. Es ist nicht empfehlenswert, Pods im Cluster einer Umgebung zu starten, da dies zu Konkurrenz um Ressourcen führen kann.
Soll ich den SubDagOperator
verwenden?
Die Verwendung von SubDagOperator
wird nicht empfohlen.
Verwenden Sie die Alternativen, die unter Aufgaben gruppieren vorgeschlagen werden.
Soll ich Python-Code nur in PythonOperators
ausführen, um Python-Operatoren vollständig zu trennen?
Abhängig von Ihrem Ziel haben Sie mehrere Optionen.
Falls Ihr einziges Ziel ist, separate Python-Abhängigkeiten beizubehalten, können Sie PythonVirtualenvOperator
verwenden.
Erwägen Sie die Verwendung der KubernetesPodOperator
. Mit diesem Operator können Sie Kubernetes-Pods definieren und die Pods in anderen Clustern ausführen.
Wie füge ich benutzerdefinierte binäre oder Nicht-PyPI-Pakete hinzu?
Sie können dazu Pakete installieren, die in privaten Paket-Repositories gehostet werden,
Wie übergebe ich Argumente einheitlich an einen DAG und die zugehörigen Aufgaben?
Sie können die integrierte Airflow-Unterstützung für Jinja-Vorlagen nutzen, um Argumente zu übergeben, die in Vorlagenfeldern verwendet werden können.
Wann findet die Vorlagenersetzung statt?
Die Vorlagen werden auf den Airflow-Workern unmittelbar vor dem Aufruf der pre_execute
-Funktion eines Operators ersetzt. In der Praxis bedeutet das, dass Vorlagen
erst kurz vor der Ausführung einer Aufgabe ersetzt.
Wie kann ich erkennen, welche Operatorargumente die Vorlagenersetzung unterstützen?
Operatorargumente, die die Jinja2-Vorlagenersetzung unterstützen, sind explizit entsprechend gekennzeichnet.
Suchen Sie in der Operatordefinition nach dem Feld template_fields
. Es enthält eine Liste der Argumentnamen, für die die Vorlagenersetzung verwendet wird.
Dazu gehört beispielsweise der BashOperator
, mit dem Vorlagen für die Argumente bash_command
und env
unterstützt werden.
Nächste Schritte
- Fehlerbehebung bei DAGs
- Fehlerbehebung beim Scheduler
- Google-Betreiber
- Google Cloud-Operatoren
- Apache Airflow-Anleitung