Introducing Socket Firewall: Free, Proactive Protection for Your Software Supply Chain.Learn More
Socket
Book a DemoInstallSign in
Socket

@opentelemetry/instrumentation-fs

Package Overview
Dependencies
Maintainers
3
Versions
36
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opentelemetry/instrumentation-fs

OpenTelemetry instrumentation for `node:fs` file system interactions module

Source
npmnpm
Version
0.20.0
Version published
Weekly downloads
6.7M
0.05%
Maintainers
3
Weekly downloads
 
Created
Source

OpenTelemetry fs Instrumentation for Node.js

NPM Published Version Apache License

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

Supported Versions

  • Node.js >=14

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:

OptionsTypeDescription
createHook(functionName: FMember | FPMember, info: { args: ArrayLike<unknown> }) => booleanHook 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 } ) => voidFunction called just before the span is ended. Useful for adding attributes.
requireParentSpanbooleanRequire parent to create fs span, default when unset is false.

Semantic Conventions

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

License

Apache 2.0 - See LICENSE for more information.

Keywords

fs

FAQs

Package last updated on 18 Mar 2025

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts