@opentelemetry/instrumentation-fs

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

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.23.0

:bug: Bug Fix

• #557 chore: aligning target for esm build with core repo (@obecny)

:rocket: Enhancement

• opentelemetry-browser-extension-autoinjection
  • #498 feat: add browser extension (@svrnm)
• opentelemetry-host-metrics, opentelemetry-id-generator-aws-xray, opentelemetry-test-utils
  • #556 chore: update core and API (@dyladan)
• Other
  • #533 feat(mongo instrumentation): added response hook option (@prsnca)
  • #546 feat(aws-lambda): disableAwsContextPropagation config option (@nirsky)
  • #528 feat: postgresql responseHook support (@nata7che)
• opentelemetry-test-utils
  • #538 feat: add cassandra-driver instrumentation (@seemk)
  • #539 feat: memcached instrumentation (@Rauno56)

:house: Internal

• #554 chore: remove unneeded ts-node dev-dependency (@Flarna)

Committers: 9

• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Nir Hadassi (@nirsky)
• Rauno Viskus (@Rauno56)
• Severin Neumann (@svrnm)
• Siim Kallas (@seemk)
• Yaron (@prsnca)
• natashz (@nata7che)