@senzops/apm-node 1.1.18 → 1.2.1

package/src/instrumentation/mysql.ts

@@ -0,0 +1,169 @@
+import { getSqlOperation, normalizeSql } from '../core/sanitizer';
+import { SenzorOptions } from '../core/types';
+import { hookRequire } from './hook';
+import { patchMethod } from './patch';
+import { runWithCapturedSpan, startCapturedSpan } from './span';
+
+const extractSql = (args: any[]): string | undefined => {
+  const first = args[0];
+  if (typeof first === 'string') return first;
+  if (first && typeof first.sql === 'string') return first.sql;
+  return undefined;
+};
+
+const patchSqlMethod = (
+  proto: any,
+  method: 'query' | 'execute',
+  library: string,
+  options?: SenzorOptions
+) => {
+  patchMethod(
+    proto,
+    method,
+    `senzor.${library}.${method}`,
+    (original) =>
+      function patchedMysqlMethod(this: any, ...args: any[]) {
+        const sql = extractSql(args);
+        const operation = getSqlOperation(sql) || method.toUpperCase();
+        const span = startCapturedSpan(
+          `MySQL ${operation}`,
+          'db',
+          {
+            query: normalizeSql(sql, options),
+            operation,
+            'db.system.name': 'mysql',
+            'db.operation.name': operation,
+            'db.query.text': normalizeSql(sql, options),
+            library
+          },
+          options
+        );
+
+        if (!span) return original.apply(this, args);
+
+        const callbackIndex = args.findIndex(
+          (arg) => typeof arg === 'function'
+        );
+        if (callbackIndex >= 0) {
+          const originalCallback = args[callbackIndex];
+          args[callbackIndex] = function wrappedMysqlCallback(
+            this: unknown,
+            err: any,
+            rows: any
+          ) {
+            span.end(err ? 500 : 0, {
+              error: err?.message,
+              'error.type': err?.name,
+              rowCount: Array.isArray(rows) ? rows.length : undefined
+            });
+            return originalCallback.apply(this, arguments as any);
+          };
+        }
+
+        return runWithCapturedSpan(span, () => {
+          try {
+            const result = original.apply(this, args);
+
+            if (result && typeof result.then === 'function') {
+              return result.then(
+                (value: any) => {
+                  const rows = Array.isArray(value) ? value[0] : value;
+                  span.end(0, {
+                    rowCount: Array.isArray(rows) ? rows.length : undefined
+                  });
+                  return value;
+                },
+                (error: any) => {
+                  span.end(500, {
+                    error: error?.message,
+                    'error.type': error?.name || 'Error'
+                  });
+                  throw error;
+                }
+              );
+            }
+
+            if (
+              callbackIndex < 0 &&
+              result &&
+              typeof result.once === 'function'
+            ) {
+              result.once('end', () => span.end(0));
+              result.once('error', (error: Error) =>
+                span.end(500, {
+                  error: error.message,
+                  'error.type': error.name
+                })
+              );
+            } else if (callbackIndex < 0) {
+              span.end(0);
+            }
+
+            return result;
+          } catch (error: any) {
+            span.end(500, {
+              error: error?.message,
+              'error.type': error?.name || 'Error'
+            });
+            throw error;
+          }
+        });
+      }
+  );
+};
+
+const patchKnownPrototypes = (
+  mysql: any,
+  library: string,
+  options?: SenzorOptions
+) => {
+  [
+    mysql?.Connection?.prototype,
+    mysql?.Pool?.prototype,
+    mysql?.PoolConnection?.prototype,
+    mysql?.PromiseConnection?.prototype,
+    mysql?.PromisePool?.prototype,
+    mysql?.default?.Connection?.prototype,
+    mysql?.default?.Pool?.prototype
+  ].forEach((proto) => {
+    patchSqlMethod(proto, 'query', library, options);
+    patchSqlMethod(proto, 'execute', library, options);
+  });
+};
+
+const patchFactories = (
+  mysql: any,
+  library: string,
+  options?: SenzorOptions
+) => {
+  ['createConnection', 'createPool'].forEach((factory) => {
+    patchMethod(
+      mysql,
+      factory,
+      `senzor.${library}.${factory}`,
+      (original) =>
+        function patchedMysqlFactory(this: any, ...args: any[]) {
+          const client = original.apply(this, args);
+          patchSqlMethod(client, 'query', library, options);
+          patchSqlMethod(client, 'execute', library, options);
+          patchSqlMethod(Object.getPrototypeOf(client), 'query', library, options);
+          patchSqlMethod(Object.getPrototypeOf(client), 'execute', library, options);
+          return client;
+        }
+    );
+  });
+};
+
+const patchMysql = (
+  mysql: any,
+  library: string,
+  options?: SenzorOptions
+) => {
+  patchKnownPrototypes(mysql, library, options);
+  patchFactories(mysql, library, options);
+};
+
+export const instrumentMysql = (options?: SenzorOptions) => {
+  hookRequire('mysql', (exports: any) => patchMysql(exports, 'mysql', options));
+  hookRequire('mysql2', (exports: any) => patchMysql(exports, 'mysql2', options));
+};

package/src/instrumentation/patch.ts

@@ -0,0 +1,56 @@
+const PATCHES = Symbol.for('senzor.patch.keys');
+const ORIGINAL = Symbol.for('senzor.patch.original');
+
+type WrappedFunction = Function & {
+  [PATCHES]?: Set<string>;
+  [ORIGINAL]?: Function;
+};
+
+export const patchMethod = (
+  target: any,
+  methodName: string,
+  patchKey: string,
+  wrapper: (original: Function) => Function
+): boolean => {
+  if (!target) return false;
+
+  const current = target[methodName] as WrappedFunction | undefined;
+  if (typeof current !== 'function') return false;
+
+  const existingPatches = current[PATCHES];
+  if (existingPatches?.has(patchKey)) return false;
+
+  const original = current[ORIGINAL] || current;
+  const wrapped = wrapper(current) as WrappedFunction;
+  const patches = new Set(existingPatches || []);
+  patches.add(patchKey);
+
+  try {
+    Object.defineProperty(wrapped, PATCHES, {
+      value: patches,
+      enumerable: false
+    });
+    Object.defineProperty(wrapped, ORIGINAL, {
+      value: original,
+      enumerable: false
+    });
+  } catch {
+    return false;
+  }
+
+  try {
+    target[methodName] = wrapped;
+    return true;
+  } catch {
+    return false;
+  }
+};
+
+export const isPatched = (
+  target: any,
+  methodName: string,
+  patchKey: string
+): boolean => {
+  const current = target?.[methodName] as WrappedFunction | undefined;
+  return Boolean(current?.[PATCHES]?.has(patchKey));
+};

package/src/instrumentation/pg.ts

@@ -1,41 +1,131 @@
-import { Context } from '../core/context';
-
-// Simple shim for 'pg' library
-export const instrumentPg = () => {
-  try {
-    // Try to require pg (it might not be installed by user)
-    const pg = require('pg');
-    const originalQuery = pg.Client.prototype.query;
-
-    pg.Client.prototype.query = function (...args: any[]) {
-      const trace = Context.current();
-      if (!trace) return originalQuery.apply(this, args);
-
-      const startTime = performance.now() - trace.startTime;
-      const spanStartAbs = performance.now();
-
-      // Extract SQL (first arg usually string or config object)
-      const sql = typeof args[0] === 'string' ? args[0] : args[0].text;
-
-      // Wrap callback if present, or handle Promise
-      const result = originalQuery.apply(this, args);
-
-      if (result && typeof result.then === 'function') {
-        return result.then((res: any) => {
-          const duration = performance.now() - spanStartAbs;
-          Context.addSpan({
-            name: 'Postgres Query',
-            type: 'db',
-            startTime,
-            duration,
-            meta: { query: sql }
-          });
-          return res;
-        });
-      }
-      return result;
-    };
-  } catch (e) {
-    // User doesn't use pg, ignore
-  }
-};
+import { getSqlOperation, normalizeSql } from '../core/sanitizer';
+import { SenzorOptions } from '../core/types';
+import { hookRequire } from './hook';
+import { patchMethod } from './patch';
+import { runWithCapturedSpan, startCapturedSpan } from './span';
+
+const extractSql = (args: any[]): string | undefined => {
+  const first = args[0];
+  if (typeof first === 'string') return first;
+  if (first && typeof first.text === 'string') return first.text;
+  return undefined;
+};
+
+const wrapQueryMethod = (
+  proto: any,
+  label: string,
+  options?: SenzorOptions
+) => {
+  patchMethod(
+    proto,
+    'query',
+    `senzor.pg.${label}.query`,
+    (original) =>
+      function patchedPgQuery(this: any, ...args: any[]) {
+        const sql = extractSql(args);
+        const operation = getSqlOperation(sql) || 'QUERY';
+        const span = startCapturedSpan(
+          `Postgres ${operation}`,
+          'db',
+          {
+            query: normalizeSql(sql, options),
+            operation,
+            'db.system.name': 'postgresql',
+            'db.operation.name': operation,
+            'db.query.text': normalizeSql(sql, options),
+            library: 'pg'
+          },
+          options
+        );
+
+        if (!span) return original.apply(this, args);
+
+        const callbackIndex = args.findIndex(
+          (arg) => typeof arg === 'function'
+        );
+
+        if (callbackIndex >= 0) {
+          const originalCallback = args[callbackIndex];
+          args[callbackIndex] = function wrappedPgCallback(
+            this: unknown,
+            err: Error | null,
+            result: any
+          ) {
+            span.end(err ? 500 : 0, {
+              error: err?.message,
+              'error.type': err?.name,
+              rowCount: result?.rowCount,
+              'db.response.row_count': result?.rowCount
+            });
+
+            return originalCallback.apply(this, arguments as any);
+          };
+        }
+
+        return runWithCapturedSpan(span, () => {
+          try {
+            const result = original.apply(this, args);
+
+            if (result && typeof result.then === 'function') {
+              return result.then(
+                (value: any) => {
+                  span.end(0, {
+                    rowCount: value?.rowCount,
+                    'db.response.row_count': value?.rowCount
+                  });
+                  return value;
+                },
+                (error: any) => {
+                  span.end(500, {
+                    error: error?.message,
+                    'error.type': error?.name || 'Error'
+                  });
+                  throw error;
+                }
+              );
+            }
+
+            if (
+              callbackIndex < 0 &&
+              result &&
+              typeof result.once === 'function'
+            ) {
+              result.once('end', () => span.end(0));
+              result.once('error', (error: Error) =>
+                span.end(500, {
+                  error: error.message,
+                  'error.type': error.name
+                })
+              );
+            } else if (callbackIndex < 0) {
+              span.end(0);
+            }
+
+            return result;
+          } catch (error: any) {
+            span.end(500, {
+              error: error?.message,
+              'error.type': error?.name || 'Error'
+            });
+            throw error;
+          }
+        });
+      }
+  );
+};
+
+const patchPg = (pg: any, options?: SenzorOptions) => {
+  if (!pg) return;
+
+  wrapQueryMethod(pg.Client?.prototype, 'client', options);
+  wrapQueryMethod(pg.Pool?.prototype, 'pool', options);
+
+  if (pg.default) {
+    wrapQueryMethod(pg.default.Client?.prototype, 'default.client', options);
+    wrapQueryMethod(pg.default.Pool?.prototype, 'default.pool', options);
+  }
+};
+
+export const instrumentPg = (options?: SenzorOptions) => {
+  hookRequire('pg', (exports: any) => patchPg(exports, options));
+};

package/src/instrumentation/redis.ts

@@ -0,0 +1,109 @@
+import { SenzorOptions } from '../core/types';
+import { hookRequire } from './hook';
+import { patchMethod } from './patch';
+import { runWithCapturedSpan, startCapturedSpan } from './span';
+
+const getCommandName = (command: any): string => {
+  if (typeof command === 'string') return command.toUpperCase();
+  if (Array.isArray(command)) return String(command[0] || 'COMMAND').toUpperCase();
+  if (command?.name) return String(command.name).toUpperCase();
+  if (Array.isArray(command?.args)) return String(command.args[0] || 'COMMAND').toUpperCase();
+  return 'COMMAND';
+};
+
+const patchSendCommand = (
+  target: any,
+  label: string,
+  options?: SenzorOptions
+) => {
+  patchMethod(
+    target,
+    'sendCommand',
+    `senzor.redis.${label}.sendCommand`,
+    (original) =>
+      function patchedRedisSendCommand(this: any, command: any, ...args: any[]) {
+        const commandName = getCommandName(command);
+        const span = startCapturedSpan(
+          `Redis ${commandName}`,
+          'db',
+          {
+            command: commandName,
+            operation: commandName,
+            'db.system.name': label === 'ioredis' ? 'redis' : 'redis',
+            'db.operation.name': commandName,
+            library: label
+          },
+          options
+        );
+
+        if (!span) return original.apply(this, arguments as any);
+
+        return runWithCapturedSpan(span, () => {
+          try {
+            const result = original.call(this, command, ...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 patchCreatedClient = (
+  client: any,
+  label: string,
+  options?: SenzorOptions
+) => {
+  patchSendCommand(client, label, options);
+  patchSendCommand(Object.getPrototypeOf(client), label, options);
+  return client;
+};
+
+const patchRedisPackage = (redis: any, options?: SenzorOptions) => {
+  ['createClient', 'createCluster'].forEach((factory) => {
+    patchMethod(
+      redis,
+      factory,
+      `senzor.redis.${factory}`,
+      (original) =>
+        function patchedRedisFactory(this: any, ...args: any[]) {
+          const client = original.apply(this, args);
+          return patchCreatedClient(client, 'redis', options);
+        }
+    );
+  });
+};
+
+const patchIORedisPackage = (ioredis: any, options?: SenzorOptions) => {
+  patchSendCommand(ioredis?.prototype, 'ioredis', options);
+  patchSendCommand(ioredis?.Redis?.prototype, 'ioredis', options);
+  patchSendCommand(ioredis?.Cluster?.prototype, 'ioredis-cluster', options);
+  patchSendCommand(ioredis?.default?.prototype, 'ioredis', options);
+};
+
+export const instrumentRedis = (options?: SenzorOptions) => {
+  hookRequire('redis', (exports: any) => patchRedisPackage(exports, options));
+  hookRequire('ioredis', (exports: any) => patchIORedisPackage(exports, options));
+};

package/src/instrumentation/span.ts

@@ -0,0 +1,73 @@
+import { Context } from '../core/context';
+import { sanitizeAttributes } from '../core/sanitizer';
+import { ActiveTrace, SenzorOptions, Span } from '../core/types';
+import { generateSpanId } from '../utils/ids';
+
+type SpanType = Span['type'];
+
+export interface CapturedSpan {
+  spanId: string;
+  parentSpanId?: string;
+  trace?: ActiveTrace;
+  end: (
+    status?: number,
+    meta?: Record<string, unknown>
+  ) => void;
+}
+
+export const startCapturedSpan = (
+  name: string,
+  type: SpanType,
+  meta: Record<string, unknown> = {},
+  options?: SenzorOptions
+): CapturedSpan | null => {
+  const trace = Context.current();
+  if (!trace) return null;
+
+  const spanId = generateSpanId();
+  const parentSpanId = trace.activeSpanId;
+  const startTime = performance.now() - trace.startTime;
+  const startedAt = performance.now();
+  let ended = false;
+
+  return {
+    spanId,
+    parentSpanId,
+    trace,
+    end: (
+      status?: number,
+      extraMeta: Record<string, unknown> = {}
+    ) => {
+      if (ended) return;
+      ended = true;
+
+      const mergedMeta = sanitizeAttributes(
+        {
+          ...meta,
+          ...extraMeta,
+          parentSpanId
+        },
+        options
+      );
+
+      Context.addSpanToTrace(trace, {
+        spanId,
+        parentSpanId,
+        name,
+        type,
+        startTime,
+        duration: performance.now() - startedAt,
+        status,
+        meta: mergedMeta
+      });
+    }
+  };
+};
+
+export const runWithCapturedSpan = <T>(
+  span: CapturedSpan | null,
+  fn: () => T
+): T => {
+  if (!span) return fn();
+  return Context.withActiveSpan(span.spanId, fn);
+};