@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 @opentelemetry/instrumentation-mongoose

Supported Versions

mongoose versions >=5.9.7 <9

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(),
  ],
})

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

Attribute	Short Description
`db.mongodb.collection`	The collection being accessed within the database stated in `db.name`.
`db.name`	This attribute is used to report the name of the database being accessed.
`db.operation`	The name of the operation being executed, or the SQL keyword.
`db.statement`	The database statement being executed.
`db.system`	An identifier for the database management system (DBMS) product being used.
`db.user`	Username for accessing the database.
`net.peer.name`	Remote hostname or similar.
`net.peer.port`	Remote port number.