feat: Add enabled option to all db integrations

Author: HazAT

packages/tracing/src/integrations/mongo.ts

@@ -86,6 +86,7 @@ interface MongoOptions {
   operations?: Operation[];
   describeOperations?: boolean | Operation[];
   useMongoose?: boolean;
+  enabled?: boolean;
 }
 
 /** Tracing integration for mongo package */
@@ -103,6 +104,7 @@ export class Mongo implements Integration {
   private _operations: Operation[];
   private _describeOperations?: boolean | Operation[];
   private _useMongoose: boolean;
+  private _enabled: boolean;
 
   /**
    * @inheritDoc
@@ -113,6 +115,7 @@ export class Mongo implements Integration {
       : ((OPERATIONS as unknown) as Operation[]);
     this._describeOperations = 'describeOperations' in options ? options.describeOperations : true;
     this._useMongoose = !!options.useMongoose;
+    this._enabled = options === false ? false : true ;
   }
 
   /**
@@ -144,9 +147,14 @@ export class Mongo implements Integration {
     if (!(operation in collection.prototype)) return;
 
     const getSpanContext = this._getSpanContextFromOperationArguments.bind(this);
+    const enabled = this._enabled;
 
     fill(collection.prototype, operation, function(orig: () => void | Promise<unknown>) {
-      return function(this: unknown, ...args: unknown[]) {
+      return function (this: unknown, ...args: unknown[]) {
+        if (!enabled) {
+          // If the integration is not enabled, do not send spans
+          return;
+        }
         const lastArg = args[args.length - 1];
         const scope = getCurrentHub().getScope();
         const parentSpan = scope?.getSpan();

packages/tracing/src/integrations/mysql.ts

@@ -6,6 +6,10 @@ interface MysqlConnection {
   createQuery: () => void;
 }
 
+interface MysqlOptions {
+  enabled?: boolean;
+}
+
 /** Tracing integration for node-mysql package */
 export class Mysql implements Integration {
   /**
@@ -18,6 +22,15 @@ export class Mysql implements Integration {
    */
   public name: string = Mysql.id;
 
+  private _enabled: boolean;
+
+  /**
+   * @inheritDoc
+   */
+  public constructor(options: MysqlOptions = {}) {
+    this._enabled = options === false ? false : true ;
+  }
+
   /**
    * @inheritDoc
    */
@@ -29,12 +42,18 @@ export class Mysql implements Integration {
       return;
     }
 
+    const enabled = this._enabled;
+
     // The original function will have one of these signatures:
     //    function (callback) => void
     //    function (options, callback) => void
     //    function (options, values, callback) => void
     fill(pkg, 'createQuery', function(orig: () => void) {
-      return function(this: unknown, options: unknown, values: unknown, callback: unknown) {
+      return function (this: unknown, options: unknown, values: unknown, callback: unknown) {
+        if (!enabled) {
+          // If the integration is not enabled, do not send spans
+          return;
+        }
         const scope = getCurrentHub().getScope();
         const parentSpan = scope?.getSpan();
         const span = parentSpan?.startChild({

packages/tracing/src/integrations/postgres.ts

@@ -8,6 +8,10 @@ interface PgClient {
   };
 }
 
+interface PostgresOptions {
+  enabled?: boolean;
+}
+
 /** Tracing integration for node-postgres package */
 export class Postgres implements Integration {
   /**
@@ -20,6 +24,15 @@ export class Postgres implements Integration {
    */
   public name: string = Postgres.id;
 
+  private _enabled: boolean;
+
+  /**
+   * @inheritDoc
+   */
+  public constructor(options: PostgresOptions = {}) {
+    this._enabled = options === false ? false : true ;
+  }
+
   /**
    * @inheritDoc
    */
@@ -31,14 +44,20 @@ export class Postgres implements Integration {
       return;
     }
 
+    const enabled = this._enabled;
+
     /**
      * function (query, callback) => void
      * function (query, params, callback) => void
      * function (query) => Promise
      * function (query, params) => Promise
      */
-    fill(pkg.Client.prototype, 'query', function(orig: () => void | Promise<unknown>) {
-      return function(this: unknown, config: unknown, values: unknown, callback: unknown) {
+    fill(pkg.Client.prototype, 'query', function (orig: () => void | Promise<unknown>) {
+      return function (this: unknown, config: unknown, values: unknown, callback: unknown) {
+        if (!enabled) {
+          // If the integration is not enabled, do not send spans
+          return;
+        }
         const scope = getCurrentHub().getScope();
         const parentSpan = scope?.getSpan();
         const span = parentSpan?.startChild({