ref(browser): Use debug instead of logger (#17029)

AbhiPrasad · web-flow · commit 3c63bec9c3ce · 2025-07-16T09:38:58.000+02:00
resolves #16952 resolves #16951
diff --git a/packages/browser-utils/src/getNativeImplementation.ts b/packages/browser-utils/src/getNativeImplementation.ts
@@ -1,4 +1,4 @@
-import { isNativeFunction, logger } from '@sentry/core';
+import { debug, isNativeFunction } from '@sentry/core';
 import { DEBUG_BUILD } from './debug-build';
 import { WINDOW } from './types';
 
@@ -53,7 +53,7 @@ export function getNativeImplementation<T extends keyof CacheableImplementations
       document.head.removeChild(sandbox);
     } catch (e) {
       // Could not create sandbox iframe, just use window.xxx
-      DEBUG_BUILD && logger.warn(`Could not create sandbox iframe for ${name} check, bailing to window.${name}: `, e);
+      DEBUG_BUILD && debug.warn(`Could not create sandbox iframe for ${name} check, bailing to window.${name}: `, e);
     }
   }
 
diff --git a/packages/browser-utils/src/metrics/cls.ts b/packages/browser-utils/src/metrics/cls.ts
@@ -1,9 +1,9 @@
 import type { Client, SpanAttributes } from '@sentry/core';
 import {
   browserPerformanceTimeOrigin,
+  debug,
   getCurrentScope,
   htmlTreeAsString,
-  logger,
   SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME,
   SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT,
   SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE,
@@ -53,7 +53,7 @@ function sendStandaloneClsSpan(
   pageloadSpanId: string,
   reportEvent: WebVitalReportEvent,
 ) {
-  DEBUG_BUILD && logger.log(`Sending CLS span (${clsValue})`);
+  DEBUG_BUILD && debug.log(`Sending CLS span (${clsValue})`);
 
   const startTime = msToSec((browserPerformanceTimeOrigin() || 0) + (entry?.startTime || 0));
   const routeName = getCurrentScope().getScopeData().transactionName;
diff --git a/packages/browser-utils/src/metrics/instrument.ts b/packages/browser-utils/src/metrics/instrument.ts
@@ -1,4 +1,4 @@
-import { getFunctionName, logger } from '@sentry/core';
+import { debug, getFunctionName } from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
 import { onCLS } from './web-vitals/getCLS';
 import { onFID } from './web-vitals/getFID';
@@ -214,7 +214,7 @@ function triggerHandlers(type: InstrumentHandlerType, data: unknown): void {
       handler(data);
     } catch (e) {
       DEBUG_BUILD &&
-        logger.error(
+        debug.error(
           `Error while triggering instrumentation handler.\nType: ${type}\nName: ${getFunctionName(handler)}\nError:`,
           e,
         );
diff --git a/packages/browser-utils/src/metrics/lcp.ts b/packages/browser-utils/src/metrics/lcp.ts
@@ -1,9 +1,9 @@
 import type { Client, SpanAttributes } from '@sentry/core';
 import {
   browserPerformanceTimeOrigin,
+  debug,
   getCurrentScope,
   htmlTreeAsString,
-  logger,
   SEMANTIC_ATTRIBUTE_EXCLUSIVE_TIME,
   SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_UNIT,
   SEMANTIC_ATTRIBUTE_SENTRY_MEASUREMENT_VALUE,
@@ -56,7 +56,7 @@ export function _sendStandaloneLcpSpan(
   pageloadSpanId: string,
   reportEvent: WebVitalReportEvent,
 ) {
-  DEBUG_BUILD && logger.log(`Sending LCP span (${lcpValue})`);
+  DEBUG_BUILD && debug.log(`Sending LCP span (${lcpValue})`);
 
   const startTime = msToSec((browserPerformanceTimeOrigin() || 0) + (entry?.startTime || 0));
   const routeName = getCurrentScope().getScopeData().transactionName;
diff --git a/packages/browser/src/integrations/breadcrumbs.ts b/packages/browser/src/integrations/breadcrumbs.ts
@@ -19,13 +19,13 @@ import {
   addBreadcrumb,
   addConsoleInstrumentationHandler,
   addFetchInstrumentationHandler,
+  debug,
   defineIntegration,
   getBreadcrumbLogLevelFromHttpStatusCode,
   getClient,
   getComponentName,
   getEventDescription,
   htmlTreeAsString,
-  logger,
   parseUrl,
   safeJoin,
   severityLevelFromString,
@@ -142,7 +142,7 @@ function _getDomBreadcrumbHandler(
       typeof dom === 'object' && typeof dom.maxStringLength === 'number' ? dom.maxStringLength : undefined;
     if (maxStringLength && maxStringLength > MAX_ALLOWED_STRING_LENGTH) {
       DEBUG_BUILD &&
-        logger.warn(
+        debug.warn(
           `\`dom.maxStringLength\` cannot exceed ${MAX_ALLOWED_STRING_LENGTH}, but a value of ${maxStringLength} was configured. Sentry will use ${MAX_ALLOWED_STRING_LENGTH} instead.`,
         );
       maxStringLength = MAX_ALLOWED_STRING_LENGTH;
diff --git a/packages/browser/src/integrations/browsersession.ts b/packages/browser/src/integrations/browsersession.ts
@@ -1,4 +1,4 @@
-import { captureSession, defineIntegration, logger, startSession } from '@sentry/core';
+import { captureSession, debug, defineIntegration, startSession } from '@sentry/core';
 import { addHistoryInstrumentationHandler } from '@sentry-internal/browser-utils';
 import { DEBUG_BUILD } from '../debug-build';
 import { WINDOW } from '../helpers';
@@ -15,7 +15,7 @@ export const browserSessionIntegration = defineIntegration(() => {
     setupOnce() {
       if (typeof WINDOW.document === 'undefined') {
         DEBUG_BUILD &&
-          logger.warn('Using the `browserSessionIntegration` in non-browser environments is not supported.');
+          debug.warn('Using the `browserSessionIntegration` in non-browser environments is not supported.');
         return;
       }
 
diff --git a/packages/browser/src/integrations/featureFlags/unleash/integration.ts b/packages/browser/src/integrations/featureFlags/unleash/integration.ts
@@ -3,9 +3,9 @@ import {
   _INTERNAL_addFeatureFlagToActiveSpan,
   _INTERNAL_copyFlagsFromScopeToEvent,
   _INTERNAL_insertFlagToScope,
+  debug,
   defineIntegration,
   fill,
-  logger,
 } from '@sentry/core';
 import { DEBUG_BUILD } from '../../../debug-build';
 import type { UnleashClient, UnleashClientClass } from './types';
@@ -73,7 +73,7 @@ function _wrappedIsEnabled(
       _INTERNAL_insertFlagToScope(toggleName, result);
       _INTERNAL_addFeatureFlagToActiveSpan(toggleName, result);
     } else if (DEBUG_BUILD) {
-      logger.error(
+      debug.error(
         `[Feature Flags] UnleashClient.isEnabled does not match expected signature. arg0: ${toggleName} (${typeof toggleName}), result: ${result} (${typeof result})`,
       );
     }
diff --git a/packages/browser/src/integrations/globalhandlers.ts b/packages/browser/src/integrations/globalhandlers.ts
@@ -3,12 +3,12 @@ import {
   addGlobalErrorInstrumentationHandler,
   addGlobalUnhandledRejectionInstrumentationHandler,
   captureEvent,
+  debug,
   defineIntegration,
   getClient,
   getLocationHref,
   isPrimitive,
   isString,
-  logger,
   UNKNOWN_FUNCTION,
 } from '@sentry/core';
 import type { BrowserClient } from '../client';
@@ -188,7 +188,7 @@ function _enhanceEventWithInitialFrame(
 }
 
 function globalHandlerLog(type: string): void {
-  DEBUG_BUILD && logger.log(`Global Handler attached: ${type}`);
+  DEBUG_BUILD && debug.log(`Global Handler attached: ${type}`);
 }
 
 function getOptions(): { stackParser: StackParser; attachStacktrace?: boolean } {
diff --git a/packages/browser/src/integrations/httpclient.ts b/packages/browser/src/integrations/httpclient.ts
@@ -3,11 +3,11 @@ import {
   addExceptionMechanism,
   addFetchInstrumentationHandler,
   captureEvent,
+  debug,
   defineIntegration,
   getClient,
   GLOBAL_OBJ,
   isSentryRequestUrl,
-  logger,
   supportsNativeFetch,
 } from '@sentry/core';
 import { addXhrInstrumentationHandler, SENTRY_XHR_DATA_KEY } from '@sentry-internal/browser-utils';
@@ -333,7 +333,7 @@ function _wrapXHR(client: Client, options: HttpClientOptions): void {
     try {
       _xhrResponseHandler(options, xhr, method, headers, error || virtualError);
     } catch (e) {
-      DEBUG_BUILD && logger.warn('Error while extracting response event form XHR response', e);
+      DEBUG_BUILD && debug.warn('Error while extracting response event form XHR response', e);
     }
   });
 }
diff --git a/packages/browser/src/integrations/spotlight.ts b/packages/browser/src/integrations/spotlight.ts
@@ -1,5 +1,5 @@
 import type { Client, Envelope, Event, IntegrationFn } from '@sentry/core';
-import { defineIntegration, logger, serializeEnvelope } from '@sentry/core';
+import { debug, defineIntegration, serializeEnvelope } from '@sentry/core';
 import { getNativeImplementation } from '@sentry-internal/browser-utils';
 import { DEBUG_BUILD } from '../debug-build';
 import type { WINDOW } from '../helpers';
@@ -20,7 +20,7 @@ const _spotlightIntegration = ((options: Partial<SpotlightConnectionOptions> = {
   return {
     name: INTEGRATION_NAME,
     setup: () => {
-      DEBUG_BUILD && logger.log('Using Sidecar URL', sidecarUrl);
+      DEBUG_BUILD && debug.log('Using Sidecar URL', sidecarUrl);
     },
     // We don't want to send interaction transactions/root spans created from
     // clicks within Spotlight to Sentry. Neither do we want them to be sent to
@@ -38,7 +38,7 @@ function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
 
   client.on('beforeEnvelope', (envelope: Envelope) => {
     if (failCount > 3) {
-      logger.warn('[Spotlight] Disabled Sentry -> Spotlight integration due to too many failed requests:', failCount);
+      debug.warn('[Spotlight] Disabled Sentry -> Spotlight integration due to too many failed requests:', failCount);
       return;
     }
 
@@ -58,7 +58,7 @@ function setupSidecarForwarding(client: Client, sidecarUrl: string): void {
       },
       err => {
         failCount++;
-        logger.error(
+        debug.error(
           "Sentry SDK can't connect to Sidecar is it running? See: https://spotlightjs.com/sidecar/npx/",
           err,
         );
diff --git a/packages/browser/src/profiling/integration.ts b/packages/browser/src/profiling/integration.ts
@@ -1,5 +1,5 @@
 import type { EventEnvelope, IntegrationFn, Profile, Span } from '@sentry/core';
-import { defineIntegration, getActiveSpan, getRootSpan, logger } from '@sentry/core';
+import { debug, defineIntegration, getActiveSpan, getRootSpan } from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
 import { startProfileForSpan } from './startProfileForSpan';
 import type { ProfiledEvent } from './utils';
@@ -53,12 +53,12 @@ const _browserProfilingIntegration = (() => {
           const start_timestamp = context?.profile?.['start_timestamp'];
 
           if (typeof profile_id !== 'string') {
-            DEBUG_BUILD && logger.log('[Profiling] cannot find profile for a span without a profile context');
+            DEBUG_BUILD && debug.log('[Profiling] cannot find profile for a span without a profile context');
             continue;
           }
 
           if (!profile_id) {
-            DEBUG_BUILD && logger.log('[Profiling] cannot find profile for a span without a profile context');
+            DEBUG_BUILD && debug.log('[Profiling] cannot find profile for a span without a profile context');
             continue;
           }
 
@@ -69,7 +69,7 @@ const _browserProfilingIntegration = (() => {
 
           const profile = takeProfileFromGlobalCache(profile_id);
           if (!profile) {
-            DEBUG_BUILD && logger.log(`[Profiling] Could not retrieve profile for span: ${profile_id}`);
+            DEBUG_BUILD && debug.log(`[Profiling] Could not retrieve profile for span: ${profile_id}`);
             continue;
           }
 
diff --git a/packages/browser/src/profiling/startProfileForSpan.ts b/packages/browser/src/profiling/startProfileForSpan.ts
@@ -1,5 +1,5 @@
 import type { Span } from '@sentry/core';
-import { getCurrentScope, logger, spanToJSON, timestampInSeconds, uuid4 } from '@sentry/core';
+import { debug, getCurrentScope, spanToJSON, timestampInSeconds, uuid4 } from '@sentry/core';
 import { DEBUG_BUILD } from '../debug-build';
 import { WINDOW } from '../helpers';
 import type { JSSelfProfile } from './jsSelfProfiling';
@@ -26,7 +26,7 @@ export function startProfileForSpan(span: Span): void {
   }
 
   if (DEBUG_BUILD) {
-    logger.log(`[Profiling] started profiling span: ${spanToJSON(span).description}`);
+    debug.log(`[Profiling] started profiling span: ${spanToJSON(span).description}`);
   }
 
   // We create "unique" span names to avoid concurrent spans with same names
@@ -62,7 +62,7 @@ export function startProfileForSpan(span: Span): void {
     }
     if (processedProfile) {
       if (DEBUG_BUILD) {
-        logger.log('[Profiling] profile for:', spanToJSON(span).description, 'already exists, returning early');
+        debug.log('[Profiling] profile for:', spanToJSON(span).description, 'already exists, returning early');
       }
       return;
     }
@@ -76,13 +76,13 @@ export function startProfileForSpan(span: Span): void {
         }
 
         if (DEBUG_BUILD) {
-          logger.log(`[Profiling] stopped profiling of span: ${spanToJSON(span).description}`);
+          debug.log(`[Profiling] stopped profiling of span: ${spanToJSON(span).description}`);
         }
 
         // In case of an overlapping span, stopProfiling may return null and silently ignore the overlapping profile.
         if (!profile) {
           if (DEBUG_BUILD) {
-            logger.log(
+            debug.log(
               `[Profiling] profiler returned null profile for: ${spanToJSON(span).description}`,
               'this may indicate an overlapping span or a call to stopProfiling with a profile title that was never started',
             );
@@ -94,15 +94,15 @@ export function startProfileForSpan(span: Span): void {
       })
       .catch(error => {
         if (DEBUG_BUILD) {
-          logger.log('[Profiling] error while stopping profiler:', error);
+          debug.log('[Profiling] error while stopping profiler:', error);
         }
       });
   }
 
   // Enqueue a timeout to prevent profiles from running over max duration.
   let maxDurationTimeoutID: number | undefined = WINDOW.setTimeout(() => {
     if (DEBUG_BUILD) {
-      logger.log('[Profiling] max profile duration elapsed, stopping profiling for:', spanToJSON(span).description);
+      debug.log('[Profiling] max profile duration elapsed, stopping profiling for:', spanToJSON(span).description);
     }
     // If the timeout exceeds, we want to stop profiling, but not finish the span
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
diff --git a/packages/browser/src/profiling/utils.ts b/packages/browser/src/profiling/utils.ts
diff --git a/packages/browser/src/report-dialog.ts b/packages/browser/src/report-dialog.ts
diff --git a/packages/browser/src/tracing/backgroundtab.ts b/packages/browser/src/tracing/backgroundtab.ts
diff --git a/packages/browser/src/tracing/browserTracingIntegration.ts b/packages/browser/src/tracing/browserTracingIntegration.ts
diff --git a/packages/browser/src/tracing/linkedTraces.ts b/packages/browser/src/tracing/linkedTraces.ts

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { isNativeFunction, logger } from '@sentry/core';`
	`1`	`+import { debug, isNativeFunction } from '@sentry/core';`
`2`	`2`	`import { DEBUG_BUILD } from './debug-build';`
`3`	`3`	`import { WINDOW } from './types';`
`4`	`4`
`@@ -53,7 +53,7 @@ export function getNativeImplementation<T extends keyof CacheableImplementations`
`53`	`53`	`document.head.removeChild(sandbox);`
`54`	`54`	`} catch (e) {`
`55`	`55`	`// Could not create sandbox iframe, just use window.xxx`
`56`		- DEBUG_BUILD && logger.warn(`Could not create sandbox iframe for ${name} check, bailing to window.${name}: `, e);
	`56`	+ DEBUG_BUILD && debug.warn(`Could not create sandbox iframe for ${name} check, bailing to window.${name}: `, e);
`57`	`57`	`}`
`58`	`58`	`}`
`59`	`59`