Skip to content

docs(unity): Fix tracing, logs, metrics and error capture docs - #20426

Open
bitsandfoxes wants to merge 4 commits into
fix/unity-docs-data-privacyfrom
fix/unity-docs-tracing-logs
Open

docs(unity): Fix tracing, logs, metrics and error capture docs#20426
bitsandfoxes wants to merge 4 commits into
fix/unity-docs-data-privacyfrom
fix/unity-docs-tracing-logs

Conversation

@bitsandfoxes

@bitsandfoxes bitsandfoxes commented Nov 3, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Corrects the Unity docs for throttling, metrics, sessions, automatic error capture, tracing, breadcrumbs, logs and user feedback against the sentry-unity 4.13.0 source.

Stacked on #20421 (data collected and privacy). Its base is that branch, so the diff shows only this PR's changes.

  • Event Throttling (same URL as the Event Debouncing page): the editor's Enable Error Event Throttling and Dedupe Window, what the built-in throttler drops, and a sample IThrottler for code. EnableLogDebouncing and the DebounceTime* options are marked deprecated.
  • Metrics: metrics are always on; SetBeforeSendMetric drops them. New experimental "Automatic Game Metrics" section with the frame, memory, GC and network metrics, their options, metric names and shared attributes.
  • Sessions: a Unity version of the auto-session-tracking text: on by default, paused on quit and closed at the next start (with a cache directory), the 30 s background timeout, and the Unhandled status that uncaught exceptions and Debug.LogException produce.
  • Releases: removes the .NET release-health alert.
  • Automatic error capture: Debug.LogAssertion and failed Debug.Assert (editor and development builds only), turning off automatic capture and what each method covers, and how errors join traces (one trace per session without tracing; one per transaction with tracing, and a new trace after each transaction finishes).
  • Tracing and automatic instrumentation: the automatic startup, scene-load and Awake transactions need TracesSampleRate above 0; startup traces don't run in the Editor, on WebGL or after a late manual init; Awake spans are woven in at build time; SceneManagerAPI.overrideAPI and scene-load tracing.
  • Breadcrumbs and logs: correct Unity method names, per-type breadcrumb control and its interaction with structured logs, EnableLogs, and Debug.Log at Info level.
  • User Feedback: removes the beta alert, notes the uGUI requirement for the prefab, and shows the CaptureFeedback(..., addScreenshot: true) overload.

The Unity quick start (docs/platforms/unity/index.mdx, open in #20012) still links this page as "Event debouncing … to handle high amounts of log output"; it should say "Event throttling" and that it limits repeated errors.

Pages to check on the preview:

  • /platforms/unity/configuration/event-debouncing/
  • /platforms/unity/metrics/
  • /platforms/unity/usage/automatic-error-capture/
  • /platforms/unity/tracing/instrumentation/automatic-instrumentation/
  • /platforms/unity/user-feedback/

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 •
edited
Loading

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

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Nov 3, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 3, 2026 15:48
@bitsandfoxes
bitsandfoxes force-pushed the fix/unity-docs-tracing-logs branch from a4bc85e to daa193e Compare November 3, 2026 16:08
@bitsandfoxes
bitsandfoxes marked this pull request as ready for review November 3, 2026 17:03
@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 3, 2026 17:05
coolguyzone
coolguyzone approved these changes Nov 5, 2026
View reviewed changes

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

Looks good! Thanks for the big docs update.

@bitsandfoxes bitsandfoxes mentioned this pull request Nov 13, 2026
Open
1 of 6 tasks
@bitsandfoxes
bitsandfoxes force-pushed the fix/unity-docs-tracing-logs branch from daa193e to d128f6d Compare November 13, 2026 12:23
@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 13, 2026 12:23
@bitsandfoxes
bitsandfoxes force-pushed the fix/unity-docs-tracing-logs branch from d128f6d to 6ef1a69 Compare November 13, 2026 16:05
@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 13, 2026 16:05
@bitsandfoxes
bitsandfoxes force-pushed the fix/unity-docs-tracing-logs branch from 6ef1a69 to 7067697 Compare November 13, 2026 16:33
@bitsandfoxes
bitsandfoxes force-pushed the fix/unity-docs-tracing-logs branch from 7067697 to fa9886c Compare November 13, 2026 22:43
@bitsandfoxes
docs(unity): Fix tracing, logs, metrics and error capture docs
18d9206 
Document event throttling with IThrottler, the automatic game metrics,
the tracing preconditions for automatic instrumentation, and how errors
share traces. Make the session tracking docs Unity-specific, fix the
Unity log method names, and add the Unity user feedback overload.
@bitsandfoxes
docs(unity): Address review of tracing, logs and error capture docs
1d8e19e 
Note that asserts only run in the editor and development builds, add
the Unhandled session status and the cache directory requirement, name
the .NET exception handlers that stay on, and make the throttler sample
key exceptions by stack trace and evict expired entries.
@bitsandfoxes
docs(unity): Tighten throttler sample, Switch sessions and exception …
3f6acee 
…capture wording
@bitsandfoxes
docs(unity): Update user feedback for sentry-unity 4.13.0
8d5cf60
@bitsandfoxes
bitsandfoxes force-pushed the fix/unity-docs-tracing-logs branch from fa9886c to 8d5cf60 Compare November 13, 2026 22:56

This branch was successfully deployed

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

Reviewers

@coolguyzone coolguyzone coolguyzone approved these changes
@JoshuaMoelans JoshuaMoelans JoshuaMoelans approved these changes

Assignees

No one assigned

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@bitsandfoxes @coolguyzone @JoshuaMoelans