Get started with Apache Airflow, Part 2: Providers, connections, and variables
Use this tutorial after completing Part 1: Write your first DAG to learn about how to connect Airflow to external systems.
After you complete this tutorial, you'll be able to:
- Add an Airflow provider to your Airflow environment.
- Create and use an Airflow connection.
- Create and use an Airflow variable.
Time to complete
This tutorial takes approximately 30 minutes to complete.
Assumed knowledge
To complete this tutorial, you'll need to know:
- How to write DAGs and run Airflow. See Part 1: Write your first DAG.
Prerequisites
- The Astro CLI version 1.34.0 or later.
- The completed project from Part 1: Write your first DAG. To jump directly into this tutorial, create a new Astro project and copy the code at the end of Step 6 into your project as a new DAG.
Step 1: Create your DAG
In this second part of Astronomer's introduction to Airflow, you'll add a third DAG to your Astro project. The new DAG interacts with the Open Notify API to print the location of the International Space Station (ISS) to your task logs.
- Create a new Python file in the
dags
directory of your Astro project calledfind_the_iss.py
. - Copy and paste the code below into
find_the_iss.py
.
Click to view the full DAG code
"""
## Find the International Space Station
This DAG pulls the current location of the International Space Station from an API
and prints it to the logs.
This DAG needs a HTTP connection with the name `open_notify_api_conn`
and the host `https://api.open-notify.org/` to work.
"""
from airflow.sdk import chain, dag
from airflow.decorators import task
from airflow.providers.http.operators.http import HttpOperator
from airflow.models import Variable
from pendulum import datetime
import logging
task_logger = logging.getLogger("airflow.task")
MY_ENDPOINT = Variable.get(
"my_endpoint", "NOT SET"
) # This is the variable you created in the Airflow UI!
@dag(
start_date=datetime(2024, 1, 1),
schedule="@daily",
doc_md=__doc__,
default_args={"owner": "airflow", "retries": 3},
tags=["Connections"],
)
def find_the_iss():
get_iss_coordinates = HttpOperator(
task_id="get_iss_coordinates",
http_conn_id="open_notify_api_conn",
endpoint=MY_ENDPOINT,
method="GET",
log_response=True,
)
@task
def log_iss_location(location: str) -> dict:
"""
This task prints the current location of the International Space Station to the logs.
Args:
location (str): The JSON response from the API call to the Open Notify API.
Returns:
dict: The JSON response from the API call to the Reverse Geocode API.
"""
import requests
import json
location_dict = json.loads(location)
lat = location_dict["iss_position"]["latitude"]
lon = location_dict["iss_position"]["longitude"]
r = requests.get(
f"https://api.bigdatacloud.net/data/reverse-geocode-client?latitude={lat}&longitude={lon}"
).json()
country = r["countryName"]
city = r["locality"]
task_logger.info(
f"The International Space Station is currently over {city} in {country}."
)
return r
log_iss_location_obj = log_iss_location(get_iss_coordinates.output)
chain(get_iss_coordinates, log_iss_location_obj)
find_the_iss()
Step 2: Add a provider package
-
If your Airflow project is not running locally yet, run
astro dev start
in the your Astro project directory to start your Airflow environment. -
Open the Airflow UI to confirm that your DAG was pushed to your environment. On the Dags page, you should see a "DAG Import Error" like the one shown here:
This error is due to a missing provider package. Provider packages are Python packages maintained separately from core Airflow that contain hooks and operators for interacting with external services. You can browse all available providers in the Astronomer Registry.
Your DAG uses operators from the HTTP provider, which is missing from your Airflow environment. Let's fix that!
-
Open the HTTP provider page in the Astronomer Registry.
-
Copy the provider name and version by clicking Use Provider in the top right corner.
-
Paste the provider name and version into the
requirements.txt
file of your Astro project. Make sure to only addapache-airflow-providers-http=<version>
withoutpip install
. -
Restart your Airflow environment by running
astro dev restart
. Unlike DAG code changes, package dependency changes require a complete restart of Airflow.
Step 3: Add an Airflow variable
After restarting your Airflow instance, you should not see the DAG import error from Step 2. Next, you need to add an Airflow variable to be used in the HTTPOperator.
Airflow variables are key value pairs that can be accessed from any DAG in your Airflow environment. Currently, the variable my_endpoint
is used in the DAG code with a default of NOT SET
, you'll need to create the variable and give it a value in the Airflow UI.
-
Go to Admin > Variables to open the list of Airflow variables. Since no Airflow variables have been defined yet, it is empty.
-
Click on the + Add Variable button in the top right corner to open the form for adding a new variable. Set the Key for the variable as
my_endpoint
and set the Val to/iss-now.json
. This is the endpoint of the Open Notify API that returns the current location of the ISS. The variable is used in theget_iss_coordinates
task to specify the endpoint to query. -
Click Save.
Step 4: Create an HTTP connection
An Airflow connection is a set of configurations for connecting with an external tool in the data ecosystem. If you use a hook or operator that connects to an external system, it likely needs a connection.
- Click on Admin > Connections to open the list of Airflow connections. Since no Airflow connections have been defined yet, it is empty.
- Click + Add Connection to create a new connection.
- Name the connection
open_notify_api_conn
and select a Connection Type ofHTTP
. - Enter the host URL for the API you want to query in the Host field. For this tutorial we use the Open Notify API, which has an endpoint returning the current location of the ISS. The host for this API is
http://api.open-notify.org
. - Click Save.
Step 5: Review the DAG code
Now that your Airflow environment is configured correctly, look at the DAG code you copied from the repository to see how your new variable and connections are used at the code level.
At the top of the file, the DAG is described in a docstring. It's highly recommended to always document your DAGs and include any additional connections or variables that are required for the DAG to work.
"""
## Find the International Space Station
This DAG pulls the current location of the International Space Station from an API
and prints it to the logs.
This DAG needs a HTTP connection with the name `open_notify_api_conn`
and the host `https://api.open-notify.org/` to work.
"""
After the docstring, all necessary packages are imported. Notice how both the HttpOperator as well as the GithubSensor are part of provider packages.
from airflow.sdk import chain, dag
from airflow.decorators import task
from airflow.providers.http.operators.http import HttpOperator
from airflow.models import Variable
from pendulum import datetime
import logging
Next, the Airflow task logger is instantiated and two top-level variables are defined. The variable MY_ENDPOINT
is set to the value of the Airflow variable my_endpoint
you defined in Step 3.
task_logger = logging.getLogger("airflow.task")
MY_ENDPOINT = Variable.get(
"my_endpoint", "NOT SET"
) # This is the variable you created in the Airflow UI!
The DAG itself is defined using the @dag
decorator with the following parameters:
dag_id
is not set explicitly, so it defaults to the name of the Python function,find_the_iss
.start_date
is set to January 1st, 2024, which means the DAG starts to be scheduled after this date.schedule
is set to@daily
, which means the DAG runs every day at 0:00 UTC. You can use any CRON string or shorthand for time-based schedules.doc_md
is set to the docstring of the DAG file to create DAG Docs you can view in the Airflow UI.default_args
is set to a dictionary with the keyowner
set toairflow
and the keyretries
set to3
. The latter setting gives each task in this DAG 3 retries before failing, which is a common best practice to protect against transient failures.tags
adds theConnections
tag to the DAG in the Airflow UI.
@dag(
start_date=datetime(2025, 3, 1),
schedule="@daily",
doc_md=__doc__,
default_args={"owner": "airflow", "retries": 3},
tags=["Connections"],
)
def find_the_iss():
This DAG has two tasks:
-
The first task uses the HttpOperator to send a
GET
request to the/iss-now.json
endpoint of the Open Notify API to retrieve the current location of the ISS. The response is logged to the Airflow task logs and pushed to the XCom table in the Airflow metadata database to be retrieved by downstream tasks.get_iss_coordinates = HttpOperator(
task_id="get_iss_coordinates",
http_conn_id="open_notify_api_conn",
endpoint=MY_ENDPOINT,
method="GET",
log_response=True,
) -
The second task uses the TaskFlow API's
@task
decorator to run a Python function that processes the coordinates returned by theget_iss_coordinates
task and prints the city and country of the ISS's location to the task logs. The coordinates are passed to the function as an argument usingget_iss_coordinates.output
, which accesses the data returned by theget_iss_coordinates
task from XComs.These two tasks are an example of how you can use a traditional operator (HttpOperator) and a TaskFlow API task to perform similar operations, in this case querying an API. The best way to write tasks depends on your use case and often comes down to personal preference.
@task
def log_iss_location(location: str) -> dict:
"""
This task prints the current location of the International Space Station to the logs.
Args:
location (str): The JSON response from the API call to the Open Notify API.
Returns:
dict: The JSON response from the API call to the Reverse Geocode API.
"""
import requests
import json
location_dict = json.loads(location)
lat = location_dict["iss_position"]["latitude"]
lon = location_dict["iss_position"]["longitude"]
r = requests.get(
f"https://api.bigdatacloud.net/data/reverse-geocode-client?latitude={lat}&longitude={lon}"
).json()
country = r["countryName"]
city = r["locality"]
task_logger.info(
f"The International Space Station is currently over {city} in {country}."
)
return r
# calling the @task decorated task with the output of the get_iss_coordinates task
log_iss_location_obj = log_iss_location(get_iss_coordinates.output)
Lastly, the dependency between the two tasks is set so that the log_iss_location
task only runs after the get_iss_coordinates
task is successful. This is done using the chain
method. You can learn more about setting dependencies between tasks in the Manage task and task group dependencies in Airflow guide.
The last line of the DAG file calls the find_the_iss
function to create the DAG.
chain(get_iss_coordinates, log_iss_location_obj)
find_the_iss()
Step 6: Test your DAG
-
Go to the DAGs view and unpause the
find_the_iss
DAG by clicking on the toggle to the left of the DAG name. The last scheduled DAG run automatically starts. -
Check the logs of the
log_iss_location
task to learn where the ISS is right now!
[2025-03-30, 17:52:19] INFO - The International Space Station is currently over Ta’if in Saudi Arabia.: source="airflow.task"
See also
- The Astronomer Registry to find information on all providers.
- The Airflow connections guide to learn more about Airflow connections.
- The Airflow variables guide to learn more about Airflow variables.