@frzzzy/opentelemetry-instrumentation-mongoose NPM

OpenTelemetry mongoose Instrumentation for Node.js

This module provides automatic instrumentation for the mongoose 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+.

Installation

npm install --save @frzzzy/opentelemetry-instrumentation-mongoose

Supported Versions

>=5.9.7 <7

Usage

To load a specific plugin, specify it in the registerInstrumentations's configuration:

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

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

registerInstrumentations({
  instrumentations: [
    new MongooseInstrumentation(),
  ],
})

Migration From opentelemetry-instrumentation-mongoose

This instrumentation was originally published and maintained under the name "opentelemetry-instrumentation-mongoose" in this repo.

Few breaking changes were made during porting to the contrib repo to align with conventions:

Hook Info

The instrumentation's config responseHook functions signature changed, so the second function parameter is info object, containing the relevant hook data.

`moduleVersionAttributeName` config option

The moduleVersionAttributeName config option is removed. To add the mongoose package version to spans, use the moduleVersion attribute in hook info for responseHook function.