Task documentation and tags in Apache Airflow - Practice Problems & Coding Challenges

Challenge - 5 Problems

🧠 Conceptual

intermediate

Purpose of task documentation in Airflow

Why is it important to add documentation to Airflow tasks?

A To provide clear explanations for task behavior and improve maintainability

B To increase the execution speed of the task

C To automatically retry failed tasks

D To reduce the number of tasks in a DAG

💡 Hint

Think about how documentation helps others understand the task.

Documentation helps team members understand what each task does, making maintenance and debugging easier.

💻 Command Output

intermediate

Output of task tags in Airflow UI

What is the visible effect of adding tags to an Airflow task in the Airflow UI?

Apache Airflow

from airflow import DAG
from airflow.operators.dummy import DummyOperator
from datetime import datetime
with DAG('example_dag', start_date=datetime(2024,1,1)) as dag:
    task = DummyOperator(task_id='dummy_task', tags=['tag1', 'tag2'])

A The tags appear as clickable labels next to the task in the Airflow UI

B The tags change the task execution order

C The tags cause the task to run multiple times

D The tags are not shown anywhere in the Airflow UI

💡 Hint

Tags help organize and filter tasks visually.

Tags appear as clickable labels in the Airflow UI, allowing users to filter and group tasks easily.

❓ Configuration

advanced

Correct way to add documentation to an Airflow task

Which code snippet correctly adds documentation to an Airflow task using the doc_md attribute?

A task = DummyOperator(task_id='task1', doc_string='This task does nothing.')

B task = DummyOperator(task_id='task1', doc_md='''This task does nothing.''')

C task = DummyOperator(task_id='task1', doc='This task does nothing.')

D task = DummyOperator(task_id='task1', documentation='This task does nothing.')

💡 Hint

Check the exact attribute name Airflow expects for markdown documentation.

The doc_md attribute is the correct way to add markdown documentation to a task in Airflow.

❓ Troubleshoot

advanced

Why task tags are not visible in Airflow UI

You added tags to your Airflow tasks but they do not appear in the Airflow UI. What is the most likely cause?

A Tags only appear if the DAG is paused

B The tags attribute must be a string, not a list

C The Airflow version is older than 2.0 which does not support task tags

D Tags require a special plugin to be visible

💡 Hint

Check the Airflow version compatibility for task tags.

Task tags were introduced in Airflow 2.0. Older versions do not support this feature.

✅ Best Practice

expert

Recommended practice for documenting complex Airflow tasks

For a complex Airflow task with multiple steps and conditions, what is the best practice for documentation?

A Skip documentation to avoid clutter

B Add a short comment in the DAG file only

C Rely on task_id naming to explain the task

D Use <code>doc_md</code> with detailed markdown including code snippets and explanations

💡 Hint

Think about clarity and maintainability for others reading the task.

Using doc_md with detailed markdown allows rich, clear documentation that helps others understand complex tasks.