From f7ab1fc0894fdce0907413866a72cbbf4a77ddd5 Mon Sep 17 00:00:00 2001 From: ilaydadastan Date: Wed, 2 Apr 2025 17:05:02 +0100 Subject: [PATCH 1/3] updated ReadME file in instrumentation-fs --- plugins/node/instrumentation-fs/README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/plugins/node/instrumentation-fs/README.md b/plugins/node/instrumentation-fs/README.md index ebadc77ed8..81f714c819 100644 --- a/plugins/node/instrumentation-fs/README.md +++ b/plugins/node/instrumentation-fs/README.md @@ -3,11 +3,9 @@ [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image] -This module provides automatic instrumentation for the [`fs`](http://nodejs.org/dist/latest/docs/api/fs.html) module, which may be loaded using the [`@opentelemetry/sdk-trace-node`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-sdk-trace-node) package and is included in the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle. +This module provides automatic instrumentation for the [`fs`](http://nodejs.org/dist/latest/docs/api/fs.html) module, which should be loaded using the [`@opentelemetry/instrumentation`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation) package. -If total installation size is not constrained, it is recommended to use the [`@opentelemetry/auto-instrumentations-node`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](`https://www.npmjs.com/package/@opentelemetry/sdk-node`) for the most seamless instrumentation experience. - -Compatible with OpenTelemetry JS API and SDK `1.0+`. +Compatible with OpenTelemetry JS API `1.3+`. See the full list of instrumented functions in [constants.ts](src/constants.ts); @@ -19,7 +17,7 @@ npm install --save @opentelemetry/instrumentation-fs ## Supported Versions -- Node.js `>=14` +- Node.js `>=18` ## Usage From 80b1da65d74b00210fe57a2f79a9a065e0a6286b Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Wed, 2 Apr 2025 14:14:43 -0700 Subject: [PATCH 2/3] lint:readme: drop constraint that Node.js instrumentations mention using auto-instrumentations-node This is no longer a valid assumption. The 'fs' instrumentation, for example, is no longer a default part of auto-instrumentations-node. --- scripts/lint-readme.js | 13 +------------ 1 file changed, 1 insertion(+), 12 deletions(-) diff --git a/scripts/lint-readme.js b/scripts/lint-readme.js index cdc5e6988d..428cbfa31e 100644 --- a/scripts/lint-readme.js +++ b/scripts/lint-readme.js @@ -62,18 +62,7 @@ if (!currentReadmeContent.includes(badgesToVerify)) { ); } -if (isNode) { - const distText = `If total installation size is not constrained, it is recommended to use the [\`@opentelemetry/auto-instrumentations-node\`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-node) bundle with [@opentelemetry/sdk-node](\`https://www.npmjs.com/package/@opentelemetry/sdk-node\`) for the most seamless instrumentation experience. - -Compatible with OpenTelemetry JS API and SDK \`1.0+\`. -` - - if (!currentReadmeContent.includes(distText)) { - throw new Error( - `README.md dist text is not valid. Please add the following text to the README.md file:\n\n${distText}` - ); - } -} else if (isWeb) { +if (isWeb) { const distText = `If total installation size is not constrained, it is recommended to use the [\`@opentelemetry/auto-instrumentations-web\`](https://www.npmjs.com/package/@opentelemetry/auto-instrumentations-web) bundle with [\`@opentelemetry/sdk-trace-web\`](https://www.npmjs.com/package/@opentelemetry/sdk-trace-web) for the most seamless instrumentation experience. Compatible with OpenTelemetry JS API and SDK \`1.0+\`. From 5fafe88bb4de6905dd78ac7019a6a87852de286b Mon Sep 17 00:00:00 2001 From: Marc Pichler Date: Wed, 9 Apr 2025 14:02:08 +0200 Subject: [PATCH 3/3] Update plugins/node/instrumentation-fs/README.md Co-authored-by: Trent Mick --- plugins/node/instrumentation-fs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/node/instrumentation-fs/README.md b/plugins/node/instrumentation-fs/README.md index 81f714c819..4a40fca319 100644 --- a/plugins/node/instrumentation-fs/README.md +++ b/plugins/node/instrumentation-fs/README.md @@ -3,7 +3,7 @@ [![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image] -This module provides automatic instrumentation for the [`fs`](http://nodejs.org/dist/latest/docs/api/fs.html) module, which should be loaded using the [`@opentelemetry/instrumentation`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation) package. +This module provides automatic instrumentation for the [`fs`](http://nodejs.org/dist/latest/docs/api/fs.html) module, which can be registered using the [`@opentelemetry/instrumentation`](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-instrumentation) package. Compatible with OpenTelemetry JS API `1.3+`.