From 4b2e027d517ee27ec9a5d863d63460ddf23e99f9 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Thu, 16 Jan 2025 16:47:25 +0100 Subject: [PATCH 1/4] feat(auto-instrumentations-node)!: deprecate instrumentation in favor of @fastify/otel --- metapackages/auto-instrumentations-node/README.md | 5 ++++- metapackages/auto-instrumentations-node/src/utils.ts | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/metapackages/auto-instrumentations-node/README.md b/metapackages/auto-instrumentations-node/README.md index b41c31fa3c..fd3d8d9669 100644 --- a/metapackages/auto-instrumentations-node/README.md +++ b/metapackages/auto-instrumentations-node/README.md @@ -169,7 +169,10 @@ registerInstrumentations({ - [@opentelemetry/instrumentation-dataloader](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-dataloader) - [@opentelemetry/instrumentation-dns](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-dns) - [@opentelemetry/instrumentation-express](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-express) -- [@opentelemetry/instrumentation-fastify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-fastify) +- [@opentelemetry/instrumentation-fastify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-fastify) (deprecated, default disabled) + - This component is **deprecated** in favor of the official instrumentation package [`@fastify/otel`](https://www.npmjs.com/package/@fastify/otel), maintained by the Fastify authors. + - Please see [here](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`. + - This component will be removed on March 25, 2025 - [@opentelemetry/instrumentation-fs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-fs) (default disabled) - [@opentelemetry/instrumentation-generic-pool](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool) - [@opentelemetry/instrumentation-graphql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-graphql) diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts index d7e6a0cd6b..54ae773d81 100644 --- a/metapackages/auto-instrumentations-node/src/utils.ts +++ b/metapackages/auto-instrumentations-node/src/utils.ts @@ -136,7 +136,7 @@ const InstrumentationMap = { '@opentelemetry/instrumentation-winston': WinstonInstrumentation, }; -const defaultExcludedInstrumentations = ['@opentelemetry/instrumentation-fs']; +const defaultExcludedInstrumentations = ['@opentelemetry/instrumentation-fs', '@opentelemetry/instrumentation-fastify']; // Config types inferred automatically from the first argument of the constructor type ConfigArg = T extends new (...args: infer U) => unknown ? U[0] : never; From 9ec3c6451ae8b2c047cbb668394e2d02f69d8645 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Thu, 16 Jan 2025 17:30:52 +0100 Subject: [PATCH 2/4] fixup! feat(auto-instrumentations-node)!: deprecate instrumentation in favor of @fastify/otel --- metapackages/auto-instrumentations-node/src/utils.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/metapackages/auto-instrumentations-node/src/utils.ts b/metapackages/auto-instrumentations-node/src/utils.ts index 54ae773d81..c8ffd50c27 100644 --- a/metapackages/auto-instrumentations-node/src/utils.ts +++ b/metapackages/auto-instrumentations-node/src/utils.ts @@ -136,7 +136,10 @@ const InstrumentationMap = { '@opentelemetry/instrumentation-winston': WinstonInstrumentation, }; -const defaultExcludedInstrumentations = ['@opentelemetry/instrumentation-fs', '@opentelemetry/instrumentation-fastify']; +const defaultExcludedInstrumentations = [ + '@opentelemetry/instrumentation-fs', + '@opentelemetry/instrumentation-fastify', +]; // Config types inferred automatically from the first argument of the constructor type ConfigArg = T extends new (...args: infer U) => unknown ? U[0] : never; From ae3ddefe70e3013d2189d9c0bc09198c08483148 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Fri, 17 Jan 2025 14:23:22 +0100 Subject: [PATCH 3/4] test(auto-instrumentations-node): update test to filter out fastify --- metapackages/auto-instrumentations-node/test/utils.test.ts | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/metapackages/auto-instrumentations-node/test/utils.test.ts b/metapackages/auto-instrumentations-node/test/utils.test.ts index d2959b6ddd..6be7ed6692 100644 --- a/metapackages/auto-instrumentations-node/test/utils.test.ts +++ b/metapackages/auto-instrumentations-node/test/utils.test.ts @@ -30,7 +30,8 @@ describe('utils', () => { ).filter(depName => { return ( depName.startsWith('@opentelemetry/instrumentation-') && - depName !== '@opentelemetry/instrumentation-fs' + depName !== '@opentelemetry/instrumentation-fs' && + depName !== '@opentelemetry/instrumentation-fastify' ); }); From 3b2d74eefbd54565a797d34d5291bf9a57b381d9 Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Thu, 23 Jan 2025 10:03:40 +0100 Subject: [PATCH 4/4] Update metapackages/auto-instrumentations-node/README.md --- metapackages/auto-instrumentations-node/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/metapackages/auto-instrumentations-node/README.md b/metapackages/auto-instrumentations-node/README.md index fd3d8d9669..fa0bfae5ec 100644 --- a/metapackages/auto-instrumentations-node/README.md +++ b/metapackages/auto-instrumentations-node/README.md @@ -172,7 +172,7 @@ registerInstrumentations({ - [@opentelemetry/instrumentation-fastify](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-fastify) (deprecated, default disabled) - This component is **deprecated** in favor of the official instrumentation package [`@fastify/otel`](https://www.npmjs.com/package/@fastify/otel), maintained by the Fastify authors. - Please see [here](https://github.com/fastify/otel?tab=readme-ov-file#usage) for instructions on how to use `@fastify/otel`. - - This component will be removed on March 25, 2025 + - This component will be removed on June 30, 2025 - [@opentelemetry/instrumentation-fs](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/instrumentation-fs) (default disabled) - [@opentelemetry/instrumentation-generic-pool](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-generic-pool) - [@opentelemetry/instrumentation-graphql](https://github.com/open-telemetry/opentelemetry-js-contrib/tree/main/plugins/node/opentelemetry-instrumentation-graphql)