Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix child spans created on immediate cb from op #41

Merged
merged 1 commit into from
Mar 24, 2021
+11 −15
Merged

fix child spans created on immediate cb from op #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 11 additions & 15 deletions src/plugins/MongoDBPlugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
*
*/

import SwPlugin, {wrapPromise} from '../core/SwPlugin';
import SwPlugin, {wrapEmit, wrapPromise} from '../core/SwPlugin';
import ContextManager from '../trace/context/ContextManager';
import { Component } from '../trace/Component';
import Tag from '../Tag';
Expand All @@ -33,21 +33,11 @@ class MongoDBPlugin implements SwPlugin {
Cursor: any;
Db: any;

// Experimental method to determine proper end time of cursor DB operation, we stop the span when the cursor is closed.
// Problematic because other exit spans may be created during processing, for this reason we do not .resync() this
// span to the span list until it is closed. If the cursor is never closed then the span will not be sent.

hookCursorMaybe(span: any, cursor: any): boolean {
if (!(cursor instanceof this.Cursor))
return false;

cursor.on('error', (err: any) => {
span.error(err);
});

cursor.on('close', () => {
span.stop();
});
wrapEmit(span, cursor, true, 'close');

return true;
}
Expand All @@ -65,6 +55,8 @@ class MongoDBPlugin implements SwPlugin {
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]);

Expand All @@ -80,6 +72,8 @@ class MongoDBPlugin implements SwPlugin {
const stringify = (params: any) => {
if (params === undefined)
return '';
else if (typeof params === 'function')
return `${params}`;

let str = JSON.stringify(params);

Expand Down Expand Up @@ -143,7 +137,7 @@ class MongoDBPlugin implements SwPlugin {
};

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

return wrapCallbackWithCursorMaybe(span, args, 2);
};
Expand Down Expand Up @@ -258,11 +252,11 @@ class MongoDBPlugin implements SwPlugin {
// TODO collection?
// group
// parallelCollectionScan
// geoHaystackSearch

// NODO collection:
// initializeUnorderedBulkOp
// initializeOrderedBulkOp
// geoHaystackSearch
// watch

// NODO db:
Expand All @@ -288,7 +282,7 @@ class MongoDBPlugin implements SwPlugin {
// if this is detected instead of opening a new span. This should not affect secondary db calls being recorded
// from a cursor since this span is kept async until the cursor is closed, at which point it is stoppped.

if (span?.component === Component.MONGODB) // mongodb has called into itself internally, span instanceof ExitSpan assumed
if (span?.component === Component.MONGODB && (span as any).mongodbInCall) // mongodb has called into itself internally, span instanceof ExitSpan assumed
return _original.apply(this, args);

let host = '???';
Expand All @@ -312,7 +306,9 @@ class MongoDBPlugin implements SwPlugin {

const hasCB = operationFunc.call(this, operation, span, args);

(span as any).mongodbInCall = true;
let ret = _original.apply(this, args);
(span as any).mongodbInCall = false;

if (!hasCB) {
if (plugin.hookCursorMaybe(span, ret)) {
Expand Down