feat(core): Deprecate logger in favor of debug

MIGRATION.md

@@ -7,6 +7,22 @@ These docs walk through how to migrate our JavaScript SDKs through different maj
 - Upgrading from [SDK 7.x to 8.x](./docs/migration/v7-to-v8.md)
 - Upgrading from [SDK 8.x to 9.x](#upgrading-from-8x-to-9x)
 
+# Deprecations in 9.x
+
+## Deprecated `@sentry/core` SDK internal `logger` export
+
+The `logger` export from `@sentry/core` has been deprecated in favor of the `debug` export. `debug` only exposes `log`, `warn`, and `error` methods but is otherwise identical to `logger`.
+
+```js
+import { logger } from '@sentry/core';
+
+// before
+logger.info('This is an info message');
+
+// after
+debug.log('This is an info message');
+```
+
 # Upgrading from 8.x to 9.x
 
 Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.

packages/core/src/breadcrumbs.ts

@@ -1,6 +1,6 @@
 import { getClient, getIsolationScope } from './currentScopes';
 import type { Breadcrumb, BreadcrumbHint } from './types-hoist/breadcrumb';
-import { consoleSandbox } from './utils/logger';
+import { consoleSandbox } from './utils/debug-logger';
 import { dateTimestampInSeconds } from './utils/time';
 
 /**

packages/core/src/carrier.ts

@@ -3,7 +3,7 @@ import type { AsyncContextStrategy } from './asyncContext/types';
 import type { Client } from './client';
 import type { Scope } from './scope';
 import type { SerializedLog } from './types-hoist/log';
-import type { Logger } from './utils/logger';
+import type { Logger } from './utils/debug-logger';
 import { SDK_VERSION } from './utils/version';
 import { GLOBAL_OBJ } from './utils/worldwide';
 

packages/core/src/client.ts

@@ -33,11 +33,11 @@ import type { Span, SpanAttributes, SpanContextData, SpanJSON } from './types-ho
 import type { StartSpanOptions } from './types-hoist/startSpanOptions';
 import type { Transport, TransportMakeRequestResponse } from './types-hoist/transport';
 import { createClientReportEnvelope } from './utils/clientreport';
+import { debug } from './utils/debug-logger';
 import { dsnToString, makeDsn } from './utils/dsn';
 import { addItemToEnvelope, createAttachmentEnvelopeItem } from './utils/envelope';
 import { getPossibleEventMessages } from './utils/eventUtils';
 import { isParameterizedString, isPlainObject, isPrimitive, isThenable } from './utils/is';
-import { debug } from './utils/logger';
 import { merge } from './utils/merge';
 import { checkOrSetAlreadyCaught, uuid4 } from './utils/misc';
 import { parseSampleRate } from './utils/parseSampleRate';

packages/core/src/eventProcessors.ts

@@ -1,8 +1,8 @@
 import { DEBUG_BUILD } from './debug-build';
 import type { Event, EventHint } from './types-hoist/event';
 import type { EventProcessor } from './types-hoist/eventprocessor';
+import { debug } from './utils/debug-logger';
 import { isThenable } from './utils/is';
-import { debug } from './utils/logger';
 import { SyncPromise } from './utils/syncpromise';
 
 /**

packages/core/src/exports.ts

@@ -10,8 +10,8 @@ import type { Primitive } from './types-hoist/misc';
 import type { Session, SessionContext } from './types-hoist/session';
 import type { SeverityLevel } from './types-hoist/severity';
 import type { User } from './types-hoist/user';
+import { debug } from './utils/debug-logger';
 import { isThenable } from './utils/is';
-import { debug } from './utils/logger';
 import { uuid4 } from './utils/misc';
 import type { ExclusiveEventHintOrCaptureContext } from './utils/prepareEvent';
 import { parseEventHintOrCaptureContext } from './utils/prepareEvent';

packages/core/src/index.ts

@@ -165,8 +165,10 @@ export {
   isVueViewModel,
 } from './utils/is';
 export { isBrowser } from './utils/isBrowser';
-export { CONSOLE_LEVELS, consoleSandbox, debug, logger, originalConsoleMethods } from './utils/logger';
-export type { Logger } from './utils/logger';
+// eslint-disable-next-line deprecation/deprecation
+export { CONSOLE_LEVELS, consoleSandbox, debug, logger, originalConsoleMethods } from './utils/debug-logger';
+// eslint-disable-next-line deprecation/deprecation
+export type { Logger } from './utils/debug-logger';
 export {
   addContextToFrame,
   addExceptionMechanism,

packages/core/src/instrument/console.ts

@@ -1,7 +1,7 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/ban-types */
 import type { ConsoleLevel, HandlerDataConsole } from '../types-hoist/instrument';
-import { CONSOLE_LEVELS, originalConsoleMethods } from '../utils/logger';
+import { CONSOLE_LEVELS, originalConsoleMethods } from '../utils/debug-logger';
 import { fill } from '../utils/object';
 import { GLOBAL_OBJ } from '../utils/worldwide';
 import { addHandler, maybeInstrument, triggerHandlers } from './handlers';

packages/core/src/instrument/handlers.ts

@@ -1,5 +1,5 @@
 import { DEBUG_BUILD } from '../debug-build';
-import { debug } from '../utils/logger';
+import { debug } from '../utils/debug-logger';
 import { getFunctionName } from '../utils/stacktrace';
 
 export type InstrumentHandlerType =

packages/core/src/integration.ts

@@ -4,7 +4,7 @@ import { DEBUG_BUILD } from './debug-build';
 import type { Event, EventHint } from './types-hoist/event';
 import type { Integration, IntegrationFn } from './types-hoist/integration';
 import type { Options } from './types-hoist/options';
-import { debug } from './utils/logger';
+import { debug } from './utils/debug-logger';
 
 export const installedIntegrations: string[] = [];
 

packages/core/src/integrations/captureconsole.ts

@@ -4,7 +4,7 @@ import { addConsoleInstrumentationHandler } from '../instrument/console';
 import { defineIntegration } from '../integration';
 import type { CaptureContext } from '../scope';
 import type { IntegrationFn } from '../types-hoist/integration';
-import { CONSOLE_LEVELS } from '../utils/logger';
+import { CONSOLE_LEVELS } from '../utils/debug-logger';
 import { addExceptionMechanism } from '../utils/misc';
 import { severityLevelFromString } from '../utils/severity';
 import { safeJoin } from '../utils/string';

packages/core/src/integrations/console.ts

@@ -3,7 +3,7 @@ import { getClient } from '../currentScopes';
 import { addConsoleInstrumentationHandler } from '../instrument/console';
 import { defineIntegration } from '../integration';
 import type { ConsoleLevel } from '../types-hoist/instrument';
-import { CONSOLE_LEVELS } from '../utils/logger';
+import { CONSOLE_LEVELS } from '../utils/debug-logger';
 import { severityLevelFromString } from '../utils/severity';
 import { safeJoin } from '../utils/string';
 import { GLOBAL_OBJ } from '../utils/worldwide';

packages/core/src/integrations/dedupe.ts

@@ -4,7 +4,7 @@ import type { Event } from '../types-hoist/event';
 import type { Exception } from '../types-hoist/exception';
 import type { IntegrationFn } from '../types-hoist/integration';
 import type { StackFrame } from '../types-hoist/stackframe';
-import { debug } from '../utils/logger';
+import { debug } from '../utils/debug-logger';
 import { getFramesFromEvent } from '../utils/stacktrace';
 
 const INTEGRATION_NAME = 'Dedupe';

packages/core/src/integrations/eventFilters.ts

@@ -3,8 +3,8 @@ import { defineIntegration } from '../integration';
 import type { Event } from '../types-hoist/event';
 import type { IntegrationFn } from '../types-hoist/integration';
 import type { StackFrame } from '../types-hoist/stackframe';
+import { debug } from '../utils/debug-logger';
 import { getPossibleEventMessages } from '../utils/eventUtils';
-import { debug } from '../utils/logger';
 import { getEventDescription } from '../utils/misc';
 import { stringMatchesSomePattern } from '../utils/string';
 

packages/core/src/integrations/extraerrordata.ts

@@ -4,8 +4,8 @@ import type { Contexts } from '../types-hoist/context';
 import type { ExtendedError } from '../types-hoist/error';
 import type { Event, EventHint } from '../types-hoist/event';
 import type { IntegrationFn } from '../types-hoist/integration';
+import { debug } from '../utils/debug-logger';
 import { isError, isPlainObject } from '../utils/is';
-import { debug } from '../utils/logger';
 import { normalize } from '../utils/normalize';
 import { addNonEnumerableProperty } from '../utils/object';
 import { truncate } from '../utils/string';

packages/core/src/integrations/supabase.ts

@@ -9,8 +9,8 @@ import { defineIntegration } from '../integration';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../semanticAttributes';
 import { setHttpStatus, SPAN_STATUS_ERROR, SPAN_STATUS_OK, startSpan } from '../tracing';
 import type { IntegrationFn } from '../types-hoist/integration';
+import { debug } from '../utils/debug-logger';
 import { isPlainObject } from '../utils/is';
-import { debug } from '../utils/logger';
 
 const AUTH_OPERATIONS_TO_INSTRUMENT = [
   'reauthenticate',

packages/core/src/logs/console-integration.ts

@@ -5,8 +5,8 @@ import { defineIntegration } from '../integration';
 import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../semanticAttributes';
 import type { ConsoleLevel } from '../types-hoist/instrument';
 import type { IntegrationFn } from '../types-hoist/integration';
+import { CONSOLE_LEVELS, debug } from '../utils/debug-logger';
 import { isPrimitive } from '../utils/is';
-import { CONSOLE_LEVELS, debug } from '../utils/logger';
 import { normalize } from '../utils/normalize';
 import { GLOBAL_OBJ } from '../utils/worldwide';
 import { _INTERNAL_captureLog } from './exports';

packages/core/src/logs/exports.ts

@@ -6,8 +6,8 @@ import { DEBUG_BUILD } from '../debug-build';
 import type { Scope, ScopeData } from '../scope';
 import type { Log, SerializedLog, SerializedLogAttributeValue } from '../types-hoist/log';
 import { mergeScopeData } from '../utils/applyScopeDataToEvent';
+import { consoleSandbox, debug } from '../utils/debug-logger';
 import { isParameterizedString } from '../utils/is';
-import { consoleSandbox, debug } from '../utils/logger';
 import { _getSpanForScope } from '../utils/spanOnScope';
 import { timestampInSeconds } from '../utils/time';
 import { SEVERITY_TEXT_TO_SEVERITY_NUMBER } from './constants';

packages/core/src/mcp-server.ts

@@ -6,7 +6,7 @@ import {
 } from './semanticAttributes';
 import { startSpan, withActiveSpan } from './tracing';
 import type { Span } from './types-hoist/span';
-import { debug } from './utils/logger';
+import { debug } from './utils/debug-logger';
 import { getActiveSpan } from './utils/spanUtils';
 
 interface MCPTransport {

packages/core/src/profiling.ts

@@ -1,7 +1,7 @@
 import { getClient } from './currentScopes';
 import { DEBUG_BUILD } from './debug-build';
 import type { Profiler, ProfilingIntegration } from './types-hoist/profiling';
-import { debug } from './utils/logger';
+import { debug } from './utils/debug-logger';
 
 function isProfilingIntegrationWithProfiler(
   integration: ProfilingIntegration<any> | undefined,

packages/core/src/scope.ts

@@ -16,8 +16,8 @@ import type { SeverityLevel } from './types-hoist/severity';
 import type { Span } from './types-hoist/span';
 import type { PropagationContext } from './types-hoist/tracing';
 import type { User } from './types-hoist/user';
+import { debug } from './utils/debug-logger';
 import { isPlainObject } from './utils/is';
-import { debug } from './utils/logger';
 import { merge } from './utils/merge';
 import { uuid4 } from './utils/misc';
 import { generateTraceId } from './utils/propagationContext';

packages/core/src/sdk.ts

@@ -2,7 +2,7 @@ import type { Client } from './client';
 import { getCurrentScope } from './currentScopes';
 import { DEBUG_BUILD } from './debug-build';
 import type { ClientOptions } from './types-hoist/options';
-import { consoleSandbox, debug } from './utils/logger';
+import { consoleSandbox, debug } from './utils/debug-logger';
 
 /** A class object that can instantiate Client objects. */
 export type ClientClass<F extends Client, O extends ClientOptions> = new (options: O) => F;

packages/core/src/server-runtime-client.ts

@@ -13,9 +13,9 @@ import type { ClientOptions } from './types-hoist/options';
 import type { ParameterizedString } from './types-hoist/parameterize';
 import type { SeverityLevel } from './types-hoist/severity';
 import type { BaseTransportOptions } from './types-hoist/transport';
+import { debug } from './utils/debug-logger';
 import { eventFromMessage, eventFromUnknownInput } from './utils/eventbuilder';
 import { isPrimitive } from './utils/is';
-import { debug } from './utils/logger';
 import { uuid4 } from './utils/misc';
 import { resolvedSyncPromise } from './utils/syncpromise';
 

packages/core/src/tracing/errors.ts

@@ -1,7 +1,7 @@
 import { DEBUG_BUILD } from '../debug-build';
 import { addGlobalErrorInstrumentationHandler } from '../instrument/globalError';
 import { addGlobalUnhandledRejectionInstrumentationHandler } from '../instrument/globalUnhandledRejection';
-import { debug } from '../utils/logger';
+import { debug } from '../utils/debug-logger';
 import { getActiveSpan, getRootSpan } from '../utils/spanUtils';
 import { SPAN_STATUS_ERROR } from './spanstatus';
 

packages/core/src/tracing/idleSpan.ts

@@ -4,8 +4,8 @@ import { SEMANTIC_ATTRIBUTE_SENTRY_IDLE_SPAN_FINISH_REASON } from '../semanticAt
 import type { DynamicSamplingContext } from '../types-hoist/envelope';
 import type { Span } from '../types-hoist/span';
 import type { StartSpanOptions } from '../types-hoist/startSpanOptions';
+import { debug } from '../utils/debug-logger';
 import { hasSpansEnabled } from '../utils/hasSpansEnabled';
-import { debug } from '../utils/logger';
 import { _setSpanForScope } from '../utils/spanOnScope';
 import {
   getActiveSpan,

packages/core/src/tracing/logSpans.ts

@@ -1,6 +1,6 @@
 import { DEBUG_BUILD } from '../debug-build';
 import type { Span } from '../types-hoist/span';
-import { debug } from '../utils/logger';
+import { debug } from '../utils/debug-logger';
 import { getRootSpan, spanIsSampled, spanToJSON } from '../utils/spanUtils';
 
 /**

packages/core/src/tracing/measurement.ts

@@ -5,7 +5,7 @@ import {
 } from '../semanticAttributes';
 import type { Measurements, MeasurementUnit } from '../types-hoist/measurement';
 import type { TimedEvent } from '../types-hoist/timedEvent';
-import { debug } from '../utils/logger';
+import { debug } from '../utils/debug-logger';
 import { getActiveSpan, getRootSpan } from '../utils/spanUtils';
 
 /**

packages/core/src/tracing/sampling.ts

@@ -1,8 +1,8 @@
 import { DEBUG_BUILD } from '../debug-build';
 import type { Options } from '../types-hoist/options';
 import type { SamplingContext } from '../types-hoist/samplingcontext';
+import { debug } from '../utils/debug-logger';
 import { hasSpansEnabled } from '../utils/hasSpansEnabled';
-import { debug } from '../utils/logger';
 import { parseSampleRate } from '../utils/parseSampleRate';
 
 /**

packages/core/src/tracing/sentrySpan.ts

@@ -25,7 +25,7 @@ import type {
 import type { SpanStatus } from '../types-hoist/spanStatus';
 import type { TimedEvent } from '../types-hoist/timedEvent';
 import type { TransactionSource } from '../types-hoist/transaction';
-import { debug } from '../utils/logger';
+import { debug } from '../utils/debug-logger';
 import { generateSpanId, generateTraceId } from '../utils/propagationContext';
 import {
   convertSpanLinksForEnvelope,

packages/core/src/tracing/trace.ts

@@ -11,9 +11,9 @@ import type { DynamicSamplingContext } from '../types-hoist/envelope';
 import type { ClientOptions } from '../types-hoist/options';
 import type { SentrySpanArguments, Span, SpanTimeInput } from '../types-hoist/span';
 import type { StartSpanOptions } from '../types-hoist/startSpanOptions';
+import { debug } from '../utils/debug-logger';
 import { handleCallbackErrors } from '../utils/handleCallbackErrors';
 import { hasSpansEnabled } from '../utils/hasSpansEnabled';
-import { debug } from '../utils/logger';
 import { parseSampleRate } from '../utils/parseSampleRate';
 import { generateTraceId } from '../utils/propagationContext';
 import { _getSpanForScope, _setSpanForScope } from '../utils/spanOnScope';

packages/core/src/transports/base.ts

@@ -7,13 +7,13 @@ import type {
   TransportMakeRequestResponse,
   TransportRequestExecutor,
 } from '../types-hoist/transport';
+import { debug } from '../utils/debug-logger';
 import {
   createEnvelope,
   envelopeItemTypeToDataCategory,
   forEachEnvelopeItem,
   serializeEnvelope,
 } from '../utils/envelope';
-import { debug } from '../utils/logger';
 import { type PromiseBuffer, makePromiseBuffer, SENTRY_BUFFER_FULL_ERROR } from '../utils/promisebuffer';
 import { type RateLimits, isRateLimited, updateRateLimits } from '../utils/ratelimit';
 import { resolvedSyncPromise } from '../utils/syncpromise';

packages/core/src/transports/offline.ts

@@ -1,8 +1,8 @@
 import { DEBUG_BUILD } from '../debug-build';
 import type { Envelope } from '../types-hoist/envelope';
 import type { InternalBaseTransportOptions, Transport, TransportMakeRequestResponse } from '../types-hoist/transport';
+import { debug } from '../utils/debug-logger';
 import { envelopeContainsItemType } from '../utils/envelope';
-import { debug } from '../utils/logger';
 import { parseRetryAfterHeader } from '../utils/ratelimit';
 
 export const MIN_DELAY = 100; // 100 ms

packages/core/src/utils/baggage.ts

@@ -1,7 +1,7 @@
 import { DEBUG_BUILD } from '../debug-build';
 import type { DynamicSamplingContext } from '../types-hoist/envelope';
+import { debug } from './debug-logger';
 import { isString } from './is';
-import { debug } from './logger';
 
 export const SENTRY_BAGGAGE_KEY_PREFIX = 'sentry-';
 

packages/core/src/utils/logger.ts → packages/core/src/utils/debug-logger.ts

@@ -3,7 +3,11 @@ import { DEBUG_BUILD } from '../debug-build';
 import type { ConsoleLevel } from '../types-hoist/instrument';
 import { GLOBAL_OBJ } from './worldwide';
 
-/** A Sentry Logger instance. */
+/**
+ * A Sentry Logger instance.
+ *
+ * @deprecated Use {@link debug} instead with the {@link SentryDebugLogger} type.
+ */
 export interface Logger {
   disable(): void;
   enable(): void;
@@ -146,6 +150,8 @@ function _getLoggerSettings(): { enabled: boolean } {
 /**
  * This is a logger singleton which either logs things or no-ops if logging is not enabled.
  * The logger is a singleton on the carrier, to ensure that a consistent logger is used throughout the SDK.
+ *
+ * @deprecated Use {@link debug} instead.
  */
 export const logger = {
   /** Enable logging. */
@@ -168,6 +174,7 @@ export const logger = {
   assert,
   /** Log a trace. */
   trace,
+  // eslint-disable-next-line deprecation/deprecation
 } satisfies Logger;
 
 /**

packages/core/src/utils/dsn.ts

@@ -1,6 +1,6 @@
 import { DEBUG_BUILD } from '../debug-build';
 import type { DsnComponents, DsnLike, DsnProtocol } from '../types-hoist/dsn';
-import { consoleSandbox, debug } from './logger';
+import { consoleSandbox, debug } from './debug-logger';
 
 /** Regular expression used to extract org ID from a DSN host. */
 const ORG_ID_REGEX = /^o(\d+)\./;

packages/core/src/utils/featureFlags.ts

@@ -1,7 +1,7 @@
 import { getCurrentScope } from '../currentScopes';
 import { DEBUG_BUILD } from '../debug-build';
 import { type Event } from '../types-hoist/event';
-import { debug } from '../utils/logger';
+import { debug } from './debug-logger';
 import { getActiveSpan, spanToJSON } from './spanUtils';
 
 /**

packages/core/src/utils/object.ts

@@ -2,8 +2,8 @@
 import { DEBUG_BUILD } from '../debug-build';
 import type { WrappedFunction } from '../types-hoist/wrappedfunction';
 import { htmlTreeAsString } from './browser';
+import { debug } from './debug-logger';
 import { isElement, isError, isEvent, isInstanceOf, isPrimitive } from './is';
-import { debug } from './logger';
 import { truncate } from './string';
 
 /**