Skip to content

docs(logs): Expose Consola and Winston setup instructions - #19792

Open
sansynx wants to merge 1 commit into
getsentry:masterfrom
sansynx:fix/javascript-log-integration-docs
Open

sansynx wants to merge 1 commit into
getsentry:masterfrom
sansynx:fix/javascript-log-integration-docs

Conversation

@sansynx

@sansynx sansynx commented Oct 3, 2026

Copy link
Copy Markdown
Contributor

DESCRIBE YOUR PR

Refs #19755

The shared JavaScript logs page mentions Consola but doesn't render its setup instructions. The existing Winston instructions are also missing from the Node.js and Bun logs pages.

This reuses the existing includes under a Logging Libraries section. Consola is available on the shared page; Winston is limited to Node.js and Bun, whose SDKs export the transport. The separate Next.js page is unchanged. Winston's option headings now sit beneath its integration heading.

This is only the missing-instructions part of #19755. It does not change quickstarts, runtime metrics, or coverage for other server frameworks.

Validation:

  • Compiled the shared page and both includes with @mdx-js/mdx
  • Prettier and git diff --check passed
  • Checked the browser, Node.js, and Bun SDK exports

Keeping this draft until the rendered pages can be checked. Local docs-tree generation on Windows fails with missing parent and grandparent: api, and the dev routes return 404. No successful browser verification or full build is claimed.

AI assistance was used to prepare and check this change.

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

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.

@vercel

vercel Bot commented Oct 3, 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 3, 2026
@sansynx
sansynx marked this pull request as ready for review October 3, 2026 06:15
Copilot AI balanced review requested due to automatic review settings October 3, 2026 06:15

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 3, 2026 06:15
@cursor

cursor Bot commented Oct 3, 2026 •

Copy link
Copy Markdown
Contributor

The plan checks page loads on the changed logs guides. It also checks client errors on those guides. An issue escalates when those pages fail to load or client errors rise.

Services: sentry-docs.

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

Plan

What changed

JavaScript logs pages now render Consola setup steps. Node.js and Bun logs pages also render Winston setup steps. Nested Winston headings drop one level. sentry-docs must deploy before this is live. This change relates to issues/19755.

Risk

A broken include can fail render on every JavaScript logs page. The Winston heading change can break in-page anchors on pages that already include that snippet. Wrong platform matching can hide Winston on Node.js or Bun. It can also show Winston on browser guides.

Intended effect

This is a documentation edit. Telemetry does not show whether the new Consola or Winston blocks render. Page-load volume only shows that the URLs still respond. The executor cannot mark this axis confirmed from Sentry. Treat it as absent only if the logs pages themselves disappear.

Regression watch

Client errors are the symptom-class signal. Traces use a 0.3 sample rate. Error events do not. Do not divide error counts by span counts. Ignore Algolia fetch failures and recaptcha h6 TypeErrors. Those are existing noise.

Signal Baseline Window Source Rule
Client errors on JavaScript platform URLs 0-28 events per 24h 2026-10-02T06:16:12Z to 2026-10-03T06:16:12Z Sentry org sentry project docs. Query environment:production AND url:*/platforms/javascript/* Hold in this band. Escalate if the 24h count rises above 28.
Pageload and navigation duration on JavaScript logs URLs 1340-6890ms p50 to p95. 100 sampled spans. 2026-10-02T06:16:12Z to 2026-10-03T06:16:12Z Sentry org sentry project docs. Query environment:production AND (span.op:pageload OR span.op:navigation) AND http.url:*platforms/javascript* AND http.url:*logs* Hold p95 in this band. Escalate if p95 rises above 6890ms.
Sitewide client errors 0-160 events per 24h 2026-10-02T06:16:12Z to 2026-10-03T06:16:12Z Sentry org sentry project docs. Query environment:production Hold in this band. Escalate if the 24h count rises above 160.
HTTP 5xx on http.server 0 vs not 2026-10-02T06:16:12Z to 2026-10-03T06:16:12Z Sentry org sentry project docs. Query span.op:http.server environment:production http.status_code:>=500 Hold at zero. Escalate if any 5xx appear.

Sampled sitewide pageload and navigation volume was 13200 spans in the same window. Use that volume to judge whether an error rise is traffic, not a new failure.

Not observable

Whether Consola setup HTML appears. Whether Winston setup HTML appears only on Node.js and Bun. LCP and INP metrics returned no values. JavaScript-logs-only error events could not be isolated from other JavaScript platform URLs.

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