docs(js): Review and update Nest.js Quick Start guide #13497

inventarSarah · 2025-04-24T10:03:53Z

DESCRIBE YOUR PR

The Nest.js quick start guide already looked great -> I added and removed some content to be more consistent with our other guides.

I tried to streamline the CommonJS section, as we already have the details on this page (I added a link to the page). Plus, the content seemed too detailed for a Quick Start guide IMO.
Naturally, if you say the info I removed is vital for the QS guide, we can add it back in.

Additionally, I expanded the "Verify Your Setup" section so the example provided is like our Node.js one.

Closes: #13498

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

Urgent deadline (GA date, etc.):
Other deadline:
None: 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 added an urgent due date to it.
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

EXTRA RESOURCES

Sentry Docs contributor guide

vercel · 2025-04-24T10:03:57Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
sentry-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 15, 2025 0:26am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		May 15, 2025 0:26am
develop-docs	⬜️ Ignored (Inspect)	Visit Preview		May 15, 2025 0:26am

inventarSarah · 2025-04-24T10:15:22Z

platform-includes/getting-started-use/javascript.nestjs.mdx

@@ -33,28 +33,15 @@ import { AppService } from "./app.service";
 export class AppModule {}
 ```

-If you're using a global catch-all exception filter (which is either a filter registered with `app.useGlobalFilters()` or a filter registered in your app module providers annotated with a `@Catch()` decorator without arguments), add a `@SentryExceptionCaptured()` decorator to the filter's `catch()` method.
-This decorator will report all unexpected errors that are received by your global error filter to Sentry:
+By default, only unhandled exceptions that are not caught by an error filter are reported to Sentry. Additionally, `HttpException`s (including [derivatives](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)) are not captured automatically as they mostly act as control flow vehicles.


Here we start with the Error Capturing topic.
I was wondering if it would make sense to not have this in "Apply Instrumentation to Your App" and instead put it in a dedicated section, "Step x: Capture Nest.js Errors" -> similar to how we have it for React .

But then this only seems to be documented for CJS - I was wondering why we don't have this documented for ESM? Or is this not needed/possible?

I don't see this as part of this PR -- we can address in a future issue/PR.

I was wondering if it would make sense to not have this in "Apply Instrumentation to Your App" and instead put it in a dedicated section, "Step x: Capture Nest.js Errors"

This sounds reasonable to me!

But then this only seems to be documented for CJS - I was wondering why we don't have this documented for ESM? Or is this not needed/possible?

I think this should be the same for CJS and ESM. Or IOW, the filters require should be applied in the same way regardless of ESM/CJS

I don't see this as part of this PR -- we can address in a future issue/PR.

that also sounds reasonable :D

Lms24

This looks good but I think we need to sort out some things:

h: we can't include nestjs specific code and instructions in the shared commonjs page
m: we should avoid linking to commonJS for the exception filter explanation (or IOW think about where we put this and then link there if applicable)

1 we need to solve in this PR, 2 we can also address in a follow-up.

Lms24 · 2025-04-25T08:26:29Z

docs/platforms/javascript/common/install/commonjs.mdx

For NestJS-CommmonJS specifically, I don't think we should show ESM/CJS tabs here because later on we instruct users to import "./instrument". Since Nest ships with TS, we can simply let users create an instrument.ts file. (cc @chargome - let me know if I'm missing something or this sounds unreasonable to you)

I'm realizing that this is a common guide for various node platforms but it's quite confusing for NestJS I'd argue. So maybe it makes sense to create a Nest-specific version of it 🤔 In general, for the common guide, I don't think we should even show the ESM tab on the CommonJS installation page :)

also please see my other comment about nestjs-specific code in this page

Yeah sounds reasonable to just use a ts file here 👍

docs/platforms/javascript/common/install/commonjs.mdx

platform-includes/getting-started-use/javascript.nestjs.mdx

Lms24 · 2025-04-25T08:58:34Z

platform-includes/getting-started-use/javascript.nestjs.mdx

-  }
-}
-```
+For more precise control over error reporting in global catch-all exception filters, specific exception filters, or microservices, check out our [CommonJS installation documentation](/platforms/javascript/guides/nestjs/install/commonjs/).


m: I don't think we should link to the CJS guide for this. Either we find a place for it here, or we do something like we have in Angular or React where we explain the intricacies of the filters in a "NestJS Features -> Exception Filters" page. wdyt?

platform-includes/getting-started-verify/javascript.nestjs.mdx

…ick-start/review-nestjs

codecov · 2025-04-28T08:24:32Z

Bundle Report

Changes will increase total bundle size by 240 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
sentry-docs-server-cjs	11.2MB	246 bytes (0.0%) ⬆️
sentry-docs-client-array-push	9.51MB	-6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`1729.js`	-3 bytes	1.75MB	-0.0%
`../instrumentation.js`	-3 bytes	1.08MB	-0.0%
`9523.js`	-3 bytes	1.05MB	-0.0%
`../app/[[...path]]/page.js.nft.json`	85 bytes	396.51kB	0.02%
`../app/platform-redirect/page.js.nft.json`	85 bytes	396.43kB	0.02%
`../app/sitemap.xml/route.js.nft.json`	85 bytes	394.4kB	0.02%

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`static/chunks/pages/_app-*.js`	-3 bytes	868.7kB	-0.0%
`static/chunks/8165-*.js`	-3 bytes	410.1kB	-0.0%
`static/A6KS4ZhyNgqH41R14Mfav/_buildManifest.js` (New)	578 bytes	578 bytes	100.0% 🚀
`static/A6KS4ZhyNgqH41R14Mfav/_ssgManifest.js` (New)	77 bytes	77 bytes	100.0% 🚀
~~`static/XNLYCqEJQahnoiFGvzySl/_buildManifest.js`~~ (Deleted)	-578 bytes	0 bytes	-100.0% 🗑️
~~`static/XNLYCqEJQahnoiFGvzySl/_ssgManifest.js`~~ (Deleted)	-77 bytes	0 bytes	-100.0% 🗑️

inventarSarah · 2025-04-28T09:02:38Z

Thanks @Lms24 !

h: we can't include nestjs specific code and instructions in the shared commonjs page

m: we should avoid linking to commonJS for the exception filter explanation (or IOW think about where we put this and then link there if applicable)

I restored the previous content of the commonjs and getting-started-use/nestjs pages. So, now the Nest.js specific info shouldn't surface on other platforms anymore -- lmk if I missed something 🙏 (I think this is the most complex structure I've worked with so far :D)

This way, we can keep this PR focused and small and tackle other issues in a new PR. -> I already created an issue here #13525
Please review and comment if you have any suggestions.

Lms24

Thanks for making the changes and for creating the follow-up issue.

platform-includes/getting-started-use/javascript.nestjs.mdx

Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>

platform-includes/getting-started-verify/javascript.nestjs.mdx

…ick-start/review-nestjs

inventarSarah · 2025-05-06T11:53:42Z

New updates in this PR, @chargome @Lms24

guide no longer inherits content from getting-started-node
updated code snippets to Typescript (remove ESM tabs)
created new step "Capturing Nest.js Errors" and moved content about exception filters there
created a new include file for the exception filter content so I could use it in the quick start guide and the CommonJS page -> once the CommonJS page is updated, we can use the content from the include file directly in the QS guide and delete the include file
removed "ESM" subsection in "Configure"

chargome · 2025-05-06T12:15:13Z

platform-includes/getting-started-capture-errors/javascript.nestjs.mdx

+
+To make sure Sentry captures all your app's errors, configure error handling based on how your application manages exceptions:
+
+### Using a Global Catch-All Exception Filter


This I would rather name something like "using a custom global filter" – and update the section below accordingly

Updated the subheading to

Using a Custom Global Filter
and
Not Using a Custom Global Filter

chargome · 2025-05-06T12:16:51Z

platform-includes/getting-started-use/javascript.nestjs.mdx

@@ -14,9 +16,9 @@ async function bootstrap() {
 bootstrap();
 ```

-Afterwards, add the `SentryModule` as a root module to your main module:
+Afterward, add the `SentryModule` as a root module to your main module:


Suggested change

Afterward, add the `SentryModule` as a root module to your main module:

Afterwards, add the `SentryModule` as a root module to your main module:

I think? 😅

Both forms are correct, although the variant with “s” is used in British English and the one without in American English 👍

…ick-start/review-nestjs

chargome

@inventarSarah just realized that we have the global error filter sections now twice in the guide!

…ick-start/review-nestjs

inventarSarah · 2025-05-15T08:53:30Z

@inventarSarah just realized that we have the global error filter sections now twice in the guide!

Fixed -> things got crazy with the includes!

Quick Start guide and CommonJS installation method page (which used the same includes) look okay to me now

chargome · 2025-05-15T11:18:12Z

seems to be stuck, can you re-trigger a deployment?

…ick-start/review-nestjs

inventarSarah · 2025-05-15T12:30:40Z

seems to be stuck, can you re-trigger a deployment?
@chargome now everything has worked out

Lms24

All good from my end, will let @chargome give the final approval :)

review and update Nest.js Quick Start guide

5427ba1

vercel bot deployed to Preview – sentry-docs April 24, 2025 10:09 View deployment

inventarSarah commented Apr 24, 2025

View reviewed changes

inventarSarah requested review from chargome, lforst and Lms24 April 24, 2025 10:17

inventarSarah marked this pull request as ready for review April 24, 2025 10:18

Lms24 requested changes Apr 25, 2025

View reviewed changes

inventarSarah added 2 commits April 28, 2025 09:11

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

90ab40a

…ick-start/review-nestjs

PR feedback

bb448d1

vercel bot deployed to Preview – sentry-docs April 28, 2025 08:34 View deployment

inventarSarah mentioned this pull request Apr 28, 2025

Nest.js: Rework installation method & exception filter documentation #13525

Open

inventarSarah requested review from Lms24 and coolguyzone April 28, 2025 09:03

Lms24 approved these changes Apr 29, 2025

View reviewed changes

platform-includes/getting-started-use/javascript.nestjs.mdx Outdated Show resolved Hide resolved

Update platform-includes/getting-started-use/javascript.nestjs.mdx

352fc65

Co-authored-by: Lukas Stracke <lukas.stracke@sentry.io>

vercel bot deployed to Preview – sentry-docs May 6, 2025 06:49 View deployment

chargome reviewed May 6, 2025

View reviewed changes

platform-includes/getting-started-verify/javascript.nestjs.mdx Outdated Show resolved Hide resolved

inventarSarah added 2 commits May 6, 2025 11:04

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

3c54163

…ick-start/review-nestjs

update guide to TS and create new step for Error Capturing

bd7fea7

vercel bot deployed to Preview – sentry-docs May 6, 2025 11:34 View deployment

create and use new platform include for capturing error content

17472be

vercel bot deployed to Preview – sentry-docs May 6, 2025 12:06 View deployment

chargome approved these changes May 6, 2025

View reviewed changes

inventarSarah requested a review from Lms24 May 7, 2025 06:42

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

3995e01

…ick-start/review-nestjs

pr feedback - rewrite subheadings

d443895

vercel bot deployed to Preview – sentry-docs May 8, 2025 06:35 View deployment

chargome requested changes May 15, 2025

View reviewed changes

inventarSarah added 2 commits May 15, 2025 10:01

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

59e2357

…ick-start/review-nestjs

remove duplicate includes

6e33498

Merge branch 'master' of github.com:getsentry/sentry-docs into smi/qu…

8f78185

…ick-start/review-nestjs

vercel bot deployed to Preview – sentry-docs May 15, 2025 12:26 View deployment

Lms24 approved these changes May 19, 2025

View reviewed changes

chargome approved these changes May 19, 2025

View reviewed changes

inventarSarah merged commit 2c6b6a3 into master May 20, 2025
13 checks passed

inventarSarah deleted the smi/quick-start/review-nestjs branch May 20, 2025 09:08


		To make sure Sentry captures all your app's errors, configure error handling based on how your application manages exceptions:

		### Using a Global Catch-All Exception Filter

	Afterward, add the `SentryModule` as a root module to your main module:
	Afterwards, add the `SentryModule` as a root module to your main module:

Uh oh!

docs(js): Review and update Nest.js Quick Start guide #13497

docs(js): Review and update Nest.js Quick Start guide #13497

Uh oh!

Conversation

inventarSarah commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIBE YOUR PR

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

EXTRA RESOURCES

Uh oh!

vercel bot commented Apr 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lms24 left a comment

Choose a reason for hiding this comment

Uh oh!

Lms24 Apr 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Apr 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

Assets Changed:

Uh oh!

inventarSarah commented Apr 28, 2025

Uh oh!

Lms24 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

inventarSarah commented May 6, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chargome left a comment

Choose a reason for hiding this comment

Uh oh!

inventarSarah commented May 15, 2025

Uh oh!

chargome commented May 15, 2025

Uh oh!

inventarSarah commented May 15, 2025

Uh oh!

Lms24 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

inventarSarah commented Apr 24, 2025 •

edited

Loading

vercel bot commented Apr 24, 2025 •

edited

Loading

Lms24 Apr 25, 2025 •

edited

Loading

codecov bot commented Apr 28, 2025 •

edited

Loading