Skip to content

docs(android): Add experimental out-of-process crash handling - #20431

Open
jpnurmi wants to merge 6 commits into
masterfrom
jpnurmi/feat/native-android
Open

jpnurmi wants to merge 6 commits into
masterfrom
jpnurmi/feat/native-android

Conversation

@jpnurmi

@jpnurmi jpnurmi commented Nov 3, 2026 •

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Document the opt-in out-of-process backend of the NDK integration, which captures native crashes in a separate crash service process and sends them right away. Cover enabling it with and without the Sentry Android Gradle Plugin, the API 30+ requirement, and what the separate process means for the app.

See:

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • 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

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

Document the opt-in out-of-process backend of the NDK integration,
which captures native crashes in a separate crash service process and
sends them right away. Cover enabling it with and without the Sentry
Android Gradle Plugin, the API 30+ requirement, and what the separate
process means for the app.

Ref: getsentry/sentry-native#1725
Ref: getsentry/sentry-java#6347
Ref: getsentry/sentry-android-gradle-plugin#1474
@vercel

vercel Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Nov 5, 2026 4:30pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 5, 2026 4:30pm UTC

Request Review

@cursor

cursor Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Getting ready to monitor this change · Rollout details

Status Service Environment
⏳ Getting ready to monitor this change

Android can freeze the crash service shortly after the app exits, so a
slow upload may not finish. The SDK then sends the crash on a later app
start. Document this as a known limitation of out-of-process crash
handling.
The `ndkBackend` option of the Gradle plugin is parked for now, so add
the package and the exclude directly.

```groovy {filename:app/build.gradle}
dependencies {
implementation "io.sentry:sentry-android-ndk-outproc:{{@inject packages.version('sentry.java.android', '8.21.1') }}"

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.

Suggested change
implementation "io.sentry:sentry-android-ndk-outproc:{{@inject packages.version('sentry.java.android', '8.21.1') }}"
implementation "io.sentry:sentry-android-ndk-outproc:{{@inject packages.version('sentry.java.android', '9.0.0-alpha.1') }}"

I think this should be the version where this first ships whether it's v9 or v8 (same for the snippet below)

@jpnurmi jpnurmi Nov 6, 2026 •

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 put 8.64 for now, but let's sync it at the end when it's been released and we are ready to merge this. Leaving this unresolved until then. 👍

@romtsn romtsn left a comment

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.

a few nits, but looks good otherwise! pre-approving

Android runs `Application.onCreate` in the crash service process too.
Spell out the side effects for app startup code and how to skip it.
Only the `sentry-android` bundle pulls in `sentry-native-ndk`, so builds
that use `sentry-android-core` don't need the exclude.
The snippets copied `8.21.1` from the older NDK snippet, which predates
`sentry-android-ndk-outproc`. Use the first release expected to ship it.
@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 5, 2026 16:24
@github-actions github-actions Bot removed the Priority: Normal Docs review has no urgent deadline label Nov 6, 2026
@github-actions github-actions Bot added Priority: Needs Triage The PR description is missing valid priority information Priority: Normal Docs review has no urgent deadline and removed Priority: Needs Triage The PR description is missing valid priority information labels Nov 6, 2026

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 493dd68c Deployed Nov 5, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants