apm.js 20.2 KB
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639
'use strict';

var EventEmitter = require('events').EventEmitter,
  inherits = require('util').inherits;

// Get prototypes
var AggregationCursor = require('./aggregation_cursor'),
  CommandCursor = require('./command_cursor'),
  OrderedBulkOperation = require('./bulk/ordered').OrderedBulkOperation,
  UnorderedBulkOperation = require('./bulk/unordered').UnorderedBulkOperation,
  GridStore = require('./gridfs/grid_store'),
  Cursor = require('./cursor'),
  Collection = require('./collection'),
  Db = require('./db');

var basicOperationIdGenerator = {
  operationId: 1,

  next: function() {
    return this.operationId++;
  }
};

var basicTimestampGenerator = {
  current: function() {
    return new Date().getTime();
  },

  duration: function(start, end) {
    return end - start;
  }
};

var senstiveCommands = [
  'authenticate',
  'saslStart',
  'saslContinue',
  'getnonce',
  'createUser',
  'updateUser',
  'copydbgetnonce',
  'copydbsaslstart',
  'copydb'
];

var Instrumentation = function(core, options, callback) {
  options = options || {};

  // Optional id generators
  var operationIdGenerator = options.operationIdGenerator || basicOperationIdGenerator;
  // Optional timestamp generator
  var timestampGenerator = options.timestampGenerator || basicTimestampGenerator;
  // Extend with event emitter functionality
  EventEmitter.call(this);

  // Contains all the instrumentation overloads
  this.overloads = [];

  // ---------------------------------------------------------
  //
  // Instrument prototype
  //
  // ---------------------------------------------------------

  var instrumentPrototype = function(callback) {
    var instrumentations = [];

    // Classes to support
    var classes = [
      GridStore,
      OrderedBulkOperation,
      UnorderedBulkOperation,
      CommandCursor,
      AggregationCursor,
      Cursor,
      Collection,
      Db
    ];

    // Add instrumentations to the available list
    for (var i = 0; i < classes.length; i++) {
      if (classes[i].define) {
        instrumentations.push(classes[i].define.generate());
      }
    }

    // Return the list of instrumentation points
    callback(null, instrumentations);
  };

  // Did the user want to instrument the prototype
  if (typeof callback === 'function') {
    instrumentPrototype(callback);
  }

  // ---------------------------------------------------------
  //
  // Server
  //
  // ---------------------------------------------------------

  // Reference
  var self = this;
  // Names of methods we need to wrap
  var methods = ['command', 'insert', 'update', 'remove'];
  // Prototype
  var proto = core.Server.prototype;
  // Core server method we are going to wrap
  methods.forEach(function(x) {
    var func = proto[x];

    // Add to overloaded methods
    self.overloads.push({ proto: proto, name: x, func: func });

    // The actual prototype
    proto[x] = function() {
      var requestId = core.Query.nextRequestId();
      // Get the aruments
      var args = Array.prototype.slice.call(arguments, 0);
      var ns = args[0];
      var commandObj = args[1];
      var options = args[2] || {};
      var keys = Object.keys(commandObj);
      var commandName = keys[0];
      var db = ns.split('.')[0];

      // Get the collection
      var col = ns.split('.');
      col.shift();
      col = col.join('.');

      // Do we have a legacy insert/update/remove command
      if (x === 'insert') {
        //} && !this.lastIsMaster().maxWireVersion) {
        commandName = 'insert';

        // Re-write the command
        commandObj = {
          insert: col,
          documents: commandObj
        };

        if (options.writeConcern && Object.keys(options.writeConcern).length > 0) {
          commandObj.writeConcern = options.writeConcern;
        }

        commandObj.ordered = options.ordered !== undefined ? options.ordered : true;
      } else if (x === 'update') {
        // && !this.lastIsMaster().maxWireVersion) {
        commandName = 'update';

        // Re-write the command
        commandObj = {
          update: col,
          updates: commandObj
        };

        if (options.writeConcern && Object.keys(options.writeConcern).length > 0) {
          commandObj.writeConcern = options.writeConcern;
        }

        commandObj.ordered = options.ordered !== undefined ? options.ordered : true;
      } else if (x === 'remove') {
        //&& !this.lastIsMaster().maxWireVersion) {
        commandName = 'delete';

        // Re-write the command
        commandObj = {
          delete: col,
          deletes: commandObj
        };

        if (options.writeConcern && Object.keys(options.writeConcern).length > 0) {
          commandObj.writeConcern = options.writeConcern;
        }

        commandObj.ordered = options.ordered !== undefined ? options.ordered : true;
      }

      // Get the callback
      var callback = args.pop();
      // Set current callback operation id from the current context or create
      // a new one
      var ourOpId = callback.operationId || operationIdGenerator.next();

      // Get a connection reference for this server instance
      var connection = this.s.pool.get();

      // Emit the start event for the command
      var command = {
        // Returns the command.
        command: commandObj,
        // Returns the database name.
        databaseName: db,
        // Returns the command name.
        commandName: commandName,
        // Returns the driver generated request id.
        requestId: requestId,
        // Returns the driver generated operation id.
        // This is used to link events together such as bulk write operations. OPTIONAL.
        operationId: ourOpId,
        // Returns the connection id for the command. For languages that do not have this,
        // this MUST return the driver equivalent which MUST include the server address and port.
        // The name of this field is flexible to match the object that is returned from the driver.
        connectionId: connection
      };

      // Filter out any sensitive commands
      if (senstiveCommands.indexOf(commandName.toLowerCase()) !== -1) {
        command.commandObj = {};
        command.commandObj[commandName] = true;
      }

      // Emit the started event
      self.emit('started', command);

      // Start time
      var startTime = timestampGenerator.current();

      // Push our handler callback
      args.push(function(err, r) {
        var endTime = timestampGenerator.current();
        var command = {
          duration: timestampGenerator.duration(startTime, endTime),
          commandName: commandName,
          requestId: requestId,
          operationId: ourOpId,
          connectionId: connection
        };

        // If we have an error
        if (err || (r && r.result && r.result.ok === 0)) {
          command.failure = err || r.result.writeErrors || r.result;

          // Filter out any sensitive commands
          if (senstiveCommands.indexOf(commandName.toLowerCase()) !== -1) {
            command.failure = {};
          }

          self.emit('failed', command);
        } else if (commandObj && commandObj.writeConcern && commandObj.writeConcern.w === 0) {
          // If we have write concern 0
          command.reply = { ok: 1 };
          self.emit('succeeded', command);
        } else {
          command.reply = r && r.result ? r.result : r;

          // Filter out any sensitive commands
          if (senstiveCommands.indexOf(commandName.toLowerCase()) !== -1) {
            command.reply = {};
          }

          self.emit('succeeded', command);
        }

        // Return to caller
        callback(err, r);
      });

      // Apply the call
      func.apply(this, args);
    };
  });

  // ---------------------------------------------------------
  //
  // Bulk Operations
  //
  // ---------------------------------------------------------

  // Inject ourselves into the Bulk methods
  methods = ['execute'];
  var prototypes = [
    require('./bulk/ordered').Bulk.prototype,
    require('./bulk/unordered').Bulk.prototype
  ];

  prototypes.forEach(function(proto) {
    // Core server method we are going to wrap
    methods.forEach(function(x) {
      var func = proto[x];

      // Add to overloaded methods
      self.overloads.push({ proto: proto, name: x, func: func });

      // The actual prototype
      proto[x] = function() {
        // Get the aruments
        var args = Array.prototype.slice.call(arguments, 0);
        // Set an operation Id on the bulk object
        this.operationId = operationIdGenerator.next();

        // Get the callback
        var callback = args.pop();
        // If we have a callback use this
        if (typeof callback === 'function') {
          args.push(function(err, r) {
            // Return to caller
            callback(err, r);
          });

          // Apply the call
          func.apply(this, args);
        } else {
          return func.apply(this, args);
        }
      };
    });
  });

  // ---------------------------------------------------------
  //
  // Cursor
  //
  // ---------------------------------------------------------

  // Inject ourselves into the Cursor methods
  methods = ['_find', '_getmore', '_killcursor'];
  prototypes = [
    require('./cursor').prototype,
    require('./command_cursor').prototype,
    require('./aggregation_cursor').prototype
  ];

  // Command name translation
  var commandTranslation = {
    _find: 'find',
    _getmore: 'getMore',
    _killcursor: 'killCursors',
    _explain: 'explain'
  };

  prototypes.forEach(function(proto) {
    // Core server method we are going to wrap
    methods.forEach(function(x) {
      var func = proto[x];

      // Add to overloaded methods
      self.overloads.push({ proto: proto, name: x, func: func });

      // The actual prototype
      proto[x] = function() {
        var cursor = this;
        var requestId = core.Query.nextRequestId();
        var ourOpId = operationIdGenerator.next();
        var parts = this.ns.split('.');
        var db = parts[0];

        // Get the collection
        parts.shift();
        var collection = parts.join('.');

        // Set the command
        var command = this.query;
        var cmd = this.s.cmd;

        // If we have a find method, set the operationId on the cursor
        if (x === '_find') {
          cursor.operationId = ourOpId;
        }

        // Do we have a find command rewrite it
        if (x === '_getmore') {
          command = {
            getMore: this.cursorState.cursorId,
            collection: collection,
            batchSize: cmd.batchSize
          };

          if (cmd.maxTimeMS) command.maxTimeMS = cmd.maxTimeMS;
        } else if (x === '_killcursor') {
          command = {
            killCursors: collection,
            cursors: [this.cursorState.cursorId]
          };
        } else if (cmd.find) {
          command = {
            find: collection,
            filter: cmd.query
          };

          if (cmd.sort) command.sort = cmd.sort;
          if (cmd.fields) command.projection = cmd.fields;
          if (cmd.limit && cmd.limit < 0) {
            command.limit = Math.abs(cmd.limit);
            command.singleBatch = true;
          } else if (cmd.limit) {
            command.limit = Math.abs(cmd.limit);
          }

          // Options
          if (cmd.skip) command.skip = cmd.skip;
          if (cmd.hint) command.hint = cmd.hint;
          if (cmd.batchSize) command.batchSize = cmd.batchSize;
          if (typeof cmd.returnKey === 'boolean') command.returnKey = cmd.returnKey;
          if (cmd.comment) command.comment = cmd.comment;
          if (cmd.min) command.min = cmd.min;
          if (cmd.max) command.max = cmd.max;
          if (cmd.maxScan) command.maxScan = cmd.maxScan;
          if (cmd.maxTimeMS) command.maxTimeMS = cmd.maxTimeMS;

          // Flags
          if (typeof cmd.awaitData === 'boolean') command.awaitData = cmd.awaitData;
          if (typeof cmd.snapshot === 'boolean') command.snapshot = cmd.snapshot;
          if (typeof cmd.tailable === 'boolean') command.tailable = cmd.tailable;
          if (typeof cmd.oplogReplay === 'boolean') command.oplogReplay = cmd.oplogReplay;
          if (typeof cmd.noCursorTimeout === 'boolean')
            command.noCursorTimeout = cmd.noCursorTimeout;
          if (typeof cmd.partial === 'boolean') command.partial = cmd.partial;
          if (typeof cmd.showDiskLoc === 'boolean') command.showRecordId = cmd.showDiskLoc;

          // Read Concern
          if (cmd.readConcern) command.readConcern = cmd.readConcern;

          // Override method
          if (cmd.explain) command.explain = cmd.explain;
          if (cmd.exhaust) command.exhaust = cmd.exhaust;

          // If we have a explain flag
          if (cmd.explain) {
            // Create fake explain command
            command = {
              explain: command,
              verbosity: 'allPlansExecution'
            };

            // Set readConcern on the command if available
            if (cmd.readConcern) command.readConcern = cmd.readConcern;

            // Set up the _explain name for the command
            x = '_explain';
          }
        } else {
          command = cmd;
        }

        // Set up the connection
        var connectionId = null;

        // Set local connection
        if (this.connection) connectionId = this.connection;
        if (!connectionId && this.topology && this.topology.getConnection)
          connectionId = this.topology.getConnection();

        // Get the command Name
        var commandName = x === '_find' ? Object.keys(command)[0] : commandTranslation[x];

        // Emit the start event for the command
        command = {
          // Returns the command.
          command: command,
          // Returns the database name.
          databaseName: db,
          // Returns the command name.
          commandName: commandName,
          // Returns the driver generated request id.
          requestId: requestId,
          // Returns the driver generated operation id.
          // This is used to link events together such as bulk write operations. OPTIONAL.
          operationId: this.operationId,
          // Returns the connection id for the command. For languages that do not have this,
          // this MUST return the driver equivalent which MUST include the server address and port.
          // The name of this field is flexible to match the object that is returned from the driver.
          connectionId: connectionId
        };

        // Get the aruments
        var args = Array.prototype.slice.call(arguments, 0);

        // Get the callback
        var callback = args.pop();

        // We do not have a callback but a Promise
        if (typeof callback === 'function' || command.commandName === 'killCursors') {
          var startTime = timestampGenerator.current();
          // Emit the started event
          self.emit('started', command);

          // Emit succeeded event with killcursor if we have a legacy protocol
          if (
            command.commandName === 'killCursors' &&
            this.topology.lastIsMaster() &&
            this.topology.lastIsMaster().maxWireVersion < 4
          ) {
            // Emit the succeeded command
            command = {
              duration: timestampGenerator.duration(startTime, timestampGenerator.current()),
              commandName: commandName,
              requestId: requestId,
              operationId: cursor.operationId,
              connectionId: cursor.topology.getConnection(),
              reply: [{ ok: 1 }]
            };

            // Apply callback to the list of args
            args.push(callback);
            // Apply the call
            func.apply(this, args);
            // Emit the command
            return self.emit('succeeded', command);
          }

          // Add our callback handler
          args.push(function(err, r) {
            if (err) {
              // Command
              var command = {
                duration: timestampGenerator.duration(startTime, timestampGenerator.current()),
                commandName: commandName,
                requestId: requestId,
                operationId: ourOpId,
                connectionId: cursor.topology.getConnection(),
                failure: err
              };

              // Emit the command
              self.emit('failed', command);
            } else {
              if (r && r.documents) {
                r = r.documents[0];
              }

              if (commandName.toLowerCase() === 'getmore' && (r == null || r.cursor == null)) {
                r = {
                  cursor: {
                    id: cursor.cursorState.cursorId,
                    ns: cursor.ns,
                    nextBatch: cursor.cursorState.documents
                  },
                  ok: 1
                };
              } else if (
                (commandName.toLowerCase() === 'find' ||
                  commandName.toLowerCase() === 'aggregate' ||
                  commandName.toLowerCase() === 'listcollections') &&
                (r == null || r.cursor == null)
              ) {
                r = {
                  cursor: {
                    id: cursor.cursorState.cursorId,
                    ns: cursor.ns,
                    firstBatch: cursor.cursorState.documents
                  },
                  ok: 1
                };
              } else if (commandName.toLowerCase() === 'killcursors' && r == null) {
                r = {
                  cursorsUnknown: [cursor.cursorState.lastCursorId],
                  ok: 1
                };
              }

              // cursor id is zero, we can issue success command
              command = {
                duration: timestampGenerator.duration(startTime, timestampGenerator.current()),
                commandName: commandName,
                requestId: requestId,
                operationId: cursor.operationId,
                connectionId: cursor.topology.getConnection(),
                reply: r && r.result ? r.result : r
              };

              // Emit the command
              self.emit('succeeded', command);
            }

            // Return
            if (!callback) return;

            // Return to caller
            callback(err, r);
          });

          // Apply the call
          func.apply(this, args);
        } else {
          // Assume promise, push back the missing value
          args.push(callback);
          // Get the promise
          var promise = func.apply(this, args);
          // Return a new promise
          return new cursor.s.promiseLibrary(function(resolve, reject) {
            var startTime = timestampGenerator.current();
            // Emit the started event
            self.emit('started', command);
            // Execute the function
            promise
              .then(function() {
                // cursor id is zero, we can issue success command
                var command = {
                  duration: timestampGenerator.duration(startTime, timestampGenerator.current()),
                  commandName: commandName,
                  requestId: requestId,
                  operationId: cursor.operationId,
                  connectionId: cursor.topology.getConnection(),
                  reply: cursor.cursorState.documents
                };

                // Emit the command
                self.emit('succeeded', command);
              })
              .catch(function(err) {
                // Command
                var command = {
                  duration: timestampGenerator.duration(startTime, timestampGenerator.current()),
                  commandName: commandName,
                  requestId: requestId,
                  operationId: ourOpId,
                  connectionId: cursor.topology.getConnection(),
                  failure: err
                };

                // Emit the command
                self.emit('failed', command);
                // reject the promise
                reject(err);
              });
          });
        }
      };
    });
  });
};

inherits(Instrumentation, EventEmitter);

Instrumentation.prototype.uninstrument = function() {
  for (var i = 0; i < this.overloads.length; i++) {
    var obj = this.overloads[i];
    obj.proto[obj.name] = obj.func;
  }

  // Remove all listeners
  this.removeAllListeners('started');
  this.removeAllListeners('succeeded');
  this.removeAllListeners('failed');
};

module.exports = Instrumentation;