@opentelemetry/instrumentation-fs

OpenTelemetry fs Instrumentation for Node.js

This module provides automatic instrumentation for the fs module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @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;

Installation

npm install --save @opentelemetry/instrumentation-fs

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.

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.11.0

:bug: Bug Fix

• #221 fix: wrapper function for hapi route & plugins (@jk1z)
• #225 pg spans disconnected from parent (@obecny)
• #208 [mysql] fix: ensure span name is a string to avoid [object Object] as span name (@naseemkullah)
• #175 fix: accept EventListener callbacks (@johnbley)
• #188 fix(express): listen for finish event on response for async express layer #107 (@vmarchaud)

:rocket: Enhancement

• Other
  • #176 feat: reduce root span cardinality in express plugin (@gecgooden)
  • #226 feature: Graphql (@obecny)
  • #215 Allow redis version 3.0.0 and above (@akshah123)
  • #212 docs: update dns status and add hapi koa (@naseemkullah)
• opentelemetry-host-metrics
  • #227 Host Metrics (@obecny)

Committers: 9

• Ankit Shah (@akshah123)
• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• George Gooden (@gecgooden)
• Jack Zhang (@jk1z)
• John Bley (@johnbley)
• Mark (@MarkSeufert)
• Naseem (@naseemkullah)
• Valentin Marchaud (@vmarchaud)