Skip to content

docs(unity): Fix data collected, privacy and enriching pages - #20421

Open
bitsandfoxes wants to merge 5 commits into
fix/unity-docs-debug-symbolsfrom
fix/unity-docs-data-privacy
Open

bitsandfoxes wants to merge 5 commits into
fix/unity-docs-debug-symbolsfrom
fix/unity-docs-data-privacy

Conversation

@bitsandfoxes

@bitsandfoxes bitsandfoxes commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Corrects the Unity pages about what the SDK collects, how scopes work in Unity, and how to scrub data, against the sentry-unity 4.13.0 source.

Stacked on #20418 (debug symbols). Its base is that branch, so the diff shows only this PR's changes.

  • Data Collected, rewritten for Unity:
    • The installation ID sent as user.id: a random ID stored on the device by default, the native SDK's ID on iOS, Android, Switch and macOS with the Cocoa backend, the network adapter's MAC address or a machine-name hash where the SDK can't write files (UWP, visionOS), and the host app's user with Unity as a Library.
    • What SendDefaultPii adds: the IP address, the device's unique identifier, the device name, and the OS user name with Auto Set UserName.
    • Failed HTTP requests: what the Cocoa SDK captures on iOS and macOS, and what SentryHttpMessageHandler records in C#.
    • Logs and breadcrumbs, screenshots and the view hierarchy.
    • The full list of automatic contexts (app, os, device, gpu, runtime, unity, culture, thread pool).
  • Context: names the SDK's own contexts and what happens when you reuse one of those names.
  • Scopes: Unity runs in global mode with one scope shared by every thread; the hub and per-request text and the shared thread-locality note are removed from the Unity page.
  • Sensitive Data and Filtering: lists the scrubbing callbacks and states that native crashes don't run them.
  • View Hierarchy: main-thread and active-scene limits, the limit defaults (100, 10, 20), samples for both callbacks, and the correct field names. Screenshots gets the same link fix.
  • Fingerprinting: three C# samples for Unity, and a note that native crashes keep the default grouping.
  • Tags: tags go on the scope the whole game shares.

Pages to check on the preview:

  • /platforms/unity/data-management/data-collected/
  • /platforms/unity/enriching-events/scopes/
  • /platforms/unity/data-management/sensitive-data/
  • /platforms/unity/enriching-events/view-hierarchy/
  • /platforms/unity/usage/sdk-fingerprinting/

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

🤖 Generated with Claude Code

@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 13, 2026 11:01pm UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 13, 2026 11:01pm UTC

Request Review

@coolguyzone coolguyzone 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.

LGTM

Describe the data the Unity SDK collects: the installation ID as the
user, what SendDefaultPii adds, and the automatic app, os, device, gpu
and unity contexts. Drop the HTTP and SQL sections that come from .NET.

Document Unity's single global scope, list the C# scrubbing hooks and
note that native crashes don't run them, fix the view hierarchy limits,
keys and callbacks, and add Unity fingerprinting samples.
Describe failed HTTP request capture in the Cocoa SDK and through
SentryHttpMessageHandler, what logs carry, and how the installation ID
is stored and replaced. List each SendDefaultPii item once, and add
the runtime, culture and thread pool contexts.

Split the view hierarchy callbacks into their own sections, trim the
scopes page and align the fingerprint sample comments.
@bitsandfoxes
bitsandfoxes force-pushed the fix/unity-docs-data-privacy branch from c46a386 to 2752ade Compare November 13, 2026 22:56

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — 2752adeb Deployed Nov 13, 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.

3 participants