feat(instrumentation-mongodb): Add requireParentSpan config option.

Author: onurtemizkan

plugins/node/opentelemetry-instrumentation-mongodb/README.md

@@ -54,6 +54,7 @@ Mongodb instrumentation has few options available to choose from. You can set th
 | [`enhancedDatabaseReporting`](./src/types.ts#L32) | `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 |
+| `requireParentSpan` | `boolean` | Require a parent span in order to create mongodb spans, default when unset is `true` |
 
 ## Semantic Conventions
 

plugins/node/opentelemetry-instrumentation-mongodb/src/instrumentation.ts

@@ -55,13 +55,21 @@ import { V4Connect, V4Session } from './internal-types';
 import { PACKAGE_NAME, PACKAGE_VERSION } from './version';
 import { UpDownCounter } from '@opentelemetry/api';
 
+const DEFAULT_CONFIG: MongoDBInstrumentationConfig = {
+  requireParentSpan: true,
+};
+
 /** mongodb instrumentation plugin for OpenTelemetry */
 export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumentationConfig> {
   private _connectionsUsage!: UpDownCounter;
   private _poolName!: string;
 
   constructor(config: MongoDBInstrumentationConfig = {}) {
-    super(PACKAGE_NAME, PACKAGE_VERSION, config);
+    super(PACKAGE_NAME, PACKAGE_VERSION, { ...DEFAULT_CONFIG, ...config });
+  }
+
+  override setConfig(config: MongoDBInstrumentationConfig = {}) {
+    super.setConfig({ ...DEFAULT_CONFIG, ...config });
   }
 
   override _updateMetricInstruments() {
@@ -438,10 +446,15 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
         callback?: Function
       ) {
         const currentSpan = trace.getSpan(context.active());
+
+        const hasNoParentSpan = currentSpan === undefined;
+        const requireParentSpan = instrumentation.getConfig().requireParentSpan;
+        const skipInstrumentation = requireParentSpan === true && hasNoParentSpan;
+
         const resultHandler =
           typeof options === 'function' ? options : callback;
         if (
-          !currentSpan ||
+          skipInstrumentation ||
           typeof resultHandler !== 'function' ||
           typeof ops !== 'object'
         ) {
@@ -490,10 +503,15 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
         callback?: Function
       ) {
         const currentSpan = trace.getSpan(context.active());
+
+        const hasNoParentSpan = currentSpan === undefined;
+        const requireParentSpan = instrumentation.getConfig().requireParentSpan;
+        const skipInstrumentation = requireParentSpan === true && hasNoParentSpan;
+
         const resultHandler =
           typeof options === 'function' ? options : callback;
         if (
-          !currentSpan ||
+          skipInstrumentation ||
           typeof resultHandler !== 'function' ||
           typeof cmd !== 'object'
         ) {
@@ -634,10 +652,15 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
         callback?: Function
       ) {
         const currentSpan = trace.getSpan(context.active());
+
+        const hasNoParentSpan = currentSpan === undefined;
+        const requireParentSpan = instrumentation.getConfig().requireParentSpan;
+        const skipInstrumentation = requireParentSpan === true && hasNoParentSpan;
+
         const resultHandler =
           typeof options === 'function' ? options : callback;
         if (
-          !currentSpan ||
+          skipInstrumentation ||
           typeof resultHandler !== 'function' ||
           typeof cmd !== 'object'
         ) {
@@ -699,9 +722,14 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
         callback?: Function
       ) {
         const currentSpan = trace.getSpan(context.active());
+
+        const hasNoParentSpan = currentSpan === undefined;
+        const requireParentSpan = instrumentation.getConfig().requireParentSpan;
+        const skipInstrumentation = requireParentSpan === true && hasNoParentSpan;
+
         const resultHandler =
           typeof options === 'function' ? options : callback;
-        if (!currentSpan || typeof resultHandler !== 'function') {
+        if (skipInstrumentation || typeof resultHandler !== 'function') {
           if (typeof options === 'function') {
             return original.call(
               this,

plugins/node/opentelemetry-instrumentation-mongodb/src/types.ts

@@ -49,6 +49,11 @@ export interface MongoDBInstrumentationConfig extends InstrumentationConfig {
    * Custom serializer function for the db.statement tag
    */
   dbStatementSerializer?: DbStatementSerializer;
+
+  /**
+   * Require parent to create mongodb span, default when unset is true
+   */
+  requireParentSpan?: boolean;
 }
 
 export interface MongoResponseHookInformation {

plugins/node/opentelemetry-instrumentation-mongodb/test/mongodb-v5-v6.test.ts

@@ -652,6 +652,42 @@ describe('MongoDBInstrumentation-Tracing-v5', () => {
     });
   });
 
+  describe('requireParentSpan', () => {
+    it('should create spans without parent span when requireParentSpan is false', done => {
+      create({
+        requireParentSpan: false,
+      });
+
+      collection
+        .insertOne({ a: 1 })
+        .then(() => {
+          assert.strictEqual(getTestSpans().length, 1);
+          done();
+        })
+        .catch(err => {
+          done(err);
+        });
+    });
+
+    it('should not create spans without parent span when requireParentSpan is set to false by setConfig', done => {
+      create();
+
+      instrumentation.setConfig({
+        requireParentSpan: false,
+      });
+
+      collection
+        .insertOne({ a: 1 })
+        .then(() => {
+          assert.strictEqual(getTestSpans().length, 1);
+          done();
+        })
+        .catch(err => {
+          done(err);
+        });
+    });
+  })
+
   /** Should intercept command */
   describe('Removing Instrumentation', () => {
     it('should unpatch plugin', () => {