Update command span creation behaviour.

open-telemetry · Jan 23, 2025 · 7cba82a · 7cba82a
1 parent 5d7f5c1
commit 7cba82a
Show file tree

Hide file tree

Showing 2 changed files with 37 additions and 58 deletions.
diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/src/instrumentation.ts b/plugins/node/opentelemetry-instrumentation-mongodb/src/instrumentation.ts
@@ -462,6 +462,7 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
             return original.call(this, server, ns, ops, options, callback);
           }
         }
+
         const span = instrumentation.tracer.startSpan(
           `mongodb.${operationName}`,
           {
@@ -506,6 +507,7 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
 
         const resultHandler =
           typeof options === 'function' ? options : callback;
+
         if (
           skipInstrumentation ||
           typeof resultHandler !== 'function' ||
@@ -517,6 +519,7 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
             return original.call(this, server, ns, cmd, options, callback);
           }
         }
+
         const commandType = MongoDBInstrumentation._getCommandType(cmd);
         const type =
           commandType === MongodbCommandType.UNKNOWN ? 'command' : commandType;
@@ -554,18 +557,12 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
         const resultHandler = callback;
         const commandType = Object.keys(cmd)[0];
 
-        if (
-          skipInstrumentation ||
-          typeof resultHandler !== 'function' ||
-          typeof cmd !== 'object' ||
-          cmd.ismaster ||
-          cmd.hello
-        ) {
+        if (typeof cmd !== 'object' || cmd.ismaster || cmd.hello) {
           return original.call(this, ns, cmd, options, callback);
         }
 
         let span = undefined;
-        if (currentSpan) {
+        if (!skipInstrumentation) {
           span = instrumentation.tracer.startSpan(`mongodb.${commandType}`, {
             kind: SpanKind.CLIENT,
           });
@@ -604,17 +601,12 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
         const commandType = Object.keys(cmd)[0];
         const resultHandler = () => undefined;
 
-        if (
-          skipInstrumentation ||
-          typeof cmd !== 'object' ||
-          cmd.ismaster ||
-          cmd.hello
-        ) {
+        if (typeof cmd !== 'object' || cmd.ismaster || cmd.hello) {
           return original.apply(this, args);
         }
 
         let span = undefined;
-        if (currentSpan) {
+        if (!skipInstrumentation) {
           span = instrumentation.tracer.startSpan(`mongodb.${commandType}`, {
             kind: SpanKind.CLIENT,
           });
@@ -663,6 +655,7 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
           instrumentation._checkSkipInstrumentation(currentSpan);
         const resultHandler =
           typeof options === 'function' ? options : callback;
+
         if (
           skipInstrumentation ||
           typeof resultHandler !== 'function' ||
@@ -682,6 +675,7 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
             );
           }
         }
+
         const span = instrumentation.tracer.startSpan('mongodb.find', {
           kind: SpanKind.CLIENT,
         });
@@ -731,6 +725,7 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
 
         const resultHandler =
           typeof options === 'function' ? options : callback;
+
         if (skipInstrumentation || typeof resultHandler !== 'function') {
           if (typeof options === 'function') {
             return original.call(
@@ -753,6 +748,7 @@ export class MongoDBInstrumentation extends InstrumentationBase<MongoDBInstrumen
             );
           }
         }
+
         const span = instrumentation.tracer.startSpan('mongodb.getMore', {
           kind: SpanKind.CLIENT,
         });

diff --git a/plugins/node/opentelemetry-instrumentation-mongodb/test/mongodb-v5-v6.test.ts b/plugins/node/opentelemetry-instrumentation-mongodb/test/mongodb-v5-v6.test.ts
@@ -654,60 +654,40 @@ describe('MongoDBInstrumentation-Tracing-v5', () => {
 
   describe('requireParentSpan', () => {
     // Resetting the behavior to default to avoid flakes in other tests
-    afterEach(() => {
-      instrumentation.setConfig({
-        requireParentSpan: true,
-      });
+    beforeEach(() => {
+      instrumentation.setConfig();
     });
 
     it('should not create spans without parent span when requireParentSpan is explicitly set to true', done => {
-      create({
-        requireParentSpan: true,
+      context.with(trace.deleteSpan(context.active()), () => {
+        collection
+          .insertOne({ a: 1 })
+          .then(() => {
+            assert.strictEqual(getTestSpans().length, 0);
+            done();
+          })
+          .catch(err => {
+            done(err);
+          });
       });
-
-      collection
-        .insertOne({ a: 1 })
-        .then(() => {
-          assert.strictEqual(getTestSpans().length, 0);
-          done();
-        })
-        .catch(err => {
-          done(err);
-        });
     });
 
     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 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);
-        });
+      context.with(trace.deleteSpan(context.active()), () => {
+        collection
+          .insertOne({ a: 1 })
+          .then(() => {
+            assert.strictEqual(getTestSpans().length, 1);
+            done();
+          })
+          .catch(err => {
+            done(err);
+          });
+      });
     });
   });
 
@@ -731,6 +711,9 @@ describe('MongoDBInstrumentation-Tracing-v5', () => {
         })
         .catch(err => {
           done(err);
+        })
+        .finally(() => {
+          span.end();
         });
     });