Skip to content

docs(javascript): Recommend integrations in quickstarts - #19889

Open
sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/javascript-quickstart-integrations
Open

sansynx wants to merge 4 commits into
getsentry:masterfrom
sansynx:docs/javascript-quickstart-integrations

Conversation

@sansynx

@sansynx sansynx commented Oct 10, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

The JavaScript quickstarts now recommend console logging and runtime metrics integrations alongside the direct calls used to verify setup. The shared, wizard, and inline guides use the same recommendations, with server-only boundaries for full-stack apps and runtime-specific guidance for Hono. Effect verification uses its configured logger and metrics layer.

Elysia's Bun runtime metrics export requires SDK 11.2.0 or later. Deno keeps console logging and manual logs because its SDK does not export createConsolaReporter. SvelteKit and SolidStart keep manual metrics and omit Pino because their explicit server exports do not include those integrations. Consola and Winston links use the existing rendered Next.js examples; exposing their shared instructions remains in #19792.

Refs #19755

Prepared with AI assistance. Targeted formatting, link linting and MDX compilation passed. The Effect example was also checked with SDK 11.0.0 on Effect 3.19.19 and 4.0.2 using a local test transport. The rendered preview still needs review.

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+

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 10, 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 10, 2026
@sansynx
sansynx marked this pull request as ready for review October 10, 2026 02:47
Copilot AI balanced review requested due to automatic review settings October 10, 2026 02:47

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 10, 2026 02:47
@cursor

cursor Bot commented Oct 10, 2026 •

Copy link
Copy Markdown
Contributor

Getting-started pages now recommend logging and metrics integrations beside the verify snippets. The plan checks those page loads, client errors on that path, and 404s. An issue escalates when client errors rise or those pages return not found.

Services: sentry-docs.

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

Plan

What changed

JavaScript getting-started pages now recommend console logging and runtime metrics integrations. They show those recommendations beside the direct verify calls. Shared includes apply the same copy to wizard, inline, and split-layout guides. Full-stack guides keep Node logging and runtime metrics on the server SDK only.

This change is live after sentry-docs deploys. The Vercel production project sentry-docs maps to that catalog id. develop-docs does not ship this MDX.

Risk

A broken include can fail JavaScript getting-started pages at build or at render. A wrong PlatformSection filter can show Node-only integrations on browser guides. The shared includes reach every JavaScript guide that uses these verify snippets. Client code tabs on those pages can throw if the new nested includes fail.

Intended effect

This change only updates documentation copy. No metric records that the new integration text rendered. Treat intended_effect as unknown. A steady page load count does not prove the copy changed.

Regression watch

Watch the JavaScript guide family, not only the four edited URLs. The shared includes render on those sibling getting-started pages too. Compare against the window 2026-10-09T02:47Z to 2026-10-10T02:47Z in Sentry org sentry project docs, environment production.

Signal Baseline Rule Source
Client errors on /platforms/javascript/ 0-4 events per hour. 25 events in 24h against 8823 page loads, about 0.28% Hold the hourly band. Detected if a complete hour exceeds 4 or the 24h rate rises above 0.8% Errors query environment:production (transaction:*/platforms/javascript/* OR http.url:*/platforms/javascript/*)
docs.page.not_found for requested_path:platforms/javascript Most hours 0-5. 62 events in 24h. One hour reached 28 at 2026-10-09 18:00 UTC Hold the typical 0-5 band. That 28 may be a crawler spike. Detected if several hours stay above 5 Metrics docs.page.not_found with environment:production requested_path:platforms/javascript
HTTP 5xx on /platforms/javascript/ 0 events in 24h Stay at zero Traces for http.server spans with status 5xx on that path
docs.page.load for path:*/platforms/javascript/* Typical hours 45-297. 8823 loads in 24h. Hours 2026-10-10 01:00 and 02:00 UTC reached 2041 and 3242 Hold the typical 45-297 band. Those two hours may be a traffic spike. Detected if a complete hour falls below 45 Metrics docs.page.load with environment:production path:*/platforms/javascript/*

Directly edited getting-started loads in the same window were nextjs 120, react 90, tanstackstart-react 16, and effect 6. If 404s rise, check logs for MDX file not found at runtime, returning 404. That log was 0 in this window.

Not observable

Whether each guide shows the correct integration for its runtime. PlatformSection filters are not in telemetry. Reader follow-through on the new advice is also not in telemetry.

@sansynx

sansynx commented Oct 13, 2026

Copy link
Copy Markdown
Contributor Author

the branch is up to date. could you approve the pending workflows and authorize the Vercel preview when you review this?

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.

2 participants