Skip to content

feat(core): Add logger to core and allow scope to be passed log methods #17698

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
merged 1 commit into from
Sep 19, 2025
Merged

feat(core): Add logger to core and allow scope to be passed log methods #17698

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 1 addition & 3 deletions packages/browser/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,8 @@
import { feedbackAsyncIntegration } from './feedbackAsync';
import { feedbackSyncIntegration } from './feedbackSync';
import * as logger from './log';
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does this mean we can remove log.ts from browser?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was removed, git just tracked it as a renamed
image


export * from './exports';

export { logger };

export { reportingObserverIntegration } from './integrations/reportingobserver';
export { httpClientIntegration } from './integrations/httpclient';
export { contextLinesIntegration } from './integrations/contextlines';
Expand Down Expand Up @@ -63,6 +60,7 @@ export {
zodErrorsIntegration,
thirdPartyErrorFilterIntegration,
featureFlagsIntegration,
logger,
} from '@sentry/core';
export type { Span, FeatureFlagsIntegration } from '@sentry/core';
export { makeBrowserOfflineTransport } from './transports/offline';
Expand Down
33 changes: 24 additions & 9 deletions packages/browser/test/client.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*/

import * as sentryCore from '@sentry/core';
import { Scope } from '@sentry/core';
import { afterEach, beforeEach, describe, expect, it, vi } from 'vitest';
import { applyDefaultOptions, BrowserClient } from '../src/client';
import { WINDOW } from '../src/helpers';
Expand Down Expand Up @@ -30,10 +31,12 @@ describe('BrowserClient', () => {
sendClientReports: true,
}),
);
const scope = new Scope();
scope.setClient(client);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, scope);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, scope);

// Simulate visibility change to hidden
if (WINDOW.document) {
Expand All @@ -58,9 +61,12 @@ describe('BrowserClient', () => {
it('flushes logs when page visibility changes to hidden', () => {
const flushOutcomesSpy = vi.spyOn(client as any, '_flushOutcomes');

const scope = new Scope();
scope.setClient(client);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, scope);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, scope);

// Simulate visibility change to hidden
if (WINDOW.document) {
Expand All @@ -73,9 +79,12 @@ describe('BrowserClient', () => {
});

it('flushes logs on flush event', () => {
const scope = new Scope();
scope.setClient(client);

// Add some logs
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, scope);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, scope);

// Trigger flush event
client.emit('flush');
Expand All @@ -84,8 +93,11 @@ describe('BrowserClient', () => {
});

it('flushes logs after idle timeout', () => {
const scope = new Scope();
scope.setClient(client);

// Add a log which will trigger afterCaptureLog event
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log' }, scope);

// Fast forward the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL);
Expand All @@ -94,14 +106,17 @@ describe('BrowserClient', () => {
});

it('resets idle timeout when new logs are captured', () => {
const scope = new Scope();
scope.setClient(client);

// Add initial log
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 1' }, scope);

// Fast forward part of the idle timeout
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);

// Add another log which should reset the timeout
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, client);
sentryCore._INTERNAL_captureLog({ level: 'info', message: 'test log 2' }, scope);

// Fast forward the remaining time
vi.advanceTimersByTime(DEFAULT_FLUSH_INTERVAL / 2);
Expand Down
150 changes: 0 additions & 150 deletions packages/browser/test/log.test.ts
View file
Open in desktop

This file was deleted.

3 changes: 1 addition & 2 deletions packages/cloudflare/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,10 +96,9 @@ export {
consoleLoggingIntegration,
createConsolaReporter,
featureFlagsIntegration,
logger,
} from '@sentry/core';

export * as logger from './logs/exports';

export { withSentry } from './handler';
export { instrumentDurableObjectWithSentry } from './durableobject';
export { sentryPagesPlugin } from './pages-plugin';
Expand Down
Loading