Skip to content

docs(flutter): Add ANR and App Hangs guidance#17881

Open
buenaflor wants to merge 8 commits into
masterfrom
buenaflor/docs-flutter-anr-app-hangs
Open

docs(flutter): Add ANR and App Hangs guidance#17881
buenaflor wants to merge 8 commits into
masterfrom
buenaflor/docs-flutter-anr-app-hangs

Conversation

@buenaflor
Copy link
Copy Markdown
Contributor

@buenaflor buenaflor commented May 26, 2026

DESCRIBE YOUR PR

Adds Flutter-specific ANR and App Hangs documentation.

Closes getsentry/sentry-dart#3649

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.):
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

Made with Cursor

Document Flutter responsiveness detection and clarify required debug symbols
for readable Android ANR and Apple App Hang stack traces.

Co-authored-by: Cursor <cursoragent@cursor.com>
@vercel
Copy link
Copy Markdown

vercel Bot commented May 26, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
sentry-docs Ready Ready Preview, Comment May 28, 2026 2:01pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
develop-docs Ignored Ignored Preview May 28, 2026 2:01pm

Request Review

buenaflor and others added 4 commits May 28, 2026 14:59
Clarify where ANR and App Hang symbolication details belong and keep the
configuration page focused on the feature-level guidance.

Co-authored-by: Cursor <cursoragent@cursor.com>
Keep the ANR and App Hangs page metadata consistent with the page title.

Co-authored-by: Cursor <cursoragent@cursor.com>
Consolidate the platform event naming text on the Flutter ANR and App Hangs page.

Co-authored-by: Cursor <cursoragent@cursor.com>
Tighten the ANR and App Hang stack trace guidance to explain why each
platform's debug files are needed.

Co-authored-by: Cursor <cursoragent@cursor.com>
@buenaflor buenaflor marked this pull request as ready for review May 28, 2026 13:17
Copilot AI review requested due to automatic review settings May 28, 2026 13:17
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds Flutter-specific documentation for ANR and App Hang detection, linking the new guidance from Flutter features, configuration options, and debug-symbol upload docs.

Changes:

  • Adds a new Flutter configuration page for ANR/App Hang detection, runtime pause/resume, and symbolication guidance.
  • Updates the Flutter features page to point to the new consolidated guide.
  • Adds ANR/App Hang symbolication details to the Dart plugin debug-symbols include.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
docs/platforms/dart/guides/flutter/configuration/anr-app-hangs.mdx Adds the new Flutter ANR/App Hangs guide.
docs/platforms/dart/guides/flutter/configuration/options.mdx Links the anrEnabled option to the new guide.
docs/platforms/dart/guides/flutter/features/index.mdx Replaces separate native links with the new Flutter-specific ANR/App Hangs link.
platform-includes/debug-symbols/dart-plugin/dart.flutter.mdx Documents symbolication requirements for ANR/App Hang events.

Comment thread docs/platforms/dart/guides/flutter/configuration/anr-app-hangs.mdx Outdated
buenaflor and others added 2 commits May 28, 2026 15:22
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Apply Prettier formatting to the touched Flutter docs files so the PR lint
checks pass.

Co-authored-by: Cursor <cursoragent@cursor.com>
Copy link
Copy Markdown
Contributor

@cursor cursor Bot left a comment

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 84e3839. Configure here.

Comment thread docs/platforms/dart/guides/flutter/configuration/anr-app-hangs.mdx Outdated
Use regular links for Android and Apple docs from the Flutter ANR and App Hangs page.

Co-authored-by: Cursor <cursoragent@cursor.com>
Copy link
Copy Markdown
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Looks good!

@buenaflor
Copy link
Copy Markdown
Contributor Author

@coolguyzone is this PR good to go?

```dart
await SentryFlutter.init(
(options) {
// Android only: ANR
Copy link
Copy Markdown
Member

@romtsn romtsn May 29, 2026

Choose a reason for hiding this comment

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

dunno if it makes sense to also expose anrProfiling options? but that's probably for a separate PR

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

we dont expose it yet

I'll test it and see if it's useful for Flutter use cases

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.

docs(flutter): document ANR / App Hang behaviour and symbolication

4 participants