Migrate to @fastify/otel instrumentation

[andreiborza]

Description

Fastify has taken ownership over the fastify Otel instrumentation and migrated the integration out of the opentelemetry-js-contrib repo into their own repo.

Once open-telemetry/opentelemetry-js-contrib#2652 lands, the current instrumentation, which we are using, will be disabled by default and removed completely by March 25, 2025.

Solution Brainstorm

Migrating to @fastify/otel is inevitable, but if integration proves difficult we have to specifically enable the integration,

[mydea]

is there something that speaks against just switching out the instrumentation right now?

[mydea]

hmm, this only supports fastify 5+ 😬

[mydea]

See: fastify/otel#10

[mydea]

After talking about this some more, our idea is to:

1. Switch to use @fastify/otel instead of @opentelemetry/instrumentation-fastify
2. Vendor the current state of @opentelemetry/instrumentation-fastify into the node package (note: We'll need to also inline some of the types accordingly). Limiting the range this applies to to >=3<=4.

We can use this blueprint for other similar situations too, in the future! This way, we continue to support fastify 3+, but can stay on the latest version of the official instrumentation and get improvements from there.

[punkpeye]

@mydea Is there a way to adopt this today without waiting for sentry to adopt it?

I suspect this is the cause of all my issues – errors associated with wrong requests, etc.

[andreiborza]

@punkpeye not without forking our sdk and building it in.

We're not aware of the current approach not working though, please feel free to file an issue with a reproduction for the problems you're encountering currently and we'll help you.

[mydea]

@onur is this ready to go?

[onurtemizkan]

@mydea, yes it's ready to be merged

[punkpeye]

I think this is already released

[mydea]

We should hopefully be able to merge & release this soon!

[punkpeye]

@mydea has this been released?

[punkpeye]

I cannot tell if my code is even being properly instrumented. These are the logs:

Sentry Logger [debug]: @opentelemetry/instrumentation-fastify Applying instrumentation patch for module on require hook {
  module: 'fastify',
  version: '5.3.2',
  baseDir: '/Users/frank/Developer/punkpeye/glama/node_modules/.pnpm/[email protected]/node_modules/fastify'
}
[Sentry] fastify is not instrumented. Please make sure to initialize Sentry in a separate file that you `--import` when running node, see: https://docs.sentry.io/platforms/javascript/guides/fastify/install/esm/.

I do not see anything past that that would mention Fastify.

[onurtemizkan]

Hi @punkpeye. No, it's not released yet. It's ready to be merged, though, so it'll be out soon.

[punkpeye]

Created a separate issue #16187

[punkpeye]

Was this not release v 9.16.0 ?

[andreiborza]

@punkpeye not yet, still waiting on #15542

[github-actions]

A PR closing this issue has just been released 🚀

This issue was referenced by PR #15542, which was included in the 9.17.0 release.