ref(nestjs): Add `mechanism` to captured errors #17312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

Lms24 merged 3 commits into develop from lms/ref-nestjs-mechanism

Sep 5, 2025

Merged

ref(nestjs): Add `mechanism` to captured errors #17312

Lms24 merged 3 commits into develop from lms/ref-nestjs-mechanism

Sep 5, 2025

Conversation

Lms24

Copy link

Member

@Lms24 Lms24 commented Aug 4, 2025 •

edited

Loading

The NestJS SDK didn't add a mechanism to a bunch of caught errors. This resulted in the errors being incorrectly marked as handled: true and the mechansim.type defaulting to 'generic'.

This PR:

adds the mechanism to all captureException calls within the SDK, marking caught exceptions as handled: false
- reviewers: Please let me know if any of these should in fact be handled: true!
adds a specific mechanism.type, following the naming scheme of trace origin
adjusts and adds test assertions so that we actually test on the expected mechanism

I noticed that we have some startSpan calls in the SDK that don't include a sentry.origin attribute. I'll open a follow-up PR to fix this separately.

ref #17212
closes #17259

@Lms24 Lms24 marked this pull request as draft

August 4, 2025 15:24

Lms24

Lms24 commented

Aug 5, 2025

View reviewed changes

packages/nestjs/src/decorators.ts

@@ -19,12 +19,12 @@ export const SentryCron = (monitorSlug: string, monitorConfig?: MonitorConfig):

try {

result = originalMethod.apply(this, args);

} catch (e) {

captureException(e);

captureException(e, { mechanism: { handled: false, type: 'auto.cron.nestjs' } });

Copy link

Member Author

@Lms24 Lms24 Aug 5, 2025 •

edited

Loading

Choose a reason for hiding this comment

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

(auto.)cron is not a listed category, which is a bit suboptimal. The two alternatives are:

function given we wrap some kind of cron-executed function
omitting the category, since it's not required: auto.nestjs.sentry_cron

@AbhiPrasad thoughts?

Copy link

Member Author

@Lms24 Lms24 Aug 5, 2025

Choose a reason for hiding this comment

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

worth noting: I didn't find a specific span that reliably applies here, so there's no direct span counterpart to this mechanism.type

Copy link

Member

@AbhiPrasad AbhiPrasad Aug 5, 2025

Choose a reason for hiding this comment

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

let's do auto.function.X

packages/nestjs/src/decorators.ts

@@ -77,7 +77,7 @@ export function SentryExceptionCaptured() {

return originalCatch.apply(this, [exception, host, ...args]);

}

captureException(exception);

captureException(exception, { mechanism: { handled: false, type: 'auto.function.nestjs.exception_captured' } });

Copy link

Member Author

@Lms24 Lms24 Aug 5, 2025

Choose a reason for hiding this comment

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

I think auto.function.* is correct here, given this decorator can be applied to any arbitrary function.

@Lms24 Lms24 self-assigned this

Aug 5, 2025

@Lms24 Lms24 marked this pull request as ready for review

August 5, 2025 08:36

@Lms24 Lms24 requested review from chargome and AbhiPrasad

August 5, 2025 08:36

chargome

chargome approved these changes

Aug 5, 2025

View reviewed changes

Copy link

Member

@chargome chargome left a comment

Choose a reason for hiding this comment

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

Looks good, thanks!

@Lms24 Lms24 mentioned this pull request

Aug 5, 2025

fix(nestjs): Add missing sentry.origin span attribute to SentryTraced decorator #17318

Merged

Lms24 added 3 commits

September 5, 2025 16:08

@Lms24


 ref(nestjs): Add mechanism to captured errors

a411659

@Lms24


 use trace origin naming scheme, adjust tests

ff2d3ce

@Lms24


 annotate more captureException calls, add a bunch of test assertions

a99673b

@Lms24 Lms24 force-pushed the lms/ref-nestjs-mechanism branch from 638238a to a99673b Compare

September 5, 2025 14:08

@Lms24 Lms24 merged commit af69b45 into develop

Sep 5, 2025

163 checks passed

@Lms24 Lms24 deleted the lms/ref-nestjs-mechanism branch

September 5, 2025 14:55

Labels

None yet

3 participants

@Lms24 @AbhiPrasad @chargome

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

ref(nestjs): Add `mechanism` to captured errors #17312

ref(nestjs): Add `mechanism` to captured errors #17312

Uh oh!

Conversation

@Lms24 Lms24 commented Aug 4, 2025 •

edited

Loading

Uh oh!

Uh oh!

@Lms24 Lms24 Aug 5, 2025 •

edited

Loading

Uh oh!

Choose a reason for hiding this comment

Uh oh!

@Lms24 Lms24 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

@AbhiPrasad AbhiPrasad Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

@Lms24 Lms24 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

@chargome chargome left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ref(nestjs): Add mechanism to captured errors #17312

ref(nestjs): Add mechanism to captured errors #17312

Uh oh!

Conversation

@Lms24 Lms24 commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

@Lms24 Lms24 Aug 5, 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!

@Lms24 Lms24 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

@AbhiPrasad AbhiPrasad Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

@Lms24 Lms24 Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

@chargome chargome left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ref(nestjs): Add `mechanism` to captured errors #17312

ref(nestjs): Add `mechanism` to captured errors #17312

@Lms24 Lms24 commented Aug 4, 2025 •

edited

Loading

@Lms24 Lms24 Aug 5, 2025 •

edited

Loading