feat: add whiteListedURLs to web-socket instrumentation config

Author: lucasbento

experimental/instrumentation-websocket/src/instrumentation.ts

@@ -17,6 +17,7 @@ export class WebSocketInstrumentation<T = Record<string, unknown>> extends Instr
 
   private messageTransform: MessageTransform<T>;
   private sendTransform: MessageTransform<T>;
+  private whiteListedURLs: string[];
 
   private pendingRequests = new Map<number, PendingRequest>();
 
@@ -25,6 +26,7 @@ export class WebSocketInstrumentation<T = Record<string, unknown>> extends Instr
 
     this.messageTransform = options.messageTransform ?? this.defaultTransform;
     this.sendTransform = options.sendTransform ?? this.defaultTransform;
+    this.whiteListedURLs = options.whiteListedURLs ?? [];
   }
 
   protected init() {
@@ -88,8 +90,10 @@ export class WebSocketInstrumentation<T = Record<string, unknown>> extends Instr
       constructor(url: string, protocols?: string | string[]) {
         super(url, protocols);
 
-        if (isLocalhost(url)) {
-          console.log('Skipping WebSocket instrumentation for localhost:', url);
+        const isURLWhitelistEmpty = self.whiteListedURLs.length === 0;
+
+        if (isLocalhost(url) || (!isURLWhitelistEmpty && !self.whiteListedURLs.includes(url))) {
+          console.log('Skipping WebSocket instrumentation for non-whitelisted URL:', url);
           return;
         }
 

experimental/instrumentation-websocket/src/types.ts

@@ -7,6 +7,7 @@ export type MessageTransform<T = Record<string, unknown>> = (
 export interface WebSocketInstrumentationConfig<T = Record<string, unknown>> {
   messageTransform?: MessageTransform<T>;
   sendTransform?: MessageTransform<T>;
+  whiteListedURLs?: string[];
 }
 
 export interface PendingRequest {