Skip to content

feat(core)!: Remove enableLogs and beforeSendLog experimental options #17063

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jul 21, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://[email protected]/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://[email protected]/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,7 @@ Sentry.init({
debug: !!process.env.DEBUG,
tunnel: `http://localhost:3031/`, // proxy server
tracesSampleRate: 1,
_experiments: {
enableLogs: true,
},
enableLogs: true,
});

import { TRPCError, initTRPC } from '@trpc/server';
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://[email protected]/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://[email protected]/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
3 changes: 1 addition & 2 deletions packages/browser/src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -85,8 +85,7 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs } = this._options;

if (WINDOW.document && (sendClientReports || enableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function captureLog(
}

/**
* @summary Capture a log with the `trace` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `trace` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { userId: 100, route: '/dashboard' }.
Expand Down Expand Up @@ -48,7 +48,7 @@ export function trace(message: ParameterizedString, attributes?: Log['attributes
}

/**
* @summary Capture a log with the `debug` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `debug` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { component: 'Header', state: 'loading' }.
Expand Down Expand Up @@ -78,7 +78,7 @@ export function debug(message: ParameterizedString, attributes?: Log['attributes
}

/**
* @summary Capture a log with the `info` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `info` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { feature: 'checkout', status: 'completed' }.
Expand Down Expand Up @@ -108,7 +108,7 @@ export function info(message: ParameterizedString, attributes?: Log['attributes'
}

/**
* @summary Capture a log with the `warn` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `warn` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { browser: 'Chrome', version: '91.0' }.
Expand Down Expand Up @@ -139,7 +139,7 @@ export function warn(message: ParameterizedString, attributes?: Log['attributes'
}

/**
* @summary Capture a log with the `error` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `error` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { error: 'NetworkError', url: '/api/data' }.
Expand Down Expand Up @@ -171,7 +171,7 @@ export function error(message: ParameterizedString, attributes?: Log['attributes
}

/**
* @summary Capture a log with the `fatal` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `fatal` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { appState: 'corrupted', sessionId: 'abc-123' }.
Expand Down
3 changes: 1 addition & 2 deletions packages/browser/test/client.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ describe('BrowserClient', () => {
it('does not flush logs when logs are disabled', () => {
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: false },
sendClientReports: true,
}),
);
Expand All @@ -50,7 +49,7 @@ describe('BrowserClient', () => {
vi.useFakeTimers();
client = new BrowserClient(
getDefaultBrowserClientOptions({
_experiments: { enableLogs: true },
enableLogs: true,
sendClientReports: true,
}),
);
Expand Down
4 changes: 1 addition & 3 deletions packages/browser/test/log.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,7 @@ describe('Logger', () => {
init({
dsn,
transport: makeSimpleTransport,
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
});

Expand Down
12 changes: 6 additions & 6 deletions packages/cloudflare/src/logs/exports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ function captureLog(
}

/**
* @summary Capture a log with the `trace` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `trace` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { userId: 100, route: '/dashboard' }.
Expand Down Expand Up @@ -48,7 +48,7 @@ export function trace(message: ParameterizedString, attributes?: Log['attributes
}

/**
* @summary Capture a log with the `debug` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `debug` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { component: 'Header', state: 'loading' }.
Expand Down Expand Up @@ -78,7 +78,7 @@ export function debug(message: ParameterizedString, attributes?: Log['attributes
}

/**
* @summary Capture a log with the `info` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `info` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { feature: 'checkout', status: 'completed' }.
Expand Down Expand Up @@ -108,7 +108,7 @@ export function info(message: ParameterizedString, attributes?: Log['attributes'
}

/**
* @summary Capture a log with the `warn` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `warn` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { browser: 'Chrome', version: '91.0' }.
Expand Down Expand Up @@ -139,7 +139,7 @@ export function warn(message: ParameterizedString, attributes?: Log['attributes'
}

/**
* @summary Capture a log with the `error` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `error` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { error: 'NetworkError', url: '/api/data' }.
Expand Down Expand Up @@ -171,7 +171,7 @@ export function error(message: ParameterizedString, attributes?: Log['attributes
}

/**
* @summary Capture a log with the `fatal` level. Requires `_experiments.enableLogs` to be enabled.
* @summary Capture a log with the `fatal` level. Requires the `enableLogs` option to be enabled.
*
* @param message - The message to log.
* @param attributes - Arbitrary structured data that stores information about the log - e.g., { appState: 'corrupted', sessionId: 'abc-123' }.
Expand Down
9 changes: 5 additions & 4 deletions packages/core/src/logs/console-integration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
return {
name: INTEGRATION_NAME,
setup(client) {
const { _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
if (!_experiments?.enableLogs) {
DEBUG_BUILD && debug.warn('`_experiments.enableLogs` is not enabled, ConsoleLogs integration disabled');
const { enableLogs, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
if (!enableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand Down Expand Up @@ -69,7 +69,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
}) satisfies IntegrationFn;

/**
* Captures calls to the `console` API as logs in Sentry. Requires `_experiments.enableLogs` to be enabled.
* Captures calls to the `console` API as logs in Sentry. Requires the `enableLogs` option to be enabled.
*
* @experimental This feature is experimental and may be changed or removed in future versions.
*
Expand All @@ -83,6 +83,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
3 changes: 1 addition & 2 deletions packages/core/src/logs/exports.ts
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,7 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
const { release, environment, enableLogs = false, beforeSendLog } = client.getOptions();
if (!enableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
Expand Down
2 changes: 1 addition & 1 deletion packages/core/src/server-runtime-client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ export class ServerRuntimeClient<

this._logWeight = 0;

if (this._options._experiments?.enableLogs) {
if (this._options.enableLogs) {
// eslint-disable-next-line @typescript-eslint/no-this-alias
const client = this;

Expand Down
40 changes: 21 additions & 19 deletions packages/core/src/types-hoist/options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -246,25 +246,6 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
_experiments?: {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
[key: string]: any;
/**
* If logs support should be enabled.
*
* @default false
*/
enableLogs?: boolean;
/**
* An event-processing callback for logs, guaranteed to be invoked after all other log
* processors. This allows a log to be modified or dropped before it's sent.
*
* Note that you must return a valid log from this callback. If you do not wish to modify the log, simply return
* it at the end. Returning `null` will cause the log to be dropped.
*
* @default undefined
*
* @param log The log generated by the SDK.
* @returns A new log that will be sent | null.
*/
beforeSendLog?: (log: Log) => Log | null;
};

/**
Expand Down Expand Up @@ -328,6 +309,27 @@ export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOp
*/
orgId?: `${number}` | number;

/**
* If logs support should be enabled.
*
* @default false
*/
enableLogs?: boolean;

/**
* An event-processing callback for logs, guaranteed to be invoked after all other log
* processors. This allows a log to be modified or dropped before it's sent.
*
* Note that you must return a valid log from this callback. If you do not wish to modify the log, simply return
* it at the end. Returning `null` will cause the log to be dropped.
*
* @default undefined
*
* @param log The log generated by the SDK.
* @returns A new log that will be sent | null.
*/
beforeSendLog?: (log: Log) => Log | null;

/**
* Function to compute tracing sample rate dynamically and filter unwanted traces.
*
Expand Down
Loading
Loading