@opentelemetry/instrumentation-mongodb
TypeScript icon, indicating that this package has built-in type declarations

0.42.0 • Public • Published

OpenTelemetry MongoDB Instrumentation for Node.js

NPM Published Version Apache License

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

  • >=3.3 <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

Useful links

License

Apache 2.0 - See LICENSE for more information.

Package Sidebar

Install

npm i @opentelemetry/instrumentation-mongodb

Weekly Downloads

675,441

Version

0.42.0

License

Apache-2.0

Unpacked Size

130 kB

Total Files

18

Last publish

Collaborators

  • pichlermarc
  • bogdandrutu
  • dyladan