OpenTelemetry `fs` Instrumentation for Node.js

This module provides automatic instrumentation for the fs module, which can be registered using the @opentelemetry/instrumentation package.

Compatible with OpenTelemetry JS API 1.3+.

See the full list of instrumented functions in constants.ts;

Installation

npm install --save @opentelemetry/instrumentation-fs

Supported Versions

Node.js >=18

Usage

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { FsInstrumentation } = require('@opentelemetry/instrumentation-fs');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new FsInstrumentation({
      // see below for available configuration
    }),
  ],
});

Instrumentation Options

You can set the following:

Options	Type	Description
`createHook`	`(functionName: FMember \\| FPMember, info: { args: ArrayLike<unknown> }) => boolean`	Hook called before creating the span. If `false` is returned this and all the sibling calls will not be traced.
`endHook`	`( functionName: FMember \\| FPMember, info: { args: ArrayLike<unknown>; span: api.Span } ) => void`	Function called just before the span is ended. Useful for adding attributes.
`requireParentSpan`	`boolean`	Require parent to create fs span, default when unset is `false`.

Semantic Conventions

This package does not currently generate any attributes from semantic conventions.

Useful links

For more information on OpenTelemetry, visit: https://opentelemetry.io/
For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
For help or feedback on this project, join us in GitHub Discussions

OpenTelemetry `fs` Instrumentation for Node.js

Installation

Supported Versions

Usage

Instrumentation Options

Semantic Conventions

Useful links

License

Current Tags

44 Versions

OpenTelemetry fs Instrumentation for Node.js

Installation

Supported Versions

Usage

Instrumentation Options

Semantic Conventions

Useful links

License

Current Tags

44 Versions

OpenTelemetry `fs` Instrumentation for Node.js