Skip to content

Add Troubleshooting and Optimize Performance pages#2445

Closed
lzdanski wants to merge 40 commits into
astronomer:mainfrom
lzdanski:add-troubleshooting
Closed

Add Troubleshooting and Optimize Performance pages#2445
lzdanski wants to merge 40 commits into
astronomer:mainfrom
lzdanski:add-troubleshooting

Conversation

@lzdanski
Copy link
Copy Markdown
Contributor

@lzdanski lzdanski commented Mar 7, 2026

Description

This PR creates several new pages and builds out the *Optimize Performance section of the docs.

Since previous review, this PR adds the following:

Optimize performance documents

  • Optimize setup
  • Optimize rendering
  • Improve task execution

Troubleshooting

  • The PR adds more detail to the troubleshooting page, including the Dag parsing process with related Airflow configurations
  • Instead of adding duplicative content covered in optimize performance, it adds links to those materials.

Housekeeping

  • Adds cross linking and new anchor links to pages with content commonly referred to from the Optimize Performance section.

  • Fixes links, formatting, bullet points, headers in pages with significant edits

  • Adds a Troubleshooting page to CosmosDevex

Screenshot 2026-03-13 at 1 35 16 PM Screenshot 2026-03-13 at 1 35 26 PM Screenshot 2026-03-13 at 1 35 32 PM
  • Adds an Optimize performance landing page with descriptions of the different pages in the section
Screenshot 2026-03-13 at 1 37 30 PM Screenshot 2026-03-13 at 1 37 36 PM
  • Adds Optimize setup page with content from webinars
Screenshot 2026-03-13 at 1 38 51 PM Screenshot 2026-03-13 at 1 38 58 PM
  • Adds an Optimize rendering page with suggestions from webinars
Screenshot 2026-03-13 at 1 39 05 PM Screenshot 2026-03-13 at 1 39 17 PM
  • Adds an Improving task execution page with suggestions from slides and PR feedback
Screenshot 2026-03-13 at 1 39 23 PM Screenshot 2026-03-13 at 1 39 32 PM Screenshot 2026-03-13 at 1 39 38 PM
  • Copyedits and tests links for Memory Optimization. Adds inbound links to Memory Optimization from Troubleshooting and Optimizing Performance.
Screenshot 2026-03-13 at 1 39 50 PM
  • Copyedits and tests links for Caching
Screenshot 2026-03-13 at 1 39 55 PM

Related Issue(s)

The new content supporting Execution Modes should have links added to direct users to Optimize Performance where relevant, and vice versa (#2444)

Breaking Change?

Possible broken links

Checklist

  • I have made corresponding changes to the documentation (if required)
  • I have added tests that prove my fix is effective or that my feature works

@lzdanski lzdanski changed the title [WIP] Add troubleshooting [WIP] Add troubleshooting and Optimize Performance Mar 9, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 9, 2026

Deploy Preview for astronomer-cosmos ready!

Name Link
🔨 Latest commit d1a3a31
🔍 Latest deploy log https://app.netlify.com/projects/astronomer-cosmos/deploys/69b044c57b1170000829afaf
😎 Deploy Preview https://deploy-preview-2445--astronomer-cosmos.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@pankajkoti
Copy link
Copy Markdown
Contributor

Since the PR is created from a fork, making it difficult to resolve conflicts and address review comments, I have opened a new PR #2521, and hence, I am closing this PR.

@pankajkoti pankajkoti closed this Mar 31, 2026
pankajkoti added a commit that referenced this pull request Apr 1, 2026
Add three new pages to the optimize_performance section:

- optimize_rendering: Covers DAG parsing performance with
recommendations for LoadMode selection, reducing DAG granularity via
selectors and TestBehavior, and skipping stale sources.

- optimize_execution: Covers DAG run performance with guidance on
execution mode selection (WATCHER recommended), dbt installation,
pre-installing dependencies, profiles.yml usage, worker node sizing
ratios per execution mode, and memory profiling.

- troubleshooting: Covers diagnosing performance issues, including
Cosmos parse time logs, Airflow DAG processor configuration (with
Airflow 2 and 3 settings), missing DAGs, and OOM errors.

Each page leads with the recommended approach and links to existing
detailed documentation rather than re-explaining concepts.

related: #2445

---------

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
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.

4 participants