feat(node): Migrate to `@fastify/otel` #15542

onurtemizkan · 2025-02-28T15:11:56Z

Resolves: #15130

Example events:

fastify 3 - Link
fastify 4 - Link
fastify 5 - Link
nestjs with fastify 4 Link

AbhiPrasad · 2025-02-28T15:21:34Z

packages/node/package.json

@@ -101,7 +101,8 @@
    "import-in-the-middle": "^1.13.0"
  },
  "devDependencies": {
-    "@types/node": "^18.19.1"
+    "@types/node": "^18.19.1",
+    "fastify": "4.18.0"


Can we avoid this and just vendor in the minimal interface we need to satisfy the types?

github-actions · 2025-02-28T15:26:50Z

size-limit report 📦

Path	Size	% Change	Change
@sentry/browser	23.28 KB	-	-
@sentry/browser - with treeshaking flags	23.12 KB	-	-
@sentry/browser (incl. Tracing)	36.99 KB	-	-
@sentry/browser (incl. Tracing, Replay)	74.17 KB	-	-
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	67.55 KB	-	-
@sentry/browser (incl. Tracing, Replay with Canvas)	78.83 KB	-	-
@sentry/browser (incl. Tracing, Replay, Feedback)	90.65 KB	-	-
@sentry/browser (incl. Feedback)	39.68 KB	-	-
@sentry/browser (incl. sendFeedback)	27.9 KB	-	-
@sentry/browser (incl. FeedbackAsync)	32.67 KB	-	-
@sentry/react	25.09 KB	-	-
@sentry/react (incl. Tracing)	38.91 KB	-	-
@sentry/vue	27.51 KB	-	-
@sentry/vue (incl. Tracing)	38.71 KB	-	-
@sentry/svelte	23.32 KB	-	-
CDN Bundle	24.51 KB	-	-
CDN Bundle (incl. Tracing)	36.98 KB	-	-
CDN Bundle (incl. Tracing, Replay)	72.03 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback)	77.18 KB	-	-
CDN Bundle - uncompressed	71.47 KB	-	-
CDN Bundle (incl. Tracing) - uncompressed	109.34 KB	-	-
CDN Bundle (incl. Tracing, Replay) - uncompressed	220.63 KB	-	-
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	233.16 KB	-	-
@sentry/nextjs (client)	40.53 KB	-	-
@sentry/sveltekit (client)	37.44 KB	-	-
@sentry/node	150.83 KB	+5.2%	+7.45 KB 🔺
@sentry/node - without tracing	96.52 KB	-	-
@sentry/aws-serverless	120.84 KB	+0.01%	+8 B 🔺

View base workflow run

AbhiPrasad · 2025-03-20T15:59:10Z

packages/node/src/integrations/tracing/fastify-v3/enums/AttributeNames.ts

@@ -0,0 +1,32 @@
+/*


For the files we vendored in from OTEL, we should also link to the git sha we used of the versioned files.

andreiborza

Great job! This is looking nice.

andreiborza · 2025-03-31T22:10:08Z

packages/node/package.json

@@ -65,6 +65,7 @@
    "access": "public"
  },
  "dependencies": {
+    "@fastify/otel": "0.5.0",


l: We can bump to 0.5.1

andreiborza · 2025-03-31T22:13:10Z

packages/node/src/integrations/tracing/fastify/index.ts

+// /**
+//  * Minimal request type containing properties around route information.
+//  * Works for Fastify 3, 4 and presumably 5.
+//  *
+//  * Based on https://github.com/fastify/fastify/blob/ce3811f5f718be278bbcd4392c615d64230065a6/types/request.d.ts
+//  */
+// // eslint-disable-next-line @typescript-eslint/no-explicit-any
+// interface MinimalFastifyRequest extends Record<string, any> {
+//   method?: string;
+//   // since fastify@4.10.0
+//   routeOptions?: {
+//     url?: string;
+//   };
+//   routerPath?: string;
+// }
+
+// /**
+//  * Minimal reply type containing properties needed for error handling.
+//  *
+//  * Based on https://github.com/fastify/fastify/blob/ce3811f5f718be278bbcd4392c615d64230065a6/types/reply.d.ts
+//  */
+// // eslint-disable-next-line @typescript-eslint/no-explicit-any
+// interface MinimalFastifyReply extends Record<string, any> {
+//   statusCode: number;
+// }
+
+// // We inline the types we care about here
+// interface Fastify {
+//   // eslint-disable-next-line @typescript-eslint/no-explicit-any
+//   version: string;
+//   register: (plugin: any) => Fastify;
+//   after: (listener?: (err: Error) => void) => Fastify;
+//   addHook: (name: string, handler: (...params: unknown[]) => void) => Fastify;
+// }


l: Do we want to keep this around?

packages/node/src/integrations/tracing/fastify/index.ts

onurtemizkan · 2025-04-03T14:56:57Z

@andreiborza - I updated the PR. Waiting for fastify/otel#35 to be released.

mydea · 2025-04-08T07:31:25Z

I would assume this also closes #12844?

andreiborza · 2025-04-14T02:23:16Z

@andreiborza - I updated the PR. Waiting for fastify/otel#35 to be released.

looks like it's been released with 0.5.2 🚀

Make sure to update the lock file when you bump.

onurtemizkan · 2025-04-14T14:34:49Z

@andreiborza, @mydea. I bumped the version. I think it's ready to go now.

onurtemizkan · 2025-04-15T09:38:54Z

I would assume this also closes #12844?

Yes, that should resolve it as well

mydea · 2025-04-15T09:51:13Z

dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/transactions.test.ts

-          data: {
-            'sentry.origin': 'manual',
-            'fastify.type': 'middleware',
-            'plugin.name': 'fastify -> @fastify/middie',


do we have no more plugin/middleware spans like this anymore? Is this "OK"?

Checked again after the updates. We still have the middie spans, I added them back to the tests. But the problem is now that we don't have access to the requestHook anymore, the spans are not formatted correctly in NestJS applications (when setupFastifyErrorHandler is not used). We attempt using addFastifySpanAttributes inside setupFastifyErrorHandler.

I'm now trying to use diagnosticsChannel for it. Maybe we can reach the context from it

can we try to PR something like the requestHook to the otel instrumentation, maybe? Or is this something they do not want?

@mydea, they released a way to reach the spans: https://github.com/fastify/otel/releases/tag/v0.6.0

The problem is that with this release, they removed the vendored types we added previously. Adding fastify here as a devDependency works for TypeScript 5, but not in previous versions. Should we make this an exception for TS-3.8 support/tests?

they removed the vendored types

what do you mean, can we not replicate this anymore? 😢

Unfortunately, yes: https://github.com/fastify/otel/pull/46/files#diff-7aa4473ede4abd9ec099e87fec67fd57afafaf39e05d493ab4533acc38547eb8

Had to remove the previously vendored types due to conflicts with interface augmentation typical in fastify plugins.

@mydea - Looks like they have overridden the types of fastify. So, it works now without adding fastify as a dependency. Please bear with me when I generate sample events and post links.

mydea · 2025-04-15T09:51:58Z

@onurtemizkan could you maybe share a link of one or two example transactions captured to Sentry with the new version, to compare with the old version? that would be great 🙏

onurtemizkan · 2025-04-22T12:15:53Z

@onurtemizkan could you maybe share a link of one or two example transactions captured to Sentry with the new version, to compare with the old version? that would be great 🙏

@mydea - Updated the PR description with event links

mydea · 2025-04-23T07:27:25Z

packages/node/src/integrations/tracing/fastify/index.ts

+  });
+
+  // Returning this as any not to deal with the internal types of the FastifyOtelInstrumentation
+  return fastifyOtelInstrumentationInstance as any;


l: Can we return this as unknown or something like this, to avoid users using this in weird ways? Pretty theoretical probably, but to be safe... or if unknown does not work, return a minimal type that is accepted?

mydea · 2025-04-23T07:29:17Z

packages/node/src/integrations/tracing/fastify/index.ts

+  const fastifyOtelInstrumentationInstance = new FastifyOtelInstrumentation();
+  const plugin = fastifyOtelInstrumentationInstance.plugin();
+
+  // This message handler works for Fastify versions 3, 4 and 5


this also works for fastify 3? I thought only 4+5?

mydea

some small notes but overall looking good!
To clarify, this does not remove the need to call setupFastifyErrorHandler yet, right?

onurtemizkan force-pushed the onur/fastify-otel-migration branch 2 times, most recently from 38047fd to 6c347ee Compare February 28, 2025 15:20

AbhiPrasad reviewed Feb 28, 2025

View reviewed changes

onurtemizkan force-pushed the onur/fastify-otel-migration branch 2 times, most recently from 88d946e to 112c80a Compare March 5, 2025 18:27

onurtemizkan marked this pull request as ready for review March 5, 2025 18:33

onurtemizkan requested review from AbhiPrasad and andreiborza March 5, 2025 18:42

andreiborza self-assigned this Mar 10, 2025

AbhiPrasad reviewed Mar 20, 2025

View reviewed changes

onurtemizkan force-pushed the onur/fastify-otel-migration branch 4 times, most recently from ad52eb9 to 9ca14db Compare March 26, 2025 15:50

onurtemizkan mentioned this pull request Mar 26, 2025

Types from fastify devDependency should not be imported in index.d.ts fastify/otel#32

Closed

2 tasks

andreiborza approved these changes Mar 31, 2025

View reviewed changes

onurtemizkan requested review from a team as code owners April 3, 2025 14:40

onurtemizkan force-pushed the onur/fastify-otel-migration branch 2 times, most recently from 2bd1c74 to 0308803 Compare April 3, 2025 14:54

andreiborza approved these changes Apr 14, 2025

View reviewed changes

onurtemizkan force-pushed the onur/fastify-otel-migration branch 2 times, most recently from bd5f0ab to b1847dc Compare April 14, 2025 10:24

onurtemizkan added 3 commits April 14, 2025 15:23

feat(node): Migrate to @fastify/otel

7905b7c

Inline fastify types

e1b4e69

Use default FastifyOtelInstrumentation export

47836c3

onurtemizkan added 7 commits April 14, 2025 15:23

Fix formatting

08cf29b

Deduplicate deps

583c9d8

Reset lockfile

66c5e16

Use skipLibCheck in e2e tests

641629c

Address review comments

125e675

Bump @fastify/otel to 0.5.2

097060c

Dedupe deps

275a14d

onurtemizkan force-pushed the onur/fastify-otel-migration branch from b1847dc to 275a14d Compare April 14, 2025 14:23

Reset lockfile

964cf0c

onurtemizkan force-pushed the onur/fastify-otel-migration branch from 43c201f to 964cf0c Compare April 14, 2025 20:31

mydea reviewed Apr 15, 2025

View reviewed changes

Add middie spans back to e2e tests

8ff5f09

onurtemizkan force-pushed the onur/fastify-otel-migration branch from 5329aaa to 8ff5f09 Compare April 15, 2025 10:48

onurtemizkan and others added 9 commits April 18, 2025 18:30

Realign spans between versions

d429cdd

Bump Fastify 5 versions to 5.3.1

12cfd91

Set fastify as external

84e8591

Dedupe deps

bf9af14

Try when fastify is imported as a type on @fastify/otel

c7782e5

Merge branch 'develop' into onur/fastify-otel-migration

c3c8dda

Bump @fastify/otel to 0.6.0

1d0732d

Bump fastify of E2E test

5d66586

Merge branch 'develop' into onur/fastify-otel-migration

b5a489f

mydea reviewed Apr 23, 2025

View reviewed changes

mydea approved these changes Apr 23, 2025

View reviewed changes

mydea mentioned this pull request Apr 23, 2025

fix(node): Remove deprecated routerPath warning of fastify request object #13043

Closed

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(node): Migrate to `@fastify/otel` #15542

feat(node): Migrate to `@fastify/otel` #15542

onurtemizkan commented Feb 28, 2025 •

edited

Loading

AbhiPrasad Feb 28, 2025

onurtemizkan Feb 28, 2025

github-actions bot commented Feb 28, 2025 •

edited

Loading

AbhiPrasad Mar 20, 2025

andreiborza left a comment

andreiborza Mar 31, 2025

andreiborza Mar 31, 2025

onurtemizkan commented Apr 3, 2025

mydea commented Apr 8, 2025

andreiborza commented Apr 14, 2025 •

edited

Loading

onurtemizkan commented Apr 14, 2025

onurtemizkan commented Apr 15, 2025

mydea Apr 15, 2025

onurtemizkan Apr 15, 2025

onurtemizkan Apr 15, 2025

mydea Apr 16, 2025

onurtemizkan Apr 22, 2025

mydea Apr 22, 2025

onurtemizkan Apr 22, 2025

onurtemizkan Apr 22, 2025

mydea commented Apr 15, 2025

onurtemizkan commented Apr 22, 2025

mydea Apr 23, 2025

mydea Apr 23, 2025

mydea left a comment

feat(node): Migrate to @fastify/otel #15542

Are you sure you want to change the base?

feat(node): Migrate to @fastify/otel #15542

Conversation

onurtemizkan commented Feb 28, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 28, 2025 • edited Loading

size-limit report 📦

Choose a reason for hiding this comment

andreiborza left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

onurtemizkan commented Apr 3, 2025

mydea commented Apr 8, 2025

andreiborza commented Apr 14, 2025 • edited Loading

onurtemizkan commented Apr 14, 2025

onurtemizkan commented Apr 15, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mydea commented Apr 15, 2025

onurtemizkan commented Apr 22, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mydea left a comment

Choose a reason for hiding this comment

feat(node): Migrate to `@fastify/otel` #15542

feat(node): Migrate to `@fastify/otel` #15542

onurtemizkan commented Feb 28, 2025 •

edited

Loading

github-actions bot commented Feb 28, 2025 •

edited

Loading

andreiborza commented Apr 14, 2025 •

edited

Loading