feat: MongoDB Tracing Support

Author: kamilogorek

packages/tracing/src/integrations/express.ts

@@ -79,7 +79,7 @@ export class Express implements Integration {
    */
   public setupOnce(): void {
     if (!this._router) {
-      logger.error('ExpressIntegration is missing an Express instance');
+      logger.error('Express Integration is missing an Express instance');
       return;
     }
     instrumentMiddlewares(this._router, this._methods);

packages/tracing/src/integrations/index.ts

@@ -1 +1,2 @@
 export { Express } from './express';
+export { Mongo } from './mongo';

packages/tracing/src/integrations/mongo.ts

@@ -0,0 +1,213 @@
+import { Hub } from '@sentry/hub';
+import { EventProcessor, Integration, SpanContext } from '@sentry/types';
+import { fill, logger } from '@sentry/utils';
+
+// This allows us to use the same array for both, defaults option and the type itself.
+// (note `as const` at the end to make it a concrete union type, and not just string[])
+type Operation = typeof OPERATIONS[number];
+const OPERATIONS = [
+  'aggregate', // aggregate(pipeline, options, callback)
+  'bulkWrite', // bulkWrite(operations, options, callback)
+  'countDocuments', // countDocuments(query, options, callback)
+  'createIndex', // createIndex(fieldOrSpec, options, callback)
+  'createIndexes', // createIndexes(indexSpecs, options, callback)
+  'deleteMany', // deleteMany(filter, options, callback)
+  'deleteOne', // deleteOne(filter, options, callback)
+  'distinct', // distinct(key, query, options, callback)
+  'drop', // drop(options, callback)
+  'dropIndex', // dropIndex(indexName, options, callback)
+  'dropIndexes', // dropIndexes(options, callback)
+  'estimatedDocumentCount', // estimatedDocumentCount(options, callback)
+  'findOne', // findOne(query, options, callback)
+  'findOneAndDelete', // findOneAndDelete(filter, options, callback)
+  'findOneAndReplace', // findOneAndReplace(filter, replacement, options, callback)
+  'findOneAndUpdate', // findOneAndUpdate(filter, update, options, callback)
+  'indexes', // indexes(options, callback)
+  'indexExists', // indexExists(indexes, options, callback)
+  'indexInformation', // indexInformation(options, callback)
+  'initializeOrderedBulkOp', // initializeOrderedBulkOp(options, callback)
+  'insertMany', // insertMany(docs, options, callback)
+  'insertOne', // insertOne(doc, options, callback)
+  'isCapped', // isCapped(options, callback)
+  'mapReduce', // mapReduce(map, reduce, options, callback)
+  'options', // options(options, callback)
+  'parallelCollectionScan', // parallelCollectionScan(options, callback)
+  'rename', // rename(newName, options, callback)
+  'replaceOne', // replaceOne(filter, doc, options, callback)
+  'stats', // stats(options, callback)
+  'updateMany', // updateMany(filter, update, options, callback)
+  'updateOne', // updateOne(filter, update, options, callback)
+] as const;
+
+const OPERATION_SIGNATURES: {
+  [op in Operation]?: string[];
+} = {
+  bulkWrite: ['operations'],
+  countDocuments: ['query'],
+  createIndex: ['fieldOrSpec'],
+  createIndexes: ['indexSpecs'],
+  deleteMany: ['filter'],
+  deleteOne: ['filter'],
+  distinct: ['key', 'query'],
+  dropIndex: ['indexName'],
+  findOne: ['query'],
+  findOneAndDelete: ['filter'],
+  findOneAndReplace: ['filter', 'replacement'],
+  findOneAndUpdate: ['filter', 'update'],
+  indexExists: ['indexes'],
+  insertMany: ['docs'],
+  insertOne: ['doc'],
+  mapReduce: ['map', 'reduce'],
+  rename: ['newName'],
+  replaceOne: ['filter', 'doc'],
+  updateMany: ['filter', 'update'],
+  updateOne: ['filter', 'update'],
+};
+
+interface MongoCollection {
+  collectionName: string;
+  dbName: string;
+  namespace: string;
+  prototype: {
+    [operation in Operation]: (...args: unknown[]) => unknown;
+  };
+}
+
+interface MongoOptions {
+  operations?: Operation[];
+  describeOperations?: boolean | Operation[];
+}
+
+/** Tracing integration for node-postgres package */
+export class Mongo implements Integration {
+  /**
+   * @inheritDoc
+   */
+  public static id: string = 'Mongo';
+
+  /**
+   * @inheritDoc
+   */
+  public name: string = Mongo.id;
+
+  private _operations: Operation[];
+  private _describeOperations?: boolean | Operation[];
+
+  /**
+   * @inheritDoc
+   */
+  public constructor(options: MongoOptions = {}) {
+    this._operations = Array.isArray(options.operations)
+      ? options.operations
+      : ((OPERATIONS as unknown) as Operation[]);
+    this._describeOperations = 'describeOperations' in options ? options.describeOperations : true;
+  }
+
+  /**
+   * @inheritDoc
+   */
+  public setupOnce(_: (callback: EventProcessor) => void, getCurrentHub: () => Hub): void {
+    let collection: MongoCollection;
+
+    try {
+      /* eslint-disable @typescript-eslint/no-var-requires, @typescript-eslint/no-unsafe-member-access */
+      const mongodbModule = require('mongodb');
+      collection = mongodbModule.Collection;
+      /* eslint-enable @typescript-eslint/no-var-requires, @typescript-eslint/no-unsafe-member-access */
+    } catch (e) {
+      logger.error('Mongo Integration was unable to require `mongodb` package.');
+      return;
+    }
+
+    this._instrumentOperations(collection, this._operations, getCurrentHub);
+  }
+
+  /**
+   * Patches original collection methods
+   */
+  private _instrumentOperations(collection: MongoCollection, operations: Operation[], getCurrentHub: () => Hub): void {
+    operations.forEach((operation: Operation) => this._patchOperation(collection, operation, getCurrentHub));
+  }
+
+  /**
+   * Patches original collection to utilize our tracing functionality
+   */
+  private _patchOperation(collection: MongoCollection, operation: Operation, getCurrentHub: () => Hub): void {
+    if (!(operation in collection.prototype)) return;
+
+    const getSpanContext = this._getSpanContextFromOperationArguments.bind(this);
+
+    fill(collection.prototype, operation, function(orig: () => void | Promise<unknown>) {
+      return function(this: unknown, ...args: unknown[]) {
+        const lastArg = args[args.length - 1];
+        const scope = getCurrentHub().getScope();
+        const transaction = scope?.getTransaction();
+
+        // mapReduce is a special edge-case, as it's the only operation that accepts functions
+        // other than the callback as it's own arguments. Therefore despite lastArg being
+        // a function, it can be still a promise-based call without a callback.
+        // mapReduce(map, reduce, options, callback) where `[map|reduce]: function | string`
+        if (typeof lastArg !== 'function' || (operation === 'mapReduce' && args.length === 2)) {
+          const span = transaction?.startChild(getSpanContext(this, operation, args));
+          return (orig.call(this, ...args) as Promise<unknown>).then((res: unknown) => {
+            span?.finish();
+            return res;
+          });
+        }
+
+        const span = transaction?.startChild(getSpanContext(this, operation, args.slice(0, -1)));
+        return orig.call(this, ...args.slice(0, -1), function(err: Error, result: unknown) {
+          span?.finish();
+          lastArg(err, result);
+        });
+      };
+    });
+  }
+
+  /**
+   * Form a SpanContext based on the user input to a given operation.
+   */
+  private _getSpanContextFromOperationArguments(
+    collection: MongoCollection,
+    operation: Operation,
+    args: unknown[],
+  ): SpanContext {
+    const data: { [key: string]: string } = {
+      collectionName: collection.collectionName,
+      dbName: collection.dbName,
+      namespace: collection.namespace,
+    };
+    const spanContext: SpanContext = {
+      op: `query.${operation}`,
+      data,
+    };
+
+    // If there was no signature available for us to be used for the extracted data description.
+    // Or user decided to not describe given operation, just return early.
+    const signature = OPERATION_SIGNATURES[operation];
+    const shouldDescribe = Array.isArray(this._describeOperations)
+      ? this._describeOperations.includes(operation)
+      : this._describeOperations;
+
+    if (!signature || !shouldDescribe) {
+      return spanContext;
+    }
+
+    try {
+      // Special case for `mapReduce`, as the only one accepting functions as arguments.
+      if (operation === 'mapReduce') {
+        const [map, reduce] = args as { name?: string }[];
+        data[signature[0]] = typeof map === 'string' ? map : map.name || '<anonymous>';
+        data[signature[1]] = typeof reduce === 'string' ? reduce : reduce.name || '<anonymous>';
+      } else {
+        for (let i = 0; i < signature.length; i++) {
+          data[signature[i]] = JSON.stringify(args[i]);
+        }
+      }
+    } catch (_oO) {
+      // no-empty
+    }
+
+    return spanContext;
+  }
+}