@senzops/apm-node 1.1.18 → 1.2.1

package/src/instrumentation/koa.ts

@@ -0,0 +1,173 @@
+import { normalizePath } from '../core/normalizer';
+import { SenzorOptions } from '../core/types';
+import { hookRequire } from './hook';
+import { patchMethod } from './patch';
+import { wrapFrameworkHandlerWithArity } from './framework';
+
+const routerMethods = [
+  'all',
+  'del',
+  'delete',
+  'get',
+  'head',
+  'options',
+  'patch',
+  'post',
+  'put'
+];
+
+const stringifyPath = (value: unknown): string | undefined => {
+  if (typeof value === 'string') return value;
+  if (value instanceof RegExp) return value.toString();
+  if (Array.isArray(value)) {
+    return value.map(stringifyPath).filter(Boolean).join(',');
+  }
+  return undefined;
+};
+
+const getPathFromArgs = (args: any[]): string | undefined => {
+  for (const arg of args) {
+    if (typeof arg === 'function') return undefined;
+    const path = stringifyPath(arg);
+    if (path) return path;
+  }
+
+  return undefined;
+};
+
+const wrapKoaMiddleware = (
+  middleware: any,
+  options?: SenzorOptions,
+  layerPath?: string,
+  layerType: 'middleware' | 'router' | 'route_handler' = 'middleware',
+  method?: string
+) => {
+  if (typeof middleware !== 'function') return middleware;
+
+  return wrapFrameworkHandlerWithArity(
+    middleware,
+    (_thisArg, args) => {
+      const ctx = args[0];
+      const route =
+        ctx?._matchedRoute ||
+        ctx?.matched?.[0]?.path ||
+        layerPath ||
+        normalizePath(ctx?.path || ctx?.request?.path || '/');
+      const actualMethod = method || ctx?.method || ctx?.request?.method;
+      const handlerName = middleware.name || layerType;
+
+      return {
+        framework: 'koa',
+        type: layerType,
+        name:
+          layerType === 'route_handler'
+            ? `koa.request_handler ${actualMethod || ''} ${route}`.trim()
+            : `koa.${layerType} ${route || handlerName}`,
+        route,
+        method: actualMethod,
+        layerPath,
+        handlerName,
+        request: ctx?.req || ctx?.request,
+        response: ctx?.res || ctx?.response,
+        attributes: {
+          'koa.type': layerType,
+          'http.route': route,
+          path: ctx?.path || ctx?.request?.path
+        }
+      };
+    },
+    options,
+    {
+      callbackCompletesSpan: false,
+      responseEndsSpan: false
+    }
+  );
+};
+
+const patchKoaApplication = (
+  koa: any,
+  options?: SenzorOptions
+) => {
+  const proto = koa?.prototype || koa?.default?.prototype;
+  if (!proto) return;
+
+  patchMethod(
+    proto,
+    'use',
+    'senzor.koa.application.use',
+    (original) =>
+      function patchedKoaUse(this: any, middleware: any) {
+        return original.call(
+          this,
+          wrapKoaMiddleware(middleware, options, undefined, 'middleware')
+        );
+      }
+  );
+};
+
+const patchKoaRouter = (
+  routerModule: any,
+  options?: SenzorOptions
+) => {
+  const Router =
+    routerModule?.Router ||
+    routerModule?.default ||
+    routerModule;
+  const proto = Router?.prototype;
+  if (!proto) return;
+
+  patchMethod(
+    proto,
+    'use',
+    'senzor.koa.router.use',
+    (original) =>
+      function patchedKoaRouterUse(this: any, ...args: any[]) {
+        const layerPath = getPathFromArgs(args);
+        const nextArgs = args.map((arg) =>
+          typeof arg === 'function'
+            ? wrapKoaMiddleware(arg, options, layerPath, 'router')
+            : arg
+        );
+        return original.apply(this, nextArgs);
+      }
+  );
+
+  for (const method of routerMethods) {
+    patchMethod(
+      proto,
+      method,
+      `senzor.koa.router.${method}`,
+      (original) =>
+        function patchedKoaRouterMethod(this: any, ...args: any[]) {
+          const layerPath = getPathFromArgs(args);
+          const nextArgs = args.map((arg) =>
+            typeof arg === 'function'
+              ? wrapKoaMiddleware(
+                arg,
+                options,
+                layerPath,
+                'route_handler',
+                method.toUpperCase()
+              )
+              : arg
+          );
+
+          return original.apply(this, nextArgs);
+        }
+    );
+  }
+};
+
+export const instrumentKoa = (options?: SenzorOptions) => {
+  hookRequire('koa', (exports: any) => {
+    patchKoaApplication(exports, options);
+  });
+
+  hookRequire('@koa/router', (exports: any) => {
+    patchKoaRouter(exports, options);
+  });
+
+  hookRequire('koa-router', (exports: any) => {
+    patchKoaRouter(exports, options);
+  });
+};

package/src/instrumentation/mongo.ts

@@ -1,105 +1,202 @@
-import { Context } from '../core/context';
-
-export const instrumentMongo = (debug = false) => {
-  try {
-    const mongodb = require('mongodb');
-    const Collection = mongodb.Collection;
-
-    // Attempt to get Cursor classes
-    // Note: The location of these classes varies by driver version, 
-    // checking common locations
-    const FindCursor = mongodb.FindCursor || require('mongodb/lib/cursor/find_cursor').FindCursor;
-    const AggregationCursor = mongodb.AggregationCursor || require('mongodb/lib/cursor/aggregation_cursor').AggregationCursor;
-
-    if (debug) console.log('[Senzor] Instrumenting MongoDB (Collection + Cursors)...');
-
-    // --- Helper to Record Span ---
-    const recordSpan = (name: string, operation: string, collection: string, startAbs: number, traceStart: number, err?: Error) => {
-      const duration = performance.now() - startAbs;
-      Context.addSpan({
-        name: `MongoDB ${name}`,
-        type: 'db',
-        startTime: performance.now() - traceStart - duration, // Adjust start time to when op actually started
-        duration,
-        status: err ? 500 : 0,
-        meta: { collection, operation, error: err ? err.message : undefined }
-      });
-      if (debug) console.log(`[Senzor] Captured Mongo: ${name} (${duration.toFixed(2)}ms)`);
-    };
-
-    // --- 1. Instrument Immediate Operations (Insert/Update/Delete) ---
-    const immediateMethods = ['insertOne', 'insertMany', 'updateOne', 'updateMany', 'deleteOne', 'deleteMany', 'countDocuments'];
-
-    immediateMethods.forEach((method) => {
-      if (!Collection.prototype[method]) return;
-      const original = Collection.prototype[method];
-
-      Collection.prototype[method] = function (...args: any[]) {
-        const trace = Context.current();
-        if (!trace) return original.apply(this, args);
-
-        const spanStartAbs = performance.now();
-        const traceStart = trace.startTime;
-        const collName = this.collectionName;
-
-        try {
-          const result = original.apply(this, args);
-          if (result && typeof result.then === 'function') {
-            return result.then(
-              (res: any) => { recordSpan(method, method, collName, spanStartAbs, traceStart); return res; },
-              (err: any) => { recordSpan(method, method, collName, spanStartAbs, traceStart, err); throw err; }
-            );
-          }
-          return result;
-        } catch (err: any) {
-          recordSpan(method, method, collName, spanStartAbs, traceStart, err);
-          throw err;
-        }
-      };
-    });
-
-    // --- 2. Instrument Cursor Execution (find -> toArray) ---
-    const patchCursor = (CursorClass: any, label: string) => {
-      if (!CursorClass || !CursorClass.prototype.toArray) return;
-
-      const originalToArray = CursorClass.prototype.toArray;
-
-      CursorClass.prototype.toArray = function (...args: any[]) {
-        const trace = Context.current();
-        // Cursors are often created in context but executed later. 
-        // We check context at execution time.
-        if (!trace) return originalToArray.apply(this, args);
-
-        const spanStartAbs = performance.now();
-        const traceStart = trace.startTime;
-        // Attempt to get collection name from cursor internal state
-        const collName = this.namespace?.collection || 'unknown';
-
-        const onSuccess = (res: any) => {
-          recordSpan(label, label, collName, spanStartAbs, traceStart);
-          return res;
-        };
-        const onError = (err: any) => {
-          recordSpan(label, label, collName, spanStartAbs, traceStart, err);
-          throw err;
-        };
-
-        try {
-          const result = originalToArray.apply(this, args);
-          if (result && typeof result.then === 'function') {
-            return result.then(onSuccess, onError);
-          }
-          return onSuccess(result);
-        } catch (e) {
-          onError(e);
-        }
-      };
-    };
-
-    patchCursor(FindCursor, 'find');
-    patchCursor(AggregationCursor, 'aggregate');
-
-  } catch (e: any) {
-    if (debug) console.warn('[Senzor] MongoDB instrumentation warning:', e.message);
-  }
-};
+import { SenzorOptions } from '../core/types';
+import { hookRequire } from './hook';
+import { patchMethod } from './patch';
+import { runWithCapturedSpan, startCapturedSpan } from './span';
+
+const collectionName = (collection: any): string =>
+  collection?.collectionName ||
+  collection?.s?.namespace?.collection ||
+  collection?.namespace?.collection ||
+  'unknown';
+
+const databaseName = (collection: any): string | undefined =>
+  collection?.dbName ||
+  collection?.s?.namespace?.db ||
+  collection?.namespace?.db;
+
+const cursorCollectionName = (cursor: any): string =>
+  cursor?.namespace?.collection ||
+  cursor?.ns?.collection ||
+  cursor?.cursorNamespace?.collection ||
+  'unknown';
+
+const patchCollectionMethod = (
+  proto: any,
+  method: string,
+  options?: SenzorOptions
+) => {
+  patchMethod(
+    proto,
+    method,
+    `senzor.mongodb.collection.${method}`,
+    (original) =>
+      function patchedMongoCollection(this: any, ...args: any[]) {
+        const collection = collectionName(this);
+        const span = startCapturedSpan(
+          `MongoDB ${method}`,
+          'db',
+          {
+            collection,
+            operation: method,
+            'db.system.name': 'mongodb',
+            'db.collection.name': collection,
+            'db.namespace': databaseName(this)
+              ? `${databaseName(this)}.${collection}`
+              : collection,
+            'db.operation.name': method,
+            library: 'mongodb'
+          },
+          options
+        );
+
+        if (!span) return original.apply(this, args);
+
+        return runWithCapturedSpan(span, () => {
+          try {
+            const result = original.apply(this, args);
+            if (result && typeof result.then === 'function') {
+              return result.then(
+                (value: any) => {
+                  span.end(0, {
+                    matchedCount: value?.matchedCount,
+                    modifiedCount: value?.modifiedCount,
+                    deletedCount: value?.deletedCount,
+                    insertedCount: value?.insertedCount
+                  });
+                  return value;
+                },
+                (error: any) => {
+                  span.end(500, {
+                    error: error?.message,
+                    'error.type': error?.name || 'Error'
+                  });
+                  throw error;
+                }
+              );
+            }
+
+            span.end(0);
+            return result;
+          } catch (error: any) {
+            span.end(500, {
+              error: error?.message,
+              'error.type': error?.name || 'Error'
+            });
+            throw error;
+          }
+        });
+      }
+  );
+};
+
+const patchCursorMethod = (
+  proto: any,
+  method: string,
+  operation: string,
+  options?: SenzorOptions
+) => {
+  patchMethod(
+    proto,
+    method,
+    `senzor.mongodb.cursor.${operation}.${method}`,
+    (original) =>
+      function patchedMongoCursor(this: any, ...args: any[]) {
+        const collection = cursorCollectionName(this);
+        const span = startCapturedSpan(
+          `MongoDB ${operation}`,
+          'db',
+          {
+            collection,
+            operation,
+            'db.system.name': 'mongodb',
+            'db.collection.name': collection,
+            'db.operation.name': operation,
+            library: 'mongodb'
+          },
+          options
+        );
+
+        if (!span) return original.apply(this, args);
+
+        return runWithCapturedSpan(span, () => {
+          try {
+            const result = original.apply(this, args);
+            if (result && typeof result.then === 'function') {
+              return result.then(
+                (value: any) => {
+                  span.end(0, {
+                    resultCount: Array.isArray(value) ? value.length : undefined
+                  });
+                  return value;
+                },
+                (error: any) => {
+                  span.end(500, {
+                    error: error?.message,
+                    'error.type': error?.name || 'Error'
+                  });
+                  throw error;
+                }
+              );
+            }
+
+            span.end(0);
+            return result;
+          } catch (error: any) {
+            span.end(500, {
+              error: error?.message,
+              'error.type': error?.name || 'Error'
+            });
+            throw error;
+          }
+        });
+      }
+  );
+};
+
+const patchMongo = (mongodb: any, options?: SenzorOptions) => {
+  const Collection = mongodb?.Collection || mongodb?.default?.Collection;
+  const collectionProto = Collection?.prototype;
+
+  [
+    'insertOne',
+    'insertMany',
+    'updateOne',
+    'updateMany',
+    'replaceOne',
+    'deleteOne',
+    'deleteMany',
+    'findOne',
+    'findOneAndUpdate',
+    'findOneAndDelete',
+    'findOneAndReplace',
+    'countDocuments',
+    'estimatedDocumentCount',
+    'distinct',
+    'bulkWrite',
+    'createIndex',
+    'dropIndex'
+  ].forEach((method) =>
+    patchCollectionMethod(collectionProto, method, options)
+  );
+
+  const FindCursor =
+    mongodb?.FindCursor || mongodb?.default?.FindCursor;
+  const AggregationCursor =
+    mongodb?.AggregationCursor || mongodb?.default?.AggregationCursor;
+
+  ['toArray', 'next', 'forEach'].forEach((method) =>
+    patchCursorMethod(FindCursor?.prototype, method, 'find', options)
+  );
+  ['toArray', 'next', 'forEach'].forEach((method) =>
+    patchCursorMethod(
+      AggregationCursor?.prototype,
+      method,
+      'aggregate',
+      options
+    )
+  );
+};
+
+export const instrumentMongo = (options?: SenzorOptions) => {
+  hookRequire('mongodb', (exports: any) => patchMongo(exports, options));
+};

package/src/instrumentation/mongoose.ts

@@ -0,0 +1,156 @@
+import { SenzorOptions } from '../core/types';
+import { hookRequire } from './hook';
+import { patchMethod } from './patch';
+import { runWithCapturedSpan, startCapturedSpan } from './span';
+
+const modelName = (target: any): string =>
+  target?.model?.modelName ||
+  target?.constructor?.modelName ||
+  target?.modelName ||
+  'unknown';
+
+const collectionName = (target: any): string =>
+  target?.mongooseCollection?.name ||
+  target?.collection?.name ||
+  target?.model?.collection?.name ||
+  'unknown';
+
+const patchExec = (
+  proto: any,
+  label: 'query' | 'aggregate',
+  options?: SenzorOptions
+) => {
+  patchMethod(
+    proto,
+    'exec',
+    `senzor.mongoose.${label}.exec`,
+    (original) =>
+      function patchedMongooseExec(this: any, ...args: any[]) {
+        const operation =
+          String(this?.op || this?._op || label).toUpperCase();
+        const collection = collectionName(this);
+        const span = startCapturedSpan(
+          `Mongoose ${operation}`,
+          'db',
+          {
+            collection,
+            model: modelName(this),
+            operation,
+            'db.system.name': 'mongodb',
+            'db.collection.name': collection,
+            'db.operation.name': operation,
+            library: 'mongoose'
+          },
+          options
+        );
+
+        if (!span) return original.apply(this, args);
+
+        return runWithCapturedSpan(span, () => {
+          try {
+            const result = original.apply(this, args);
+            if (result && typeof result.then === 'function') {
+              return result.then(
+                (value: any) => {
+                  span.end(0, {
+                    resultCount: Array.isArray(value) ? value.length : undefined
+                  });
+                  return value;
+                },
+                (error: any) => {
+                  span.end(500, {
+                    error: error?.message,
+                    'error.type': error?.name || 'Error'
+                  });
+                  throw error;
+                }
+              );
+            }
+
+            span.end(0);
+            return result;
+          } catch (error: any) {
+            span.end(500, {
+              error: error?.message,
+              'error.type': error?.name || 'Error'
+            });
+            throw error;
+          }
+        });
+      }
+  );
+};
+
+const patchSave = (modelProto: any, options?: SenzorOptions) => {
+  patchMethod(
+    modelProto,
+    'save',
+    'senzor.mongoose.model.save',
+    (original) =>
+      function patchedMongooseSave(this: any, ...args: any[]) {
+        const collection = collectionName(this);
+        const span = startCapturedSpan(
+          'Mongoose SAVE',
+          'db',
+          {
+            collection,
+            model: modelName(this),
+            operation: 'SAVE',
+            'db.system.name': 'mongodb',
+            'db.collection.name': collection,
+            'db.operation.name': 'SAVE',
+            library: 'mongoose'
+          },
+          options
+        );
+
+        if (!span) return original.apply(this, args);
+
+        return runWithCapturedSpan(span, () => {
+          try {
+            const result = original.apply(this, args);
+            if (result && typeof result.then === 'function') {
+              return result.then(
+                (value: any) => {
+                  span.end(0);
+                  return value;
+                },
+                (error: any) => {
+                  span.end(500, {
+                    error: error?.message,
+                    'error.type': error?.name || 'Error'
+                  });
+                  throw error;
+                }
+              );
+            }
+
+            span.end(0);
+            return result;
+          } catch (error: any) {
+            span.end(500, {
+              error: error?.message,
+              'error.type': error?.name || 'Error'
+            });
+            throw error;
+          }
+        });
+      }
+  );
+};
+
+const patchMongoose = (mongoose: any, options?: SenzorOptions) => {
+  patchExec(mongoose?.Query?.prototype, 'query', options);
+  patchExec(mongoose?.Aggregate?.prototype, 'aggregate', options);
+  patchSave(mongoose?.Model?.prototype, options);
+
+  if (mongoose?.default) {
+    patchExec(mongoose.default?.Query?.prototype, 'query', options);
+    patchExec(mongoose.default?.Aggregate?.prototype, 'aggregate', options);
+    patchSave(mongoose.default?.Model?.prototype, options);
+  }
+};
+
+export const instrumentMongoose = (options?: SenzorOptions) => {
+  hookRequire('mongoose', (exports: any) => patchMongoose(exports, options));
+};