OpenTelemetry MongoDB Instrumentation for Node.js

This module provides automatic instrumentation for the mongodb 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-mongodb

Supported Versions

• mongodb version >=3.3.0 <7

Usage

OpenTelemetry MongoDB Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.

To load a specific instrumentation (mongodb in this case), specify it in the Node Tracer's configuration.

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

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

registerInstrumentations({
  instrumentations: [
    new MongoDBInstrumentation({
      // see under for available configuration
    }),
  ],
});

See examples/mongodb for a short example.

Mongo instrumentation Options

Mongodb instrumentation has few options available to choose from. You can set the following:

| Options | Type | Description | | ------- | ---- | ----------- | | enhancedDatabaseReporting | string | If true, additional information about query parameters and results will be attached (as attributes) to spans representing database operations | | responseHook | MongoDBInstrumentationExecutionResponseHook (function) | Function for adding custom attributes from db response | | dbStatementSerializer | DbStatementSerializer (function) | Custom serializer function for the db.statement tag |

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.system | An identifier for the database management system (DBMS) product being used. | | db.connection_string | The connection string used to connect to the database. | | db.name | This attribute is used to report the name of the database being accessed. | | db.operation | The name of the operation being executed. | | db.mongodb.collection | The collection being accessed within the database stated in db.name. | | net.peer.name | Remote hostname or similar. | | net.peer.port | Remote port number. |

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.