airflow-diagrams
Auto-generated Diagrams from Airflow DAGs.
๐ฎ ๐ช
This project aims to easily visualise your Airflow DAGs on service level from providers like AWS, GCP, Azure, etc. via diagrams.
Before | After |
---|---|
๐ Get started
To install it from PyPI run:
pip install airflow-diagrams
NOTE: Make sure you have Graphviz installed.
Then just call it like this:
Examples of generated diagrams can be found in the examples directory.
๐ค How it Works
โน๏ธ It connects, by using the official Apache Airflow Python Client, to your Airflow installation to retrieve all DAGs (in case you don't specify anydag_id
) and all Tasks for the DAG(s).๐ช It processes every DAG and its Tasks and๐ฎ tries to find a diagram node for every DAGs task, by using Fuzzy String Matching, that matches the most. If you are unhappy about the match you can also provide amapping.yml
file to statically map from Airflow task to diagram node.๐จ It renders the results into a python file which can then be executed to retrieve the rendered diagram.๐
โค๏ธ Contributing
Contributions are very welcome. Please go ahead and raise an issue if you have one or open a PR. Thank you.