This module provides automatic instrumentation for mongodb.
For automatic instrumentation see the @opentelemetry/node package.
npm install --save @opentelemetry/instrumentation-mongodb'>=3.3 <4
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/node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');
const provider = new NodeTracerProvider();
provider.register();
registerInstrumentations({
instrumentations: [
new MongoDBInstrumentation({
// see under for available configuration
}),
],
});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 |
- 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.