Skip to content

docs(apple): Document outgoing connections for sandboxed macOS apps - #19892

Open
sansynx wants to merge 1 commit into
getsentry:masterfrom
sansynx:docs/macos-sandbox-network
Open

sansynx wants to merge 1 commit into
getsentry:masterfrom
sansynx:docs/macos-sandbox-network

Conversation

@sansynx

@sansynx sansynx commented Oct 11, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Fixes #13623

Add the Outgoing Connections (Client) setting to the macOS getting-started guide for apps that use App Sandbox. Without this entitlement, the sandbox blocks the SDK's outgoing connections.

The note is scoped to macOS and links to Apple's entitlement documentation. Other Apple guides are unchanged.

The changed MDX compiles locally. The Vercel preview has not been verified.

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

@vercel

vercel Bot commented Oct 11, 2026

Copy link
Copy Markdown

@sansynx is attempting to deploy a commit to the Sentry Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 11, 2026
@sansynx
sansynx marked this pull request as ready for review October 11, 2026 05:18
Copilot AI balanced review requested due to automatic review settings October 11, 2026 05:18

Copilot AI 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.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 11, 2026 05:18
@cursor

cursor Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks getting-started page loads, sibling page loads, client errors, and 404s. An issue escalates when those page loads drop or client errors rise.

Services: sentry-docs.

Mention @change-monitor in a comment to update the plan.

Plan

What changed

The macOS getting-started page now tells sandboxed apps to enable Outgoing Connections. Without that entitlement the sandbox blocks the SDK. The same include also renders iOS, tvOS, watchOS, and visionOS getting-started pages. The note itself shows only on macOS. This change is live after sentry-docs deploys.
issues/13623

Risk

A broken include can fail the static page or blank every Apple getting-started page. Readers then miss install steps on iOS and macOS, not only the new note. Wrong platform gating can hide the note on macOS or show it on other Apple platforms.

Intended effect

This docs edit has no queryable production signal. The new paragraph is not instrumented. Telemetry cannot show that the note is on the page. absent looks the same as confirmed in metrics.

Regression watch

A bad include would drop page loads on the changed page and on sibling Apple getting-started pages. Client errors or 404s on Apple paths are the symptom-class signal. The 24h window ends on Sunday. Weekday page loads may sit above this 24h count.

Signal Baseline Window Rule Source
macOS getting-started page loads 6 per 24h, 65 per 7d, about 9 per day 2026-10-10T05:19:17Z to 2026-10-11T05:19:17Z, and 2026-10-04T05:19:17Z to 2026-10-11T05:19:17Z Hold in the 6-9 per 24h band. Escalate if the count falls to 0. Sentry org sentry, project docs. Metric docs.page.load. Query path:/platforms/apple/guides/macos/.
iOS getting-started page loads /platforms/apple/guides/ios/ 28 per 24h and 343 per 7d. /platforms/apple/ 12 per 24h and 106 per 7d. Combined about 40-64 per 24h. Same windows Hold in the 40-64 per 24h band. Escalate if either path falls to 0. Same metric. Query path:/platforms/apple/guides/ios/ and path:/platforms/apple/.
Apple-path client errors 6 per 24h. 4 were Event promise rejections. 2 were Algolia TypeError Load failed. 2026-10-10T05:19:17Z to 2026-10-11T05:19:17Z Hold at or below 6 per 24h. Escalate if the count rises or new MDX render errors appear. Sentry org sentry, project docs. Query environment:production AND (transaction:"*/platforms/apple/*" OR url:"*/platforms/apple/*") with count().
Apple-path 404s 1 per 24h 2026-10-10T05:19:17Z to 2026-10-11T05:19:17Z Hold at or below 1 per 24h. Escalate if the count rises. Sentry org sentry, project docs. Metric docs.page.not_found. Query requested_path:*platforms/apple*.

Shared include pages /platforms/apple/guides/tvos/, /platforms/apple/guides/watchos/, and /platforms/apple/guides/visionos/ had 9, 16, and 6 page loads in 7d. Do not treat a quiet 24h on those paths as a regression by itself.

Not observable

The new paragraph text on the page. No content probe exists. Pageload and HTTP span duration for /platforms/apple/guides/macos/ returned zero spans after url.path and transaction queries. Whether readers enable the entitlement in Xcode.

This branch has not been deployed

No deployments
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.

Apple: Mention enable outgoing connections for sandboxed macOS apps

2 participants