apache / apache/airflow

Create a basic guiding doc - How to Debug Your Airflow Deployment

Open
#43,892 7 comments 5 reactions 1 assignee Claimed by @rawwar View on GitHub
kind:documentation kind:feature
Dominant language
Python
Stars
46.9k
Forks
17.8k
Avg merge
2d 10h
Merged PRs (30d)
483

Description

### Description

Create a basic guiding doc "How to Debug Your Airflow Deployment" that can guide users towards debugging their Airflow deployment. This doc can be based on general Airflow best practices + Agans' 9 rules of debugging:

1. Understand the system
2. Make it fail
3. Quit thinking and look
4. Divide and conquer
5. Change one thing at a time
6. Keep an audit trail
7. Check the plug
8. Get a fresh view
9. If you didn't fix it, it ain't fixed

The guide shall express above rules using Airflow examples, such that the users can read the guide and understand how to approach similar Airflow debugging scenarios.

### Use case/motivation

David A. Wheeler's Article (2004): https://dwheeler.com/essays/debugging-agans.html

### Related issues

Parent Issue: https://github.com/apache/airflow/issues/40975

### Are you willing to submit a PR?

- [x] Yes I am willing to submit a PR!

### Code of Conduct

- [x] I agree to follow this project's [Code of Conduct](https://github.com/apache/airflow/blob/main/CODE_OF_CONDUCT.md)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.