Skip to content

Create airflow_integration.mdx#1058

Merged
muddlebee merged 10 commits intoTracer-Cloud:mainfrom
cerencamkiran:patch-23
Apr 29, 2026
Merged

Create airflow_integration.mdx#1058
muddlebee merged 10 commits intoTracer-Cloud:mainfrom
cerencamkiran:patch-23

Conversation

@cerencamkiran
Copy link
Copy Markdown
Collaborator

Adds a comprehensive Airflow integration guide:

  • architecture and investigation flow
  • configuration and setup
  • real-world failing DAG example
  • planner behavior and limitations
  • testing instructions

Closes #1020

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 28, 2026

Greptile Summary

This PR adds a new Airflow integration guide covering architecture, configuration, a failing-DAG example, investigation flow, and planner behavior. Two of the three testing commands reference test files that do not exist in the repository (tests/e2e/airflow/test_orchestrator.py and tests/nodes/plan_actions/test_airflow_routing.py), so both will fail when run as documented. The file also uses the .md extension instead of .mdx, which diverges from every other file in docs/integrations/ and will likely be excluded from site navigation.

Confidence Score: 3/5

Not safe to merge as-is — the two broken test paths will mislead users and should either be corrected to existing paths or the test files created before this doc ships.

Two P1 findings exist: both pytest commands in the Testing section point to files absent from the repository. A developer following the guide will get errors rather than passing tests, undermining the guide's purpose.

docs/integrations/airflow_integration.md — both Testing section commands reference non-existent test files

Important Files Changed

Filename Overview
docs/integrations/airflow_integration.md New Airflow integration guide with two broken test paths (non-existent e2e and routing test files) and wrong file extension compared to all other integration docs (.md vs .mdx)

Sequence Diagram

sequenceDiagram
    participant Alert as Alert Source
    participant Planner as Planner (LLM)
    participant Tools as Airflow Tools
    participant API as Airflow REST API
    participant RCA as RCA Generator

    Alert->>Planner: Ingest alert (source=airflow, dag_id)
    Planner->>Planner: Seed Airflow tools into action space
    Planner->>Tools: Select & invoke tool (list_dag_runs / get_task_instances)
    Tools->>API: GET /api/v1/dags/{dag_id}/dagRuns
    API-->>Tools: DAG run list
    Tools->>API: GET /api/v1/dags/{dag_id}/dagRuns/{run_id}/taskInstances
    API-->>Tools: Task instance details
    Tools-->>Planner: Evidence (failures, logs)
    Planner->>RCA: Pass structured evidence
    RCA-->>Planner: Root cause analysis
Loading

Reviews (1): Last reviewed commit: "Create airflow_integration.md" | Re-trigger Greptile

Comment thread docs/airflow.mdx
Comment on lines +155 to +157
```bash
python -m pytest tests/e2e/airflow/test_orchestrator.py -v
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Test path does not exist

The e2e test path tests/e2e/airflow/test_orchestrator.py referenced here does not exist in the repository. There is no tests/e2e/airflow/ directory at all. Running the documented command will produce a collection error rather than a passing test, misleading users who follow the guide. The only Airflow-related test found is tests/tools/test_tracer_airflow_metrics_tool.py.

Comment thread docs/airflow.mdx
Comment on lines +163 to +165
```

### Routing Tests
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Routing test path does not exist

tests/nodes/plan_actions/test_airflow_routing.py is not present in the repository. The tests/nodes/plan_actions/ directory contains several test_detect_sources_*.py files for other integrations but no Airflow-specific routing test. Running this command will fail with a "no tests ran" or collection error.

Comment thread docs/integrations/airflow_integration.md Outdated
@cerencamkiran
Copy link
Copy Markdown
Collaborator Author

The test files referenced in the Testing section (tests/e2e/airflow/test_orchestrator.py and tests/nodes/plan_actions/test_airflow_routing.py) are being added in a separate #570 PR and are not yet merged.

@cerencamkiran cerencamkiran changed the title Create airflow_integration.md Create airflow_integration.mdx Apr 28, 2026
@cerencamkiran
Copy link
Copy Markdown
Collaborator Author

@muddlebee could you please look at that 🙏🏻

@muddlebee
Copy link
Copy Markdown
Collaborator

@cerencamkiran nice, but I think you need to add the entry to docs.json as well? did you test this locally? that it renders in the doc page?

@muddlebee
Copy link
Copy Markdown
Collaborator

docs/docs.json: Add the new page to navigation so it shows under Integrations (and the right group). For docs/integrations/airflow_integration.mdx, the slug should be integrations/airflow_integration. Without this, the guide may be reachable only by direct URL or not wired into the site as intended.

@cerencamkiran
Copy link
Copy Markdown
Collaborator Author

@muddlebee
Added the page to docs.json under Integrations → Local and set the slug to integrations/airflow_integration.
Tested locally with Mintlify, the page renders correctly in the navigation.

Comment thread docs/docs.json Outdated
"google-docs",
"discord"
"discord",
"rabbitmq",
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

rabbitmq why?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that came from my branch being slightly behind the latest docs.json state.

@muddlebee
Copy link
Copy Markdown
Collaborator

muddlebee commented Apr 29, 2026

hey @cerencamkiran if you see the naming conventions https://github.com/Tracer-Cloud/opensre/blob/main/docs/docs.json#L52-L69

  • docs/integrations/airflow_integration.mdx -> docs/airflow_integration.mdx (integrations folder is for something else I guess)
  • airflow_integration -> airflow

does the above naming convention makes sense?

@cerencamkiran
Copy link
Copy Markdown
Collaborator Author

Yes @muddlebee, makes sense 👍

I've updated it accordingly:

  • moved the file to docs/airflow.mdx
  • set slug to "airflow"
  • updated docs.json to use "airflow"

@muddlebee muddlebee merged commit 8277665 into Tracer-Cloud:main Apr 29, 2026
1 check passed
@github-actions
Copy link
Copy Markdown
Contributor

🎉 MERGED! @cerencamkiran just shipped something. The diff gods are pleased. 🙌


👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome.

@muddlebee
Copy link
Copy Markdown
Collaborator

@cerencamkiran awesome 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[IMPROVEMENT] : add docs for apache airflow

2 participants