Method install

src/plugins/MongoDBPlugin.ts:44–291

(installer: PluginInstaller)

  }

  install(installer: PluginInstaller): void {
    const plugin = this;
    this.Collection = installer.require?.('mongodb/lib/collection') ?? require('mongodb/lib/collection');
    this.Cursor = installer.require?.('mongodb/lib/cursor') ?? require('mongodb/lib/cursor');
    this.Db = installer.require?.('mongodb/lib/db') ?? require('mongodb/lib/db');

    const wrapCallbackWithCursorMaybe = (span: any, args: any[], idx: number): boolean => {
      const callback = args.length > idx && typeof args[(idx = args.length - 1)] === 'function' ? args[idx] : null;

      if (!callback) return false;

      args[idx] = function (this: any) {
        // arguments = [error: any, result: any]
        span.mongodbInCall = false; // we do this because some operations may call callback immediately which would not create a new span for any operations in that callback (db.collection())

        if (arguments[0]) span.error(arguments[0]);

        if (arguments[0] || !plugin.hookCursorMaybe(span, arguments[1])) span.stop();

        return callback.apply(this, arguments);
      };

      return true;
    };

    const stringify = (params: any) => {
      if (params === undefined) return '';
      else if (typeof params === 'function') return `${params}`;

      let str = JSON.stringify(params);

      if (str.length > agentConfig.mongoParametersMaxLength)
        str = str.slice(0, agentConfig.mongoParametersMaxLength) + ' ...';

      return str;
    };

    const collInsertFunc = function (this: any, operation: string, span: any, args: any[]): boolean {
      // args = [doc(s), options, callback]
      span.tag(Tag.dbStatement(`${this.s.namespace.collection}.${operation}()`));

      if (agentConfig.mongoTraceParameters) span.tag(Tag.dbMongoParameters(stringify(args[0])));

      return wrapCallbackWithCursorMaybe(span, args, 1);
    };

    const collDeleteFunc = function (this: any, operation: string, span: any, args: any[]): boolean {
      // args = [filter, options, callback]
      span.tag(Tag.dbStatement(`${this.s.namespace.collection}.${operation}(${stringify(args[0])})`));

      return wrapCallbackWithCursorMaybe(span, args, 1);
    };

    const collUpdateFunc = function (this: any, operation: string, span: any, args: any[]): boolean {
      // args = [filter, update, options, callback]
      span.tag(Tag.dbStatement(`${this.s.namespace.collection}.${operation}(${stringify(args[0])})`));

      if (agentConfig.mongoTraceParameters) span.tag(Tag.dbMongoParameters(stringify(args[1])));