Skip to content

feat(react-native): Document native network breadcrumb options - #19551

Merged
antonis merged 4 commits into
masterfrom
docs/rn-network-breadcrumb-options
Sep 24, 2026
Merged

antonis merged 4 commits into
masterfrom
docs/rn-network-breadcrumb-options

Conversation

@antonis

@antonis antonis commented Sep 22, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

⚠️ Should be merged after getsentry/sentry-react-native#6764 is released

Documents two native SDK options newly exposed in the React Native SDK via getsentry/sentry-react-native#6764:

  • enableNetworkBreadcrumbs (iOS, default true) — off-switch for the native per-HTTP-request breadcrumbs, which largely duplicate the JS fetch/XHR breadcrumbs.
  • enableNetworkEventBreadcrumbs (Android, default true) — off-switch for native network connectivity/state breadcrumbs (network available/lost, WiFi ↔ cellular, bandwidth/VPN). These track device network state, not HTTP requests, so they are distinct from the JS fetch/XHR breadcrumbs.

Both are added to the Hybrid SDK Options section of the React Native options page, following the existing <SdkOption> prose/platform conventions. availableSince is intentionally omitted for now (the SDK release version isn't tagged yet); it can be added once the SDK PR lands and a version is cut.

IS YOUR CHANGE URGENT?

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: Not urgent, can wait up to 1 week+

Blocked on the SDK PR (getsentry/sentry-react-native#6764) shipping in a release.

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

🤖 Generated with Claude Code

Add SdkOption entries for enableNetworkBreadcrumbs (iOS) and
enableNetworkEventBreadcrumbs (Android), exposed in the RN SDK via
getsentry/sentry-react-native#6764.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Sep 22, 2026 •

Copy link
Copy Markdown

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

Project Deployment Actions Updated
develop-docs Ready Ready Preview Sep 24, 2026 9:38am UTC
sentry-docs Ready Ready Preview Sep 24, 2026 9:38am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Sep 22, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 22, 2026 11:39
@codeowner-assignment
codeowner-assignment Bot requested a review from a team September 24, 2026 09:29
@antonis
antonis enabled auto-merge (squash) September 24, 2026 09:30
@antonis
antonis merged commit 14f3a00 into master Sep 24, 2026
22 checks passed
@antonis
antonis deleted the docs/rn-network-breadcrumb-options branch September 24, 2026 09:45
antonis added a commit that referenced this pull request Sep 24, 2026
## DESCRIBE YOUR PR

⚠️ Should be merged after
getsentry/sentry-react-native#6768 is released

Documents the native breadcrumb off-switches added in
getsentry/sentry-react-native#6768:

- `enableAutoBreadcrumbTracking` (iOS)
- `enableActivityLifecycleBreadcrumbs` (Android)
- `enableAppLifecycleBreadcrumbs` (Android)
- `enableSystemEventBreadcrumbs` (Android)
- `enableAppComponentBreadcrumbs` (Android)

All default to `true`, matching the native defaults.

> [!NOTE]
> Stacked on top of #19551 (native network breadcrumb options). The base
is set to that branch, so the diff here is only the five breadcrumb
off-switch options. Re-target the base to `master` once #19551 merges.

## 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
- [x] 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](https://github.com/orgs/getsentry/teams/docs)

## EXTRA RESOURCES

---------

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — fb4a05ce Deployed Sep 24, 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