Cloud Composer 1 Cloud Composer 2
In diesem Leitfaden erfahren Sie, wie Sie einen gerichteten azyklischen Graphen (Directed Acyclic Graph, DAG) von Apache Airflow für die Ausführung in einer Cloud Composer-Umgebung schreiben.
Da Apache Airflow keine strikte DAG- und Aufgabenisolierung bietet, empfehlen wir die Verwendung separater Produktions- und Testumgebungen, 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
- Operatorenbeziehungen
Die folgenden Code-Snippets zeigen Beispiele für die einzelnen Komponenten ohne Kontext.
Eine DAG-Definition
Im folgenden Beispiel wird eine DAG-Definition veranschaulicht:
Airflow 2
Airflow 1
Operatoren und Aufgaben
Operatoren beschreiben die auszuführende Arbeit. Eine Aufgabe ist eine spezifische Instanz eines Operators.
Airflow 2
Airflow 1
Aufgabenbeziehungen
Aufgabenbeziehungen beschreiben die Reihenfolge, in der die Arbeit erledigt werden muss.
Airflow 2
Airflow 1
Beispiel für einen vollständigen DAG-Workflow in Python
Der folgende Workflow ist eine vollständige DAG-Vorlage, die aus zwei Aufgaben besteht: einer Aufgabe hello_python
und einer Aufgabe goodbye_bash
:
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 Airflow-Operatoren finden Sie in der Referenz zu Operatoren und Hooks und im Index des Anbieters.
BashOperator
Mit dem BashOperator können Sie Befehlszeilenprogramme ausführen.
Airflow 2
Airflow 1
Cloud Composer führt die bereitgestellten Befehle in einem Bash-Skript auf einem Airflow-Worker aus. Der Worker ist ein Debian-basierter Docker-Container und enthält mehrere Pakete.
PythonOperator
Verwenden Sie den PythonOperator, um beliebigen Python-Code auszuführen.
Cloud Composer führt den Python-Code in einem Container aus, der Pakete für die in Ihrer Umgebung verwendete Cloud Composer-Image-Version enthält.
Informationen zum Installieren weiterer Python-Pakete finden Sie unter Python-Abhängigkeiten installieren.
Google Cloud-Operatoren
Verwenden Sie die Google Cloud Airflow-Operatoren, um Aufgaben auszuführen, die Google Cloud-Produkte verwenden. BigQuery-Operatoren fragen beispielsweise Daten in BigQuery ab und verarbeiten sie.
Es gibt viele weitere Airflow-Operatoren für Google Cloud und einzelne Dienste von Google Cloud. Eine vollständige Liste finden Sie unter Google Cloud-Operatoren.
Airflow 2
Airflow 1
EmailOperator
Verwenden Sie den EmailOperator, um E-Mails von einem DAG zu senden. 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
Benachrichtigungen bei Ausfall des Bedieners
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.
Wenn Airflow den Ordner
dags/
scannt, sucht Airflow nur in Python-Modulen nach DAGs, die sich auf der obersten Ebene des DAGs-Ordners und auf der obersten Ebene eines ZIP-Archivs befinden, das sich auch im übergeordneten Ordnerdags/
befindet. Wenn Airflow in einem ZIP-Archiv auf ein Python-Modul stößt, das wederairflow
- nochDAG
-Teilstrings enthält, beendet Airflow die Verarbeitung des ZIP-Archivs. Airflow gibt nur die bis zu diesem Zeitpunkt gefundenen DAGs zurück.Verwenden Sie Airflow 2 anstelle von Airflow 1.
Die Airflow-Community veröffentlicht keine neuen Neben- oder Patchversionen für Airflow 1 mehr.
Achten Sie aus Gründen der Fehlertoleranz darauf, nicht mehrere DAG-Objekte im gleichen Python-Modul zu definieren.
Verwenden Sie keine SubDAGs. Stattdessen gruppieren Sie Aufgaben in DAGs.
Platzieren Sie Dateien, die zum Zeitpunkt der DAG-Analyse 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 die DAG-Analysezeiten von entwickelten DAGs nicht zu stark verlängert werden.
Airflow-Aufgaben können aus mehreren Gründen fehlschlagen. Um Fehler bei der gesamten DAG-Ausführung zu vermeiden, empfehlen wir, Wiederholungsversuche von Aufgaben zu aktivieren. Wenn Sie die maximale Anzahl von Wiederholungen auf
0
festlegen, werden keine Wiederholungen ausgeführt.Wir empfehlen, die Option
default_task_retries
mit einem anderen Wert als0
für die Aufgabe zu überschreiben. Darüber hinaus können Sie den Parameterretries
auf Aufgabenebene festlegen.Wenn Sie GPU in Ihren Airflow-Aufgaben verwenden möchten, erstellen Sie einen separaten GKE-Cluster basierend auf Knoten, die Maschinen mit GPUs verwenden. Verwenden Sie den GKEStartPodOperator, um Ihre Aufgaben auszuführen.
Vermeiden Sie es, CPU- und arbeitsspeicherintensive Aufgaben im Knotenpool des Clusters auszuführen, 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 parst kontinuierlich DAGs im Ordner
/dags
. Das Parsing ist ein Prozess, der den DAGs-Ordner in einer Schleife durchläuft. Die Anzahl der zu ladenden Dateien (mit ihren Abhängigkeiten) wirkt sich auf die Leistung des DAG-Parsings und der Aufgabenplanung aus. Es ist wesentlich effizienter, 100 Dateien mit jeweils 100 DAGs zu verwenden als 10.000 Dateien mit jeweils einem DAG. Daher wird eine solche Optimierung empfohlen. Diese Optimierung ist ein Gleichgewicht zwischen der Parsing-Zeit und der Effizienz der DAG-Erstellung und -Verwaltung.Sie können beispielsweise auch 10.000 DAG-Dateien bereitstellen und 100 ZIP-Dateien erstellen, die jeweils 100 DAG-Dateien enthalten.
Wenn Sie mehr als 10.000 DAG-Dateien haben, könnte es zusätzlich zu den obigen Hinweisen eine gute Option sein, DAGs programmatisch zu generieren. Sie können beispielsweise eine einzelne Python-DAG-Datei implementieren, die eine bestimmte Anzahl von DAG-Objekten generiert (z. B. 20 oder 100 DAG-Objekte).
Verworfene Airflow-Operatoren nicht verwenden
Die in der folgenden Tabelle aufgeführten Operatoren wurden eingestellt. Vermeiden Sie deren Verwendung in Ihren DAGs. Verwenden Sie stattdessen aktuelle Alternativen.
Veralteter 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 zu definieren, um Codewiederholungen zu minimieren.
Wie kann ich Code in mehreren DAG-Dateien wiederverwenden?
Legen Sie Dienstprogrammfunktionen in eine lokale Python-Bibliothek ab 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 DAG A ausgelöst werden soll, können Sie einen TriggerDagRunOperator
an das Ende von DAG A setzen.
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 in XComs
abgelegt, sodass Sie in anderen Operatoren über Vorlagenfelder darauf verweisen können.
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 dazu Airflow-Pools in der Airflow-Weboberfläche definieren und in Ihren DAGs Aufgaben mit vorhandenen Pools verknüpfen.
FAQs zur Verwendung von Operatoren
Soll ich den DockerOperator
verwenden?
Wir raten davon ab, den DockerOperator
zu verwenden, es sei denn, er wird verwendet, um Container in einer Remote-Docker-Installation zu starten (nicht in einem Umgebungscluster). 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 wird nicht empfohlen, Pods im Cluster einer Umgebung zu starten, da dies zu einem Ressourcenwettbewerb führen kann.
Soll ich den SubDagOperator
verwenden?
Die Verwendung von SubDagOperator
wird nicht empfohlen.
Verwenden Sie Alternativen, wie in der Anleitung zum Gruppieren von Aufgaben vorgeschlagen.
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äge die Verwendung von 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,
Sie können auch den KubernetesPodOperator
verwenden, um einen Kubernetes-Pod mit einem eigenen Image auszuführen, das Sie aus benutzerdefinierten Paketen erstellt haben.
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 dies, dass Vorlagen erst unmittelbar vor der Ausführung einer Aufgabe ersetzt werden.
Wie kann ich erkennen, welche Operatorargumente die Vorlagenersetzung unterstützen?
Operatorargumente, die die Jinja2-Vorlagenersetzung unterstützen, sind explizit als solche markiert.
Suchen Sie in der Operatordefinition nach dem Feld template_fields
. Es enthält eine Liste von Argumentnamen, die der Vorlagenersetzung unterzogen werden.
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 im Planer
- Google-Operatoren
- Google Cloud-Operatoren
- Apache Airflow-Anleitung
- Öffentliche Schnittstelle von Airflow
- Core-Airflow-Operatoren auf GitHub. (siehe Informationen zum Zweig für Ihr Airflow-Release)
- Paketoperatoren für Anbieter auf GitHub (siehe Informationen zum Zweig für Ihr Airflow-Release)