Skip to content

feat(docs): Apply new quick start template to Unreal Engine quick start guide - #20013

Merged
sfanahata merged 3 commits into
masterfrom
docs/quickstart-template-unreal
Oct 27, 2026
Merged

sfanahata merged 3 commits into
masterfrom
docs/quickstart-template-unreal

Conversation

@sentry-junior

@sentry-junior sentry-junior Bot commented Oct 15, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Applies the quick start template from #19295 (Ember) to the Unreal Engine quick start (docs/platforms/unreal/index.mdx), single-column.

  • Configure names Error Monitoring (with automatic crash capture), Release Health, Tracing (manual instrumentation), Logs and Application Metrics. Session Replay (experimental, UE 5.4+, no masking) and User Feedback are named and linked but not turned on. Profiling and Crons aren't supported and are left out.
  • The setup snippet uses Config/DefaultEngine.ini (what Project Settings > Plugins > Sentry writes) and includes all options by default, with a note that unwanted ones can be removed.
  • Tracing sets both EnableTracing=True and TracesSampleRate. The SDK ignores the sample rate unless EnableTracing is on; the current Unreal tracing docs only show TracesSampleRate.
  • Logs and Application Metrics: new steps; both on by default from SDK 1.11.0.
  • Crash reporter setup, debug symbol upload and minidump storage moved into Configure. The shared store-minidumps-as-attachments-* includes are no longer used on this page but are unchanged.
  • Simplifies Verify to a single test message.

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+

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

via shannon.anahata.

--

View Junior Session [Sentry]

…rt guide

Co-Authored-By: Shannon Anahata <shannon.anahata@sentry.io>
@vercel

vercel Bot commented Oct 15, 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 Oct 27, 2026 8:09pm UTC
sentry-docs Ready Ready Preview Oct 27, 2026 8:09pm UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 15, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 15, 2026 21:12
@cursor

cursor Bot commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks loads of the changed page, page failure rate, and client errors. An issue escalates when those loads drop or new errors appear. The new page text is not in telemetry.

Rollout complete

Services: sentry-docs.

Plan

What changed

Requests to /platforms/unreal/ now render the new quick-start template. Configure now states Error Monitoring, Release Health, Tracing, Logs, and Application Metrics. The page adds Send Logs, Send Application Metrics, and Verify Your Setup. Session Replay and User Feedback stay linked and are not set in the snippet. This change is live after a sentry-docs production deploy. The pick matches the Vercel project sentry-docs and the Next.js Sentry project docs. The runtime application key is sentry-docs.

Risk

A build or MDX fault can hide this page or throw in the browser. Broken in-page links can 404 child Unreal guides. The snippet now turns on tracing, PII, and crash screenshots. Users who copy it can send extra data. Site telemetry cannot show that user outcome.

Intended effect

The new headings are not queryable. Treat continued pageload and navigation spans on this path as the live proxy. absent means those spans stay near zero after deploy while other pages still load. Client traces use a 30% sample rate. Volume may vary by weekday.

Signal Baseline Window Source Rule
Sampled pageload plus navigation on /platforms/unreal/ 30-40 events per 24h 2026-10-13T21:13:00Z to 2026-10-15T21:13:00Z. Last 24h was 30. Prior 24h was 40. Sentry org sentry project docs. Query span.op:[pageload,navigation] url.path:"/platforms/unreal/" environment:production Hold in this band. absent if the count falls near 0.

Regression watch

A fault in this MDX file can fail the page, throw in the browser, or 404 child Unreal guides. Pageload p95 on this path is noisy at this volume.

Signal Baseline Window Source Rule
Pageload and navigation failure rate on /platforms/unreal/ 0% 2026-10-13T21:13:00Z to 2026-10-15T21:13:00Z. Last 24h was 0%. Prior 24h was 0%. Sentry org sentry project docs. Query span.op:[pageload,navigation] url.path:"/platforms/unreal/" environment:production with failure_rate() Hold at 0.
Client errors on Unreal docs URLs 0-1 events per 48h. The only title was TypeError: Failed to fetch (insights.algolia.io). 2026-10-13T21:13:00Z to 2026-10-15T21:13:00Z Sentry org sentry project docs. Query environment:production (http.url:"*/platforms/unreal/*" OR url:"*/platforms/unreal/*") Hold in this band. Escalate on a new title or a rise above 1 per 24h.
Pageload p95 on /platforms/unreal/ 5170-5650ms 2026-10-13T21:13:00Z to 2026-10-15T21:13:00Z. Last 24h was 5171ms. 48h pooled was 5654ms. Sentry org sentry project docs. Query span.op:pageload url.path:"/platforms/unreal/" environment:production with p95(span.duration) Hold in this band. Escalate if p95 rises far above it.
4xx and 5xx spans under /platforms/unreal/ 0 2026-10-13T21:13:00Z to 2026-10-15T21:13:00Z Sentry org sentry project docs. Query environment:production url.path:"/platforms/unreal/*" http.response_status_code:>=400 Hold at 0.

Not observable

The new template text is not in telemetry. LCP for this path returned no values. HTTP status is null on pageload, navigation, and middleware spans for the index path. A 24h error query timed out. Use the 48h error row. Extra data that users send after they copy the snippet is not in this site project.

@tustanivsky tustanivsky left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@sfanahata
sfanahata merged commit c14d654 into master Oct 27, 2026
28 checks passed
@sfanahata
sfanahata deleted the docs/quickstart-template-unreal branch October 27, 2026 20:21
@cursor

cursor Bot commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

Verified in production

  • The Unreal docs page loaded on the new build.

This branch was successfully deployed

2 active deployments
Preview – sentry-docs — 912f794d Deployed Oct 27, 2026 by vercel[bot]
Preview – develop-docs — 912f794d Deployed Oct 27, 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