feat(node): Migrate to @fastify/otel
#15542
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
onurtemizkan
force-pushed
the
onur/fastify-otel-migration
branch
2 times, most recently
from
38047fd to
6c347ee
Compare
AbhiPrasad
reviewed
Feb 28, 2025
packages/node/package.json
Outdated
| @@ -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" | |||
There was a problem hiding this comment.
Can we avoid this and just vendor in the minimal interface we need to satisfy the types?
size-limit report 📦
|
onurtemizkan
force-pushed
the
onur/fastify-otel-migration
branch
2 times, most recently
from
88d946e to
112c80a
Compare
AbhiPrasad
reviewed
Mar 20, 2025
| @@ -0,0 +1,32 @@ | |||
| /* | |||
There was a problem hiding this comment.
For the files we vendored in from OTEL, we should also link to the git sha we used of the versioned files.
onurtemizkan
force-pushed
the
onur/fastify-otel-migration
branch
4 times, most recently
from
ad52eb9 to
9ca14db
Compare
2 tasks
andreiborza
approved these changes
Mar 31, 2025
packages/node/package.json
Outdated
| @@ -65,6 +65,7 @@ | |||
| "access": "public" | |||
| }, | |||
| "dependencies": { | |||
| "@fastify/otel": "0.5.0", | |||
Comment on lines
19
to
52
| // /** | ||
| // * 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 [email protected] | ||
| // 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; | ||
| // } |
There was a problem hiding this comment.
l: Do we want to keep this around?
| @@ -159,11 +177,11 @@ function defaultShouldHandleError(_error: Error, _request: MinimalFastifyRequest | |||
| * app.listen({ port: 3000 }); | |||
| * ``` | |||
| */ | |||
| export function setupFastifyErrorHandler(fastify: Fastify, options?: Partial<FastifyHandlerOptions>): void { | |||
| export function setupFastifyErrorHandler(fastify: FastifyInstance, options?: Partial<FastifyHandlerOptions>): void { | |||
There was a problem hiding this comment.
We should start thinking about making use of the diagnostics channel to automatically set this up for users on v5. I filed an issue here: #15936
onurtemizkan
force-pushed
the
onur/fastify-otel-migration
branch
from
dcd6345 to
2bd1c74
Compare
onurtemizkan
force-pushed
the
onur/fastify-otel-migration
branch
from
2bd1c74 to
0308803
Compare
|
@andreiborza - I updated the PR. Waiting for fastify/otel#35 to be released. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves: #15130
Depends on: fastify/otel#25 for proper
NestJSsupport.Opened an issue regarding the problem with
fastifytypes: fastify/otel#32The behaviour is not exactly the same as before, mainly because the new instrumentation doesn't have a
requestHook.