Skip to content

docs(nestjs): Fix the verify snippet that exits the app and the start command - #19397

Open
JPeer264 wants to merge 1 commit into
masterfrom
janpeer/sdk-1499-nestjs-getting-started-manual-setup
Open

JPeer264 wants to merge 1 commit into
masterfrom
janpeer/sdk-1499-nestjs-getting-started-manual-setup

Conversation

@JPeer264

Copy link
Copy Markdown
Member

DESCRIBE YOUR PR

closes SDK-1499

Two snippets a new user hits between install and the first event.

The tracing verify snippet threw inside setTimeout(..., 99), so the route answered 200 and sent the span, and the throw then fired outside the Nest pipeline. It was captured as auto.node.onuncaughtexception and the process exited, leaving the app dead after a single request. Throw synchronously inside the span callback instead, so Nest handles the error and the span stays part of the request's trace. The snippet also showed no controller and no Sentry import, so it now shows both.

The ESM start command was a package.json fragment that runs nowhere: "start": "--import ./instrument.mjs nest start" names no node binary and fails with sh: --: invalid option. Lead with NODE_OPTIONS, which reaches the process that ends up running the app, so nest start keeps working, and keep the direct node --import form for running the build output.

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

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

… command

Two snippets a new user hits between install and the first event.

The tracing verify snippet threw inside `setTimeout(..., 99)`, so the
route answered 200 and sent the span, and the throw then fired outside
the Nest pipeline. It was captured as `auto.node.onuncaughtexception`
and the process exited, leaving the app dead after a single request.
Throw synchronously inside the span callback instead, and return it, so
Nest handles the error and the span stays part of the request's trace.
The snippet showed no controller and no `Sentry` import either, so it
now shows both. Rename the span to "My First Test Span", since a span
inside the request trace is what arrives.

The ESM start command was a package.json fragment that runs nowhere:
`"start": "--import ./instrument.mjs nest start"` names no `node` binary
and fails with `sh: --: invalid option`. Lead with `NODE_OPTIONS`, which
reaches the process that ends up running the app, so `nest start` keeps
working. Replace the `npm run start` variant below it with the direct
`node --import ./instrument.mjs dist/main.js`, for running the build
output.

Refs SDK-1499
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@JPeer264
JPeer264 requested review from chargome and msonnb September 14, 2026 11:18
@JPeer264 JPeer264 self-assigned this Sep 14, 2026
@vercel

vercel Bot commented Sep 14, 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 Sep 14, 2026 11:23am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Sep 14, 2026 11:23am UTC

Request Review

@linear-code

linear-code Bot commented Sep 14, 2026

Copy link
Copy Markdown

SDK-1499

@github-actions github-actions Bot added the Priority: Needs Triage The PR description is missing valid priority information label Sep 14, 2026
@github-actions

Copy link
Copy Markdown
Contributor

Please update the IS YOUR CHANGE URGENT? section of the PR description:

  • Select exactly one option.
  • If you selected an urgent or other deadline, provide the date as YYYY-MM-DD.

This information helps the Docs team prioritize your review.

}, 99);
},
);
return Sentry.startSpan(

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

q: Why do we need this, this shuold be instrumented automatically anyway?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Needs Triage The PR description is missing valid priority information

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants