Skip to content

docs(instrumentation-fs): update readme #2779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pichlermarc merged 4 commits into from
Apr 9, 2025
Merged

docs(instrumentation-fs): update readme #2779

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f7ab1fc
updated ReadME file in instrumentation-fs
ilaydadastan Apr 2, 2025
80b1da6
lint:readme: drop constraint that Node.js instrumentations mention us…
trentm Apr 2, 2025
5fafe88
Update plugins/node/instrumentation-fs/README.md
pichlermarc Apr 9, 2025
7301d2e
Merge branch 'main' into update-readme-instrumentation-fs
pichlermarc Apr 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions plugins/node/instrumentation-fs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 can be registered 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);

Expand All @@ -19,7 +17,7 @@ npm install --save @opentelemetry/instrumentation-fs

## Supported Versions

- Node.js `>=14`
- Node.js `>=18`

## Usage

Expand Down
13 changes: 1 addition & 12 deletions scripts/lint-readme.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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+\`.
Expand Down