Skip to content

[contribfest] update documentation for @opentelemetry/instrumentation-fsΒ #2775

@pichlermarc

Description

@pichlermarc

Description

Important

This issue is reserved for attendees of OpenTelemetry ContribFest at KubeCon EU 2025
If you are attending KubeCon EU 2025, please join us at Level 3 | ICC Capital Suite 1 on Wednesday April 2, 2025 16:15 - 17:30 BST πŸ™Œ

If you are not attending KubeCon EU 2025, the remainder of this issue will be
marked as "good-first-issue" starting Thursday. πŸ™‚

The README.md for @opentelemetry/instrumentation-fs contains some old and outdated information:

  • it should not be loaded using @opentelemetry/sdk-trace-node, but rather @opentelemetry/instrumentation
  • it is not included in @opentelemetry/auto-instrumentations-node anymore, so that part of the sentence can be removed
    • also the sentence below to use @opentelemetry/auto-instrumentations-node can be dropped
  • the compatibility should be updated to API 1.3+, drop stability mentions of the SDK.
  • Supported Node.js versions are Node.js >=18

Section of the README.md that should be updated:

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.
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+`.
See the full list of instrumented functions in [constants.ts](src/constants.ts);
## Installation
```bash
npm install --save @opentelemetry/instrumentation-fs
```
## Supported Versions
- Node.js `>=14`

Metadata

Metadata

Assignees

Labels

contribfestThese small and isolated issues are suitable for Kubecon Contribfestpkg:instrumentation-fs

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions