feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all \u003cpre\u003e\u003ccode\u003e blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks"); } } catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); } })(); (function(){ try { var __m = "github.com"; var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length \u003e 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option#17092

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.

Sign up for GitHub

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
AbhiPrasad merged 9 commits into from
Jul 21, 2025
Merged

feat(v9/core): Deprecate experimental enableLogs and beforeSendLog option #17092

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d60b46d
feat(core)!: Make `enableLogs` option unexperimental
AbhiPrasad Jul 17, 2025
e2e3a0f
feat(core)!: Make `beforeSendLog` option unexperimental
AbhiPrasad Jul 17, 2025
b60f538
fix test
AbhiPrasad Jul 17, 2025
33e25b8
fix browser test
AbhiPrasad Jul 18, 2025
0757de1
make it backwards compat
AbhiPrasad Jul 18, 2025
8cb21bc
fix flags for browser client
AbhiPrasad Jul 18, 2025
d625bd3
very smart cursor
AbhiPrasad Jul 18, 2025
71b4d0f
missed deprecation
AbhiPrasad Jul 21, 2025
2262a50
add migration note
AbhiPrasad Jul 21, 2025
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
24 changes: 24 additions & 0 deletions MIGRATION.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -23,6 +23,30 @@ logger.info('This is an info message');
debug.log('This is an info message');
```

## Deprecated `_experiments.enableLogs` and `_experiments.beforeSendLog` options

The `_experiments.enableLogs` and `_experiments.beforeSendLog` options have been deprecated in favor of the top-level `enableLogs` and `beforeSendLog` options.

```js
// before
Sentry.init({
_experiments: {
enableLogs: true,
beforeSendLog: log => {
return log;
},
},
});

// after
Sentry.init({
enableLogs: true,
beforeSendLog: log => {
return log;
},
});
```

# Upgrading from 8.x to 9.x

Version 9 of the Sentry JavaScript SDK primarily introduces API cleanup and version support changes.
Expand Down
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,7 +4,5 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
});
4 changes: 1 addition & 3 deletions dev-packages/browser-integration-tests/suites/public-api/logger/integration/init.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,6 @@ window.Sentry = Sentry;

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
_experiments: {
enableLogs: true,
},
enableLogs: true,
integrations: [Sentry.consoleLoggingIntegration()],
});
4 changes: 1 addition & 3 deletions dev-packages/e2e-tests/test-applications/node-express/src/app.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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
4 changes: 1 addition & 3 deletions dev-packages/node-core-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,9 +8,7 @@ const client = Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
4 changes: 1 addition & 3 deletions dev-packages/node-integration-tests/suites/winston/subject.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,7 @@ Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0.0',
environment: 'test',
_experiments: {
enableLogs: true,
},
enableLogs: true,
transport: loggingTransport,
});

Expand Down
11 changes: 6 additions & 5 deletions packages/browser/src/client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -85,23 +85,24 @@ export class BrowserClient extends Client<BrowserClientOptions> {

super(opts);

const { sendDefaultPii, sendClientReports, _experiments } = this._options;
const enableLogs = _experiments?.enableLogs;
const { sendDefaultPii, sendClientReports, enableLogs, _experiments } = this._options;
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;

if (WINDOW.document && (sendClientReports || enableLogs)) {
if (WINDOW.document && (sendClientReports || shouldEnableLogs)) {
WINDOW.document.addEventListener('visibilitychange', () => {
if (WINDOW.document.visibilityState === 'hidden') {
if (sendClientReports) {
this._flushOutcomes();
}
if (enableLogs) {
if (shouldEnableLogs) {
_INTERNAL_flushLogsBuffer(this);
}
}
});
}

if (enableLogs) {
if (shouldEnableLogs) {
this.on('flush', () => {
_INTERNAL_flushLogsBuffer(this);
});
Expand Down
12 changes: 6 additions & 6 deletions packages/browser/src/log.ts
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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
View file
Open in desktop
Original file line numberDiff line numberDiff 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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 DownExpand 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
11 changes: 7 additions & 4 deletions packages/core/src/logs/console-integration.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,9 +33,11 @@ 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, _experiments, normalizeDepth = 3, normalizeMaxBreadth = 1_000 } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('`enableLogs` is not enabled, ConsoleLogs integration disabled');
return;
}

Expand DownExpand Up@@ -69,7 +71,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 +85,7 @@ const _consoleLoggingIntegration = ((options: Partial<CaptureConsoleOptions> = {
* import * as Sentry from '@sentry/browser';
*
* Sentry.init({
* enableLogs: true,
* integrations: [Sentry.consoleLoggingIntegration({ levels: ['error', 'warn'] })],
* });
* ```
Expand Down
11 changes: 7 additions & 4 deletions packages/core/src/logs/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -124,12 +124,15 @@ export function _INTERNAL_captureLog(
return;
}

const { _experiments, release, environment } = client.getOptions();
const { enableLogs = false, beforeSendLog } = _experiments ?? {};
if (!enableLogs) {
const { release, environment, enableLogs, beforeSendLog, _experiments } = client.getOptions();
// eslint-disable-next-line deprecation/deprecation
const shouldEnableLogs = enableLogs ?? _experiments?.enableLogs;
if (!shouldEnableLogs) {
DEBUG_BUILD && debug.warn('logging option not enabled, log will not be captured.');
return;
}
// eslint-disable-next-line deprecation/deprecation
const actualBeforeSendLog = beforeSendLog ?? _experiments?.beforeSendLog;

const [, traceContext] = _getTraceInfoFromScope(client, currentScope);

Expand DownExpand Up@@ -169,7 +172,7 @@ export function _INTERNAL_captureLog(
client.emit('beforeCaptureLog', processedLog);

// We need to wrap this in `consoleSandbox` to avoid recursive calls to `beforeSendLog`
const log = beforeSendLog ? consoleSandbox(() => beforeSendLog(processedLog)) : processedLog;
const log = actualBeforeSendLog ? consoleSandbox(() => actualBeforeSendLog(processedLog)) : processedLog;
if (!log) {
client.recordDroppedEvent('before_send', 'log_item', 1);
DEBUG_BUILD && debug.warn('beforeSendLog returned null, log will not be captured.');
Expand Down
4 changes: 3 additions & 1 deletion packages/core/src/server-runtime-client.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,7 +49,9 @@ export class ServerRuntimeClient<

this._logWeight = 0;

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

Expand Down
27 changes: 27 additions & 0 deletions packages/core/src/types-hoist/options.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -246,19 +246,25 @@ 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.
*
* @deprecated Use the top-level `enableLogs` option instead.
*
* @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.
*
* @deprecated Use the top-level `beforeSendLog` option instead.
*
* @default undefined
*
* @param log The log generated by the SDK.
Expand DownExpand Up@@ -328,6 +334,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