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;
npm install --save @opentelemetry/instrumentation-fs- Node.js
>=14
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
}),
],
});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. |
This package does not currently generate any attributes from semantic conventions.
- 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
Apache 2.0 - See LICENSE for more information.