feat(instrumentation-mongoose)!: add instrumentation of static methods

Author: Vovcharaa

plugins/node/instrumentation-mongoose/.tav.yml

@@ -1,6 +1,10 @@
 mongoose:
   - versions:
-      include: ">=5.9.7 <7"
+      include: ">=5.10.19 <6"
+      mode: latest-minors
+    commands: npm run test-v5-v6
+  - versions:
+      include: ">=6.7.5 <7"
       mode: latest-minors
     commands: npm run test-v5-v6
   - versions:

plugins/node/instrumentation-mongoose/README.md

@@ -17,7 +17,7 @@ npm install --save @opentelemetry/instrumentation-mongoose
 
 ## Supported Versions
 
-- [`mongoose`](https://www.npmjs.com/package/mongoose) versions `>=5.9.7 <9`
+- [`mongoose`](https://www.npmjs.com/package/mongoose) versions `>=5.10.19 <6` and `>=6.7.5 <9`
 
 ## Usage
 

plugins/node/instrumentation-mongoose/src/mongoose.ts

@@ -99,7 +99,7 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
   protected init(): InstrumentationModuleDefinition {
     const module = new InstrumentationNodeModuleDefinition(
       'mongoose',
-      ['>=5.9.7 <9'],
+      ['>=5.10.19 <6', '>=6.7.5 <9'],
       this.patch.bind(this),
       this.unpatch.bind(this)
     );
@@ -153,6 +153,17 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
     });
     this._wrap(moduleExports.Model, 'aggregate', this.patchModelAggregate());
 
+    this._wrap(
+      moduleExports.Model,
+      'insertMany',
+      this.patchModelStatic('insertMany', moduleVersion)
+    );
+    this._wrap(
+      moduleExports.Model,
+      'bulkWrite',
+      this.patchModelStatic('bulkWrite', moduleVersion)
+    );
+
     return moduleExports;
   }
 
@@ -179,6 +190,9 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
       this._unwrap(moduleExports.Query.prototype, funcName as any);
     });
     this._unwrap(moduleExports.Model, 'aggregate');
+
+    this._unwrap(moduleExports.Model, 'insertMany');
+    this._unwrap(moduleExports.Model, 'bulkWrite');
   }
 
   private patchAggregateExec(moduleVersion: string | undefined) {
@@ -314,6 +328,71 @@ export class MongooseInstrumentation extends InstrumentationBase<MongooseInstrum
     };
   }
 
+  private patchModelStatic(op: string, moduleVersion: string | undefined) {
+    const self = this;
+    return (original: Function) => {
+      return function patchedStatic(
+        this: any,
+        docsOrOps: any,
+        options?: any,
+        callback?: Function
+      ) {
+        if (
+          self.getConfig().requireParentSpan &&
+          trace.getSpan(context.active()) === undefined
+        ) {
+          return original.apply(this, arguments);
+        }
+
+        if (options instanceof Function) {
+          callback = options;
+          options = undefined;
+        }
+
+        const serializePayload: SerializerPayload = {};
+        switch (op) {
+          case 'insertMany':
+            serializePayload.documents = docsOrOps;
+            break;
+          case 'bulkWrite':
+            serializePayload.operations = docsOrOps;
+            break;
+          default:
+            serializePayload.document = docsOrOps;
+            break;
+        }
+        if (options !== undefined) {
+          serializePayload.options = options;
+        }
+
+        const attributes: Attributes = {};
+        const { dbStatementSerializer } = self.getConfig();
+        if (dbStatementSerializer) {
+          attributes[SEMATTRS_DB_STATEMENT] = dbStatementSerializer(
+            op,
+            serializePayload
+          );
+        }
+
+        const span = self._startSpan(
+          this.collection,
+          this.modelName,
+          op,
+          attributes
+        );
+
+        return self._handleResponse(
+          span,
+          original,
+          this,
+          arguments,
+          callback,
+          moduleVersion
+        );
+      };
+    };
+  }
+
   // we want to capture the otel span on the object which is calling exec.
   // in the special case of aggregate, we need have no function to path
   // on the Aggregate object to capture the context on, so we patch

plugins/node/instrumentation-mongoose/src/types.ts

@@ -23,6 +23,8 @@ export interface SerializerPayload {
   document?: any;
   aggregatePipeline?: any;
   fields?: any;
+  documents?: any;
+  operations?: any;
 }
 
 export type DbStatementSerializer = (

plugins/node/instrumentation-mongoose/test/mongoose-common.test.ts

@@ -321,6 +321,107 @@ describe('mongoose instrumentation [common]', () => {
     expect(statement.document).toEqual(expect.objectContaining(document));
   });
 
+  it('instrumenting insertMany operation', async () => {
+    const documents = [
+      {
+        firstName: 'John',
+        lastName: 'Doe',
+        email: '[email protected]',
+      },
+      {
+        firstName: 'Jane',
+        lastName: 'Doe',
+        email: '[email protected]',
+      },
+    ];
+    await User.insertMany(documents);
+
+    const spans = getTestSpans();
+    expect(spans.length).toBe(1);
+    assertSpan(spans[0] as ReadableSpan);
+    expect(spans[0].attributes[SEMATTRS_DB_OPERATION]).toBe('insertMany');
+    const statement = getStatement(spans[0] as ReadableSpan);
+    expect(statement.documents).toEqual(documents);
+  });
+
+  it('instrumenting bulkWrite operation', async () => {
+    const operations = [
+      {
+        insertOne: {
+          document: {
+            firstName: 'Jane',
+            lastName: 'Doe',
+            email: '[email protected]',
+            age: 25,
+          },
+        },
+      },
+      {
+        updateMany: {
+          filter: { age: { $lte: 20 } },
+          update: { $set: { age: 20 } },
+        },
+      },
+      {
+        updateOne: {
+          filter: { firstName: 'Jane' },
+          update: { $inc: { age: 1 } },
+        },
+      },
+      { deleteOne: { filter: { firstName: 'Michael' } } },
+      {
+        updateOne: {
+          filter: { firstName: 'Zara' },
+          update: {
+            $set: { lastName: 'Doe', age: 40, email: '[email protected]' },
+          },
+          upsert: true,
+        },
+      },
+    ];
+    await User.bulkWrite(operations);
+
+    const spans = getTestSpans();
+    expect(spans.length).toBe(1);
+    assertSpan(spans[0] as ReadableSpan);
+    expect(spans[0].attributes[SEMATTRS_DB_OPERATION]).toBe('bulkWrite');
+    const statement = getStatement(spans[0] as ReadableSpan);
+    expect(statement.operations).toEqual([
+      {
+        insertOne: {
+          document: {
+            firstName: 'Jane',
+            lastName: 'Doe',
+            email: '[email protected]',
+            age: 25,
+          },
+        },
+      },
+      {
+        updateMany: {
+          filter: { age: { $lte: 20 } },
+          update: { $set: { age: 20 } },
+        },
+      },
+      {
+        updateOne: {
+          filter: { firstName: 'Jane' },
+          update: { $inc: { age: 1 } },
+        },
+      },
+      { deleteOne: { filter: { firstName: 'Michael' } } },
+      {
+        updateOne: {
+          filter: { firstName: 'Zara' },
+          update: {
+            $set: { lastName: 'Doe', age: 40, email: '[email protected]' },
+          },
+          upsert: true,
+        },
+      },
+    ]);
+  });
+
   it('instrumenting aggregate operation', async () => {
     await User.aggregate([
       { $match: { firstName: 'John' } },

plugins/node/instrumentation-mongoose/test/user.ts

@@ -15,6 +15,8 @@
  */
 import { Schema, Document } from 'mongoose';
 import * as mongoose from 'mongoose';
+import { context } from '@opentelemetry/api';
+import { suppressTracing } from '@opentelemetry/core';
 
 export interface IUser extends Document {
   email: string;
@@ -35,25 +37,27 @@ const User = mongoose.model<IUser>('User', UserSchema);
 export default User;
 
 export const loadUsers = async () => {
-  await User.insertMany([
-    new User({
-      firstName: 'John',
-      lastName: 'Doe',
-      email: '[email protected]',
-      age: 18,
-    }),
-    new User({
-      firstName: 'Jane',
-      lastName: 'Doe',
-      email: '[email protected]',
-      age: 19,
-    }),
-    new User({
-      firstName: 'Michael',
-      lastName: 'Fox',
-      email: '[email protected]',
-      age: 16,
-    }),
-  ]);
+  await context.with(suppressTracing(context.active()), async () => {
+    await User.insertMany([
+      new User({
+        firstName: 'John',
+        lastName: 'Doe',
+        email: '[email protected]',
+        age: 18,
+      }),
+      new User({
+        firstName: 'Jane',
+        lastName: 'Doe',
+        email: '[email protected]',
+        age: 19,
+      }),
+      new User({
+        firstName: 'Michael',
+        lastName: 'Fox',
+        email: '[email protected]',
+        age: 16,
+      }),
+    ]);
+  });
   await User.createIndexes();
 };