Repository navigation
How to prevent handleFastifyError.handleFastifyError errors in Sentry? #17119
Description
Problem Statement
In my route handles, I throw Response objects like:
throw Response.json(
{
error: {
code,
details,
id: sentryErrorForeignId,
message,
},
} satisfies ApiErrorResponse,
{
headers,
status,
},
);
It works as expected with Fastify, but the problem is that Sentry is catching these as if they are errors.
I get lots of these issues, like:
handleFastifyError.handleFastifyError
Level: Error
[object Response]
GET /api/gateway/v1/models
with this stack trace:
… es/.pnpm/@sentry+node@9.40.0/node_modules/@sentry/node/src/integrations/tracing/fastify/index.ts in handleFastifyError.handleFastifyError at line 87:5
… es/.pnpm/@sentry+node@9.40.0/node_modules/@sentry/node/src/integrations/tracing/fastify/index.ts in <anonymous> at line 123:24
node:diagnostics_channel in Channel.publish at line 150:9
/srv/node_modules/.pnpm/fastify@5.4.0/node_modules/fastify/lib/wrapThenable.js at line 55:22
node:internal/process/task_queues in process.processTicksAndRejections at line 105:5
I am already returning false from shouldHandleError:
setupFastifyErrorHandler(app, {
shouldHandleError: () => {
// We are handling errors ourselves.
// We are only using `setupFastifyErrorHandler` to setup request isolation context.
return false;
},
});
app.setErrorHandler((error, request, reply) => {
return replyWithErrorPage({ error, origin: 'setErrorHandler', reply });
});
Solution Brainstorm
Come to think about it, this is likely a bug.
Or maybe the ask is that at the moment setupFastifyErrorHandler is overloaded with error handling logic and also logic for starting a context for every request. It would be nice to separate out those two.
Metadata
Metadata
Assignees
Projects
- Status
Activity
linear commentedon Jul 22, 2025
JS-760 How to prevent handleFastifyError.handleFastifyError errors in Sentry?
punkpeye commentedon Jul 22, 2025
Looking at the source code, this should never report. So this is a bug.
sentry-javascript/packages/node/src/integrations/tracing/fastify/index.ts
Lines 86 to 88 in 726c868
punkpeye commentedon Jul 22, 2025
Reading the source code of
@sentry/node/src/integrations/tracing/fastify/index.tsis making me realize that I don't need to addsetupFastifyErrorHandleras it is automatically added by the instrumentation. However, the default instrumentation does not allow to configureshouldHandleError, so it seems I should remove the default integration and add it manually as needed.punkpeye commentedon Jul 22, 2025
Maybe log a warning if user uses
setupFastifyErrorHandlerif there is an existing instrumentation?Lms24 commentedon Jul 22, 2025
This should already be logged out if you have
debug: trueenabled:sentry-javascript/packages/node/src/integrations/tracing/fastify/index.ts
Lines 124 to 127 in 549ca39
This is still true for the moment but we're in the process of merging the PRs to expose
shouldHandleErroron thefastifyIntegrationas an option. Expect this to be released by ~tomorrow.Gonna try to reproduce the original issue, will report back
kblcuk commentedon Jul 29, 2025
@Lms24 any update on this? At least release that happened 20 hours ago didn't seem to have anything related to this issue.
6 remaining items
Lms24 commentedon Jul 29, 2025
No worries, I realize we should have announced the release in this thread. Usually, we have automations for stuff like this but they didn't work correctly in this issue.
Lms24 commentedon Jul 29, 2025
@punkpeye given 9.41.0 is this issue still relevant from your end?
We do log warnings now if we encounter
setupFastifyErrorHandlerusage, see:sentry-javascript/packages/node/src/integrations/tracing/fastify/index.ts
Lines 124 to 128 in e3376ee
Let me know if we should keep the issue open, otherwise it'll be closed. Thanks!
punkpeye commentedon Jul 29, 2025
Personally, I am unblocked. Thank you