feat(core): Add isolateTrace option to Sentry.withMonitor()#18079

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
Lms24 merged 12 commits into from
Dec 2, 2025
Merged

feat(core): Add isolateTrace option to Sentry.withMonitor() #18079

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2b4f7c1
feat(core): Add isolateTrace option to MonitorConfig
nehaaprasad Nov 3, 2025
382fdc6
feat(core): Implement isolateTrace in withMonitor function
nehaaprasad Nov 3, 2025
4dfa0af
test(core): Add tests for isolateTrace functionality
nehaaprasad Nov 3, 2025
e06ae30
feat: Update isolateTrace implementation to use startNewTrace
nehaaprasad Nov 7, 2025
a16ae77
test: Add integration test for isolateTrace functionality
nehaaprasad Nov 7, 2025
50d5386
test: Fix withMonitor integration test to use proper test runner
nehaaprasad Nov 26, 2025
4215d49
fix: Add newline at end of scenario file
nehaaprasad Nov 26, 2025
7d10a53
test: Remove comments from withMonitor scenario file
nehaaprasad Nov 26, 2025
b9b6ba7
Merge branch 'develop' into feat/monitor-trace
nehaaprasad Nov 26, 2025
ad7c159
ensure initial checkin and terminal checkin have same trace
Lms24 Nov 28, 2025
b12304b
formatting and linting
Lms24 Nov 28, 2025
4551a8e
fix unit tests, fix integration tests
Lms24 Dec 2, 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
43 changes: 43 additions & 0 deletions dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
'cron-job-1',
async () => {
await new Promise<void>(resolve => {
setTimeout(() => {
resolve();
}, 100);
});
},
{
schedule: { type: 'crontab', value: '* * * * *' },
},
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
'cron-job-2',
async () => {
await new Promise<void>(resolve => {
setTimeout(() => {
resolve();
}, 100);
});
},
{
schedule: { type: 'crontab', value: '* * * * *' },
isolateTrace: true,
},
);

setTimeout(() => {
process.exit();
}, 500);
54 changes: 54 additions & 0 deletions dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts
View file
Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?

I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
afterAll(() => {
cleanupChildProcesses();
});

test('creates distinct traces when isolateTrace is enabled', async () => {
const checkIns: SerializedCheckIn[] = [];

await createRunner(__dirname, 'scenario.ts')
.expect({
check_in: checkIn => {
checkIns.push(checkIn);
},
})
.expect({
check_in: checkIn => {
checkIns.push(checkIn);
},
})
.expect({
check_in: checkIn => {
checkIns.push(checkIn);
},
})
.expect({
check_in: checkIn => {
checkIns.push(checkIn);
},
})
.start()
.completed();

const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
});
});
19 changes: 11 additions & 8 deletions packages/core/src/exports.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
callback: () => T,
upsertMonitorConfig?: MonitorConfig,
): T {
const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
const now = timestampInSeconds();
function runCallback(): T {
const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
const now = timestampInSeconds();

function finishCheckIn(status: FinishedCheckIn['status']): void {
captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
}

return withIsolationScope(() => {
function finishCheckIn(status: FinishedCheckIn['status']): void {
captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
}
Comment thread
cursor[bot] marked this conversation as resolved.
// Default behavior without isolateTrace
let maybePromiseResult: T;
try {
maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
finishCheckIn('ok');

return maybePromiseResult;
});
}

return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down
5 changes: 5 additions & 0 deletions packages/core/src/types-hoist/checkin.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
/** How many consecutive OK check-ins it takes to resolve an issue. */
recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
/**
* If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
* This allows distinguishing between different cron job executions.
*/
isolateTrace?: boolean;
}
77 changes: 77 additions & 0 deletions packages/core/test/lib/client.test.ts
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
const promise = await withMonitor('test-monitor', callback);
await expect(promise).rejects.toThrowError(error);
});

describe('isolateTrace', () => {
const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

beforeEach(() => {
startNewTraceSpy.mockClear();
});

it('starts a new trace when isolateTrace is true (sync)', () => {
const result = 'foo';
const callback = vi.fn().mockReturnValue(result);

const returnedResult = withMonitor('test-monitor', callback, {
schedule: { type: 'crontab', value: '* * * * *' },
isolateTrace: true,
});

expect(returnedResult).toBe(result);
expect(callback).toHaveBeenCalledTimes(1);
expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
});

it('starts a new trace when isolateTrace is true (async)', async () => {
const result = 'foo';
const callback = vi.fn().mockResolvedValue(result);

const promise = withMonitor('test-monitor', callback, {
schedule: { type: 'crontab', value: '* * * * *' },
isolateTrace: true,
});
await expect(promise).resolves.toEqual(result);
expect(callback).toHaveBeenCalledTimes(1);
expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
});

it("doesn't start a new trace when isolateTrace is false (sync)", () => {
const result = 'foo';
const callback = vi.fn().mockReturnValue(result);

const returnedResult = withMonitor('test-monitor', callback, {
schedule: { type: 'crontab', value: '* * * * *' },
isolateTrace: false,
});

expect(returnedResult).toBe(result);
expect(callback).toHaveBeenCalledTimes(1);
expect(startNewTraceSpy).not.toHaveBeenCalled();
});

it("doesn't start a new trace when isolateTrace is false (async)", async () => {
const result = 'foo';
const callback = vi.fn().mockResolvedValue(result);

const promise = withMonitor('test-monitor', callback, {
schedule: { type: 'crontab', value: '* * * * *' },
isolateTrace: false,
});

await expect(promise).resolves.toEqual(result);
expect(callback).toHaveBeenCalledTimes(1);
expect(startNewTraceSpy).not.toHaveBeenCalled();
});

it("doesn't start a new trace by default", () => {
const result = 'foo';
const callback = vi.fn().mockReturnValue(result);

const returnedResult = withMonitor('test-monitor', callback, {
schedule: { type: 'crontab', value: '* * * * *' },
});

expect(returnedResult).toBe(result);
expect(callback).toHaveBeenCalledTimes(1);
expect(startNewTraceSpy).not.toHaveBeenCalled();
});
});
});

describe('enableLogs', () => {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 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(core): Add isolateTrace option to Sentry.withMonitor()#18079

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

Lms24
merged 12 commits into

from

Dec 2, 2025
 Merged


feat(core): Add isolateTrace option to Sentry.withMonitor()
#18079
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
2b4f7c1

feat(core): Add isolateTrace option to MonitorConfig


nehaaprasad Nov 3, 2025
382fdc6

feat(core): Implement isolateTrace in withMonitor function


nehaaprasad Nov 3, 2025
4dfa0af

test(core): Add tests for isolateTrace functionality


nehaaprasad Nov 3, 2025
e06ae30

feat: Update isolateTrace implementation to use startNewTrace


nehaaprasad Nov 7, 2025
a16ae77

test: Add integration test for isolateTrace functionality


nehaaprasad Nov 7, 2025
50d5386

test: Fix withMonitor integration test to use proper test runner


nehaaprasad Nov 26, 2025
4215d49

fix: Add newline at end of scenario file


nehaaprasad Nov 26, 2025
7d10a53

test: Remove comments from withMonitor scenario file


nehaaprasad Nov 26, 2025
b9b6ba7

Merge branch 'develop' into feat/monitor-trace


nehaaprasad Nov 26, 2025
ad7c159

ensure initial checkin and terminal checkin have same trace


Lms24 Nov 28, 2025
b12304b

formatting and linting


Lms24 Nov 28, 2025
4551a8e

fix unit tests, fix integration tests


Lms24 Dec 2, 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


43 changes: 43 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-1',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 },
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-2',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 },
);

setTimeout(() => {
 process.exit();
}, 500);

54 changes: 54 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

View file


Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?
I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 test('creates distinct traces when isolateTrace is enabled', async () => {
 const checkIns: SerializedCheckIn[] = [];

 await createRunner(__dirname, 'scenario.ts')
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .start()
 .completed();

 const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
 const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

 const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
 const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

 expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

 expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

 expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
 expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 });
});

19 changes: 11 additions & 8 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
 callback: () => T,
 upsertMonitorConfig?: MonitorConfig,
): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();
 function runCallback(): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();

 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }

 return withIsolationScope(() => {
 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }
Comment thread
cursor[bot] marked this conversation as resolved.

 // Default behavior without isolateTrace
 let maybePromiseResult: T;
 try {
 maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
 finishCheckIn('ok');

 return maybePromiseResult;
 });
 }

 return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/checkin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
 failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
 /** How many consecutive OK check-ins it takes to resolve an issue. */
 recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
 /**
 * If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
 * This allows distinguishing between different cron job executions.
 */
 isolateTrace?: boolean;
}

77 changes: 77 additions & 0 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
 const promise = await withMonitor('test-monitor', callback);
 await expect(promise).rejects.toThrowError(error);
 });

 describe('isolateTrace', () => {
 const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

 beforeEach(() => {
 startNewTraceSpy.mockClear();
 });

 it('starts a new trace when isolateTrace is true (sync)', () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it('starts a new trace when isolateTrace is true (async)', async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });
 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it("doesn't start a new trace when isolateTrace is false (sync)", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace when isolateTrace is false (async)", async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace by default", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });
 });
 });

 describe('enableLogs', () => {
Expand Down
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(core): Add isolateTrace option to Sentry.withMonitor()#18079

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

Lms24
merged 12 commits into

from

Dec 2, 2025
 Merged


feat(core): Add isolateTrace option to Sentry.withMonitor()
#18079
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
2b4f7c1

feat(core): Add isolateTrace option to MonitorConfig


nehaaprasad Nov 3, 2025
382fdc6

feat(core): Implement isolateTrace in withMonitor function


nehaaprasad Nov 3, 2025
4dfa0af

test(core): Add tests for isolateTrace functionality


nehaaprasad Nov 3, 2025
e06ae30

feat: Update isolateTrace implementation to use startNewTrace


nehaaprasad Nov 7, 2025
a16ae77

test: Add integration test for isolateTrace functionality


nehaaprasad Nov 7, 2025
50d5386

test: Fix withMonitor integration test to use proper test runner


nehaaprasad Nov 26, 2025
4215d49

fix: Add newline at end of scenario file


nehaaprasad Nov 26, 2025
7d10a53

test: Remove comments from withMonitor scenario file


nehaaprasad Nov 26, 2025
b9b6ba7

Merge branch 'develop' into feat/monitor-trace


nehaaprasad Nov 26, 2025
ad7c159

ensure initial checkin and terminal checkin have same trace


Lms24 Nov 28, 2025
b12304b

formatting and linting


Lms24 Nov 28, 2025
4551a8e

fix unit tests, fix integration tests


Lms24 Dec 2, 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


43 changes: 43 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-1',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 },
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-2',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 },
);

setTimeout(() => {
 process.exit();
}, 500);

54 changes: 54 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

View file


Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?
I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 test('creates distinct traces when isolateTrace is enabled', async () => {
 const checkIns: SerializedCheckIn[] = [];

 await createRunner(__dirname, 'scenario.ts')
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .start()
 .completed();

 const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
 const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

 const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
 const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

 expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

 expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

 expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
 expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 });
});

19 changes: 11 additions & 8 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
 callback: () => T,
 upsertMonitorConfig?: MonitorConfig,
): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();
 function runCallback(): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();

 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }

 return withIsolationScope(() => {
 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }
Comment thread
cursor[bot] marked this conversation as resolved.

 // Default behavior without isolateTrace
 let maybePromiseResult: T;
 try {
 maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
 finishCheckIn('ok');

 return maybePromiseResult;
 });
 }

 return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/checkin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
 failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
 /** How many consecutive OK check-ins it takes to resolve an issue. */
 recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
 /**
 * If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
 * This allows distinguishing between different cron job executions.
 */
 isolateTrace?: boolean;
}

77 changes: 77 additions & 0 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
 const promise = await withMonitor('test-monitor', callback);
 await expect(promise).rejects.toThrowError(error);
 });

 describe('isolateTrace', () => {
 const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

 beforeEach(() => {
 startNewTraceSpy.mockClear();
 });

 it('starts a new trace when isolateTrace is true (sync)', () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it('starts a new trace when isolateTrace is true (async)', async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });
 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it("doesn't start a new trace when isolateTrace is false (sync)", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace when isolateTrace is false (async)", async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace by default", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });
 });
 });

 describe('enableLogs', () => {
Expand Down
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 > 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(core): Add isolateTrace option to Sentry.withMonitor()#18079

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

Lms24
merged 12 commits into

from

Dec 2, 2025
 Merged


feat(core): Add isolateTrace option to Sentry.withMonitor()
#18079
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
2b4f7c1

feat(core): Add isolateTrace option to MonitorConfig


nehaaprasad Nov 3, 2025
382fdc6

feat(core): Implement isolateTrace in withMonitor function


nehaaprasad Nov 3, 2025
4dfa0af

test(core): Add tests for isolateTrace functionality


nehaaprasad Nov 3, 2025
e06ae30

feat: Update isolateTrace implementation to use startNewTrace


nehaaprasad Nov 7, 2025
a16ae77

test: Add integration test for isolateTrace functionality


nehaaprasad Nov 7, 2025
50d5386

test: Fix withMonitor integration test to use proper test runner


nehaaprasad Nov 26, 2025
4215d49

fix: Add newline at end of scenario file


nehaaprasad Nov 26, 2025
7d10a53

test: Remove comments from withMonitor scenario file


nehaaprasad Nov 26, 2025
b9b6ba7

Merge branch 'develop' into feat/monitor-trace


nehaaprasad Nov 26, 2025
ad7c159

ensure initial checkin and terminal checkin have same trace


Lms24 Nov 28, 2025
b12304b

formatting and linting


Lms24 Nov 28, 2025
4551a8e

fix unit tests, fix integration tests


Lms24 Dec 2, 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


43 changes: 43 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-1',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 },
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-2',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 },
);

setTimeout(() => {
 process.exit();
}, 500);

54 changes: 54 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

View file


Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?
I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 test('creates distinct traces when isolateTrace is enabled', async () => {
 const checkIns: SerializedCheckIn[] = [];

 await createRunner(__dirname, 'scenario.ts')
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .start()
 .completed();

 const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
 const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

 const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
 const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

 expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

 expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

 expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
 expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 });
});

19 changes: 11 additions & 8 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
 callback: () => T,
 upsertMonitorConfig?: MonitorConfig,
): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();
 function runCallback(): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();

 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }

 return withIsolationScope(() => {
 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }
Comment thread
cursor[bot] marked this conversation as resolved.

 // Default behavior without isolateTrace
 let maybePromiseResult: T;
 try {
 maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
 finishCheckIn('ok');

 return maybePromiseResult;
 });
 }

 return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/checkin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
 failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
 /** How many consecutive OK check-ins it takes to resolve an issue. */
 recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
 /**
 * If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
 * This allows distinguishing between different cron job executions.
 */
 isolateTrace?: boolean;
}

77 changes: 77 additions & 0 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
 const promise = await withMonitor('test-monitor', callback);
 await expect(promise).rejects.toThrowError(error);
 });

 describe('isolateTrace', () => {
 const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

 beforeEach(() => {
 startNewTraceSpy.mockClear();
 });

 it('starts a new trace when isolateTrace is true (sync)', () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it('starts a new trace when isolateTrace is true (async)', async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });
 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it("doesn't start a new trace when isolateTrace is false (sync)", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace when isolateTrace is false (async)", async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace by default", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });
 });
 });

 describe('enableLogs', () => {
Expand Down
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(core): Add isolateTrace option to Sentry.withMonitor()#18079

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

Lms24
merged 12 commits into

from

Dec 2, 2025
 Merged


feat(core): Add isolateTrace option to Sentry.withMonitor()
#18079
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
2b4f7c1

feat(core): Add isolateTrace option to MonitorConfig


nehaaprasad Nov 3, 2025
382fdc6

feat(core): Implement isolateTrace in withMonitor function


nehaaprasad Nov 3, 2025
4dfa0af

test(core): Add tests for isolateTrace functionality


nehaaprasad Nov 3, 2025
e06ae30

feat: Update isolateTrace implementation to use startNewTrace


nehaaprasad Nov 7, 2025
a16ae77

test: Add integration test for isolateTrace functionality


nehaaprasad Nov 7, 2025
50d5386

test: Fix withMonitor integration test to use proper test runner


nehaaprasad Nov 26, 2025
4215d49

fix: Add newline at end of scenario file


nehaaprasad Nov 26, 2025
7d10a53

test: Remove comments from withMonitor scenario file


nehaaprasad Nov 26, 2025
b9b6ba7

Merge branch 'develop' into feat/monitor-trace


nehaaprasad Nov 26, 2025
ad7c159

ensure initial checkin and terminal checkin have same trace


Lms24 Nov 28, 2025
b12304b

formatting and linting


Lms24 Nov 28, 2025
4551a8e

fix unit tests, fix integration tests


Lms24 Dec 2, 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


43 changes: 43 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-1',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 },
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-2',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 },
);

setTimeout(() => {
 process.exit();
}, 500);

54 changes: 54 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

View file


Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?
I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 test('creates distinct traces when isolateTrace is enabled', async () => {
 const checkIns: SerializedCheckIn[] = [];

 await createRunner(__dirname, 'scenario.ts')
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .start()
 .completed();

 const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
 const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

 const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
 const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

 expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

 expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

 expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
 expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 });
});

19 changes: 11 additions & 8 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
 callback: () => T,
 upsertMonitorConfig?: MonitorConfig,
): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();
 function runCallback(): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();

 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }

 return withIsolationScope(() => {
 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }
Comment thread
cursor[bot] marked this conversation as resolved.

 // Default behavior without isolateTrace
 let maybePromiseResult: T;
 try {
 maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
 finishCheckIn('ok');

 return maybePromiseResult;
 });
 }

 return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/checkin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
 failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
 /** How many consecutive OK check-ins it takes to resolve an issue. */
 recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
 /**
 * If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
 * This allows distinguishing between different cron job executions.
 */
 isolateTrace?: boolean;
}

77 changes: 77 additions & 0 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
 const promise = await withMonitor('test-monitor', callback);
 await expect(promise).rejects.toThrowError(error);
 });

 describe('isolateTrace', () => {
 const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

 beforeEach(() => {
 startNewTraceSpy.mockClear();
 });

 it('starts a new trace when isolateTrace is true (sync)', () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it('starts a new trace when isolateTrace is true (async)', async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });
 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it("doesn't start a new trace when isolateTrace is false (sync)", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace when isolateTrace is false (async)", async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace by default", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });
 });
 });

 describe('enableLogs', () => {
Expand Down
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(core): Add isolateTrace option to Sentry.withMonitor()#18079

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

Lms24
merged 12 commits into

from

Dec 2, 2025
 Merged


feat(core): Add isolateTrace option to Sentry.withMonitor()
#18079
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
2b4f7c1

feat(core): Add isolateTrace option to MonitorConfig


nehaaprasad Nov 3, 2025
382fdc6

feat(core): Implement isolateTrace in withMonitor function


nehaaprasad Nov 3, 2025
4dfa0af

test(core): Add tests for isolateTrace functionality


nehaaprasad Nov 3, 2025
e06ae30

feat: Update isolateTrace implementation to use startNewTrace


nehaaprasad Nov 7, 2025
a16ae77

test: Add integration test for isolateTrace functionality


nehaaprasad Nov 7, 2025
50d5386

test: Fix withMonitor integration test to use proper test runner


nehaaprasad Nov 26, 2025
4215d49

fix: Add newline at end of scenario file


nehaaprasad Nov 26, 2025
7d10a53

test: Remove comments from withMonitor scenario file


nehaaprasad Nov 26, 2025
b9b6ba7

Merge branch 'develop' into feat/monitor-trace


nehaaprasad Nov 26, 2025
ad7c159

ensure initial checkin and terminal checkin have same trace


Lms24 Nov 28, 2025
b12304b

formatting and linting


Lms24 Nov 28, 2025
4551a8e

fix unit tests, fix integration tests


Lms24 Dec 2, 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


43 changes: 43 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-1',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 },
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-2',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 },
);

setTimeout(() => {
 process.exit();
}, 500);

54 changes: 54 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

View file


Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?
I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 test('creates distinct traces when isolateTrace is enabled', async () => {
 const checkIns: SerializedCheckIn[] = [];

 await createRunner(__dirname, 'scenario.ts')
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .start()
 .completed();

 const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
 const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

 const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
 const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

 expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

 expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

 expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
 expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 });
});

19 changes: 11 additions & 8 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
 callback: () => T,
 upsertMonitorConfig?: MonitorConfig,
): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();
 function runCallback(): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();

 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }

 return withIsolationScope(() => {
 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }
Comment thread
cursor[bot] marked this conversation as resolved.

 // Default behavior without isolateTrace
 let maybePromiseResult: T;
 try {
 maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
 finishCheckIn('ok');

 return maybePromiseResult;
 });
 }

 return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/checkin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
 failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
 /** How many consecutive OK check-ins it takes to resolve an issue. */
 recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
 /**
 * If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
 * This allows distinguishing between different cron job executions.
 */
 isolateTrace?: boolean;
}

77 changes: 77 additions & 0 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
 const promise = await withMonitor('test-monitor', callback);
 await expect(promise).rejects.toThrowError(error);
 });

 describe('isolateTrace', () => {
 const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

 beforeEach(() => {
 startNewTraceSpy.mockClear();
 });

 it('starts a new trace when isolateTrace is true (sync)', () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it('starts a new trace when isolateTrace is true (async)', async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });
 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it("doesn't start a new trace when isolateTrace is false (sync)", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace when isolateTrace is false (async)", async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace by default", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });
 });
 });

 describe('enableLogs', () => {
Expand Down
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(core): Add isolateTrace option to Sentry.withMonitor()#18079

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

Lms24
merged 12 commits into

from

Dec 2, 2025
 Merged


feat(core): Add isolateTrace option to Sentry.withMonitor()
#18079
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
2b4f7c1

feat(core): Add isolateTrace option to MonitorConfig


nehaaprasad Nov 3, 2025
382fdc6

feat(core): Implement isolateTrace in withMonitor function


nehaaprasad Nov 3, 2025
4dfa0af

test(core): Add tests for isolateTrace functionality


nehaaprasad Nov 3, 2025
e06ae30

feat: Update isolateTrace implementation to use startNewTrace


nehaaprasad Nov 7, 2025
a16ae77

test: Add integration test for isolateTrace functionality


nehaaprasad Nov 7, 2025
50d5386

test: Fix withMonitor integration test to use proper test runner


nehaaprasad Nov 26, 2025
4215d49

fix: Add newline at end of scenario file


nehaaprasad Nov 26, 2025
7d10a53

test: Remove comments from withMonitor scenario file


nehaaprasad Nov 26, 2025
b9b6ba7

Merge branch 'develop' into feat/monitor-trace


nehaaprasad Nov 26, 2025
ad7c159

ensure initial checkin and terminal checkin have same trace


Lms24 Nov 28, 2025
b12304b

formatting and linting


Lms24 Nov 28, 2025
4551a8e

fix unit tests, fix integration tests


Lms24 Dec 2, 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


43 changes: 43 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-1',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 },
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-2',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 },
);

setTimeout(() => {
 process.exit();
}, 500);

54 changes: 54 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

View file


Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?
I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 test('creates distinct traces when isolateTrace is enabled', async () => {
 const checkIns: SerializedCheckIn[] = [];

 await createRunner(__dirname, 'scenario.ts')
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .start()
 .completed();

 const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
 const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

 const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
 const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

 expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

 expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

 expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
 expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 });
});

19 changes: 11 additions & 8 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
 callback: () => T,
 upsertMonitorConfig?: MonitorConfig,
): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();
 function runCallback(): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();

 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }

 return withIsolationScope(() => {
 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }
Comment thread
cursor[bot] marked this conversation as resolved.

 // Default behavior without isolateTrace
 let maybePromiseResult: T;
 try {
 maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
 finishCheckIn('ok');

 return maybePromiseResult;
 });
 }

 return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/checkin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
 failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
 /** How many consecutive OK check-ins it takes to resolve an issue. */
 recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
 /**
 * If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
 * This allows distinguishing between different cron job executions.
 */
 isolateTrace?: boolean;
}

77 changes: 77 additions & 0 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
 const promise = await withMonitor('test-monitor', callback);
 await expect(promise).rejects.toThrowError(error);
 });

 describe('isolateTrace', () => {
 const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

 beforeEach(() => {
 startNewTraceSpy.mockClear();
 });

 it('starts a new trace when isolateTrace is true (sync)', () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it('starts a new trace when isolateTrace is true (async)', async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });
 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it("doesn't start a new trace when isolateTrace is false (sync)", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace when isolateTrace is false (async)", async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace by default", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });
 });
 });

 describe('enableLogs', () => {
Expand Down
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(core): Add isolateTrace option to Sentry.withMonitor()#18079

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

Lms24
merged 12 commits into

from

Dec 2, 2025
 Merged


feat(core): Add isolateTrace option to Sentry.withMonitor()
#18079
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


12 commits


Select commit
Hold shift + click to select a range
2b4f7c1

feat(core): Add isolateTrace option to MonitorConfig


nehaaprasad Nov 3, 2025
382fdc6

feat(core): Implement isolateTrace in withMonitor function


nehaaprasad Nov 3, 2025
4dfa0af

test(core): Add tests for isolateTrace functionality


nehaaprasad Nov 3, 2025
e06ae30

feat: Update isolateTrace implementation to use startNewTrace


nehaaprasad Nov 7, 2025
a16ae77

test: Add integration test for isolateTrace functionality


nehaaprasad Nov 7, 2025
50d5386

test: Fix withMonitor integration test to use proper test runner


nehaaprasad Nov 26, 2025
4215d49

fix: Add newline at end of scenario file


nehaaprasad Nov 26, 2025
7d10a53

test: Remove comments from withMonitor scenario file


nehaaprasad Nov 26, 2025
b9b6ba7

Merge branch 'develop' into feat/monitor-trace


nehaaprasad Nov 26, 2025
ad7c159

ensure initial checkin and terminal checkin have same trace


Lms24 Nov 28, 2025
b12304b

formatting and linting


Lms24 Nov 28, 2025
4551a8e

fix unit tests, fix integration tests


Lms24 Dec 2, 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


43 changes: 43 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/scenario.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
 dsn: 'https://public@dsn.ingest.sentry.io/1337',
 release: '1.0',
 transport: loggingTransport,
});

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-1',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 },
);

// eslint-disable-next-line @typescript-eslint/no-floating-promises
Sentry.withMonitor(
 'cron-job-2',
 async () => {
 await new Promise<void>(resolve => {
 setTimeout(() => {
 resolve();
 }, 100);
 });
 },
 {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 },
);

setTimeout(() => {
 process.exit();
}, 500);

54 changes: 54 additions & 0 deletions
dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

View file


Open in desktop

@Lms24Lms24Nov 10, 2025

Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

I'm afraid this is not gonna work because it doesn't use our test runner at all. Did you test this?
I suggest taking a look at a test like this one and using the same runner, just that you assert on two transactions and check for distinct trace ids.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
import type { SerializedCheckIn } from '@sentry/core';
import { afterAll, describe, expect, test } from 'vitest';
import { cleanupChildProcesses, createRunner } from '../../../utils/runner';

describe('withMonitor isolateTrace', () => {
 afterAll(() => {
 cleanupChildProcesses();
 });

 test('creates distinct traces when isolateTrace is enabled', async () => {
 const checkIns: SerializedCheckIn[] = [];

 await createRunner(__dirname, 'scenario.ts')
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .expect({
 check_in: checkIn => {
 checkIns.push(checkIn);
 },
 })
 .start()
 .completed();

 const checkIn1InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'in_progress');
 const checkIn1Ok = checkIns.find(c => c.monitor_slug === 'cron-job-1' && c.status === 'ok');

 const checkIn2InProgress = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'in_progress');
 const checkIn2Ok = checkIns.find(c => c.monitor_slug === 'cron-job-2' && c.status === 'ok');

 expect(checkIn1InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn1Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2InProgress?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);
 expect(checkIn2Ok?.contexts?.trace?.trace_id).toMatch(/[a-f\d]{32}/);

 expect(checkIn1InProgress!.contexts?.trace?.trace_id).not.toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 expect(checkIn1Ok!.contexts?.trace?.span_id).not.toBe(checkIn2Ok!.contexts?.trace?.span_id);

 expect(checkIn1Ok!.contexts?.trace?.trace_id).toBe(checkIn1InProgress!.contexts?.trace?.trace_id);
 expect(checkIn2Ok!.contexts?.trace?.trace_id).toBe(checkIn2InProgress!.contexts?.trace?.trace_id);
 });
});

19 changes: 11 additions & 8 deletions
packages/core/src/exports.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,7 @@ import { getClient, getCurrentScope, getIsolationScope, withIsolationScope } fro
import { DEBUG_BUILD } from './debug-build';
import type { CaptureContext } from './scope';
import { closeSession, makeSession, updateSession } from './session';
import { startNewTrace } from './tracing/trace';
import type { CheckIn, FinishedCheckIn, MonitorConfig } from './types-hoist/checkin';
import type { Event, EventHint } from './types-hoist/event';
import type { EventProcessor } from './types-hoist/eventprocessor';
Expand DownExpand Up@@ -159,14 +160,14 @@ export function withMonitor<T>(
 callback: () => T,
 upsertMonitorConfig?: MonitorConfig,
): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();
 function runCallback(): T {
 const checkInId = captureCheckIn({ monitorSlug, status: 'in_progress' }, upsertMonitorConfig);
 const now = timestampInSeconds();

 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }

 return withIsolationScope(() => {
 function finishCheckIn(status: FinishedCheckIn['status']): void {
 captureCheckIn({ monitorSlug, status, checkInId, duration: timestampInSeconds() - now });
 }
Comment thread
cursor[bot] marked this conversation as resolved.

 // Default behavior without isolateTrace
 let maybePromiseResult: T;
 try {
 maybePromiseResult = callback();
Expand All@@ -190,7 +191,9 @@ export function withMonitor<T>(
 finishCheckIn('ok');

 return maybePromiseResult;
 });
 }

 return withIsolationScope(() => (upsertMonitorConfig?.isolateTrace ? startNewTrace(runCallback) : runCallback()));
}

/**
Expand Down

5 changes: 5 additions & 0 deletions
packages/core/src/types-hoist/checkin.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -105,4 +105,9 @@ export interface MonitorConfig {
 failureIssueThreshold?: SerializedMonitorConfig['failure_issue_threshold'];
 /** How many consecutive OK check-ins it takes to resolve an issue. */
 recoveryThreshold?: SerializedMonitorConfig['recovery_threshold'];
 /**
 * If set to true, creates a new trace for the monitor callback instead of continuing the current trace.
 * This allows distinguishing between different cron job executions.
 */
 isolateTrace?: boolean;
}

77 changes: 77 additions & 0 deletions
packages/core/test/lib/client.test.ts

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,7 @@ import {
import * as integrationModule from '../../src/integration';
import { _INTERNAL_captureLog } from '../../src/logs/internal';
import { _INTERNAL_captureMetric } from '../../src/metrics/internal';
import * as traceModule from '../../src/tracing/trace';
import { DEFAULT_TRANSPORT_BUFFER_SIZE } from '../../src/transports/base';
import type { Envelope } from '../../src/types-hoist/envelope';
import type { ErrorEvent, Event, TransactionEvent } from '../../src/types-hoist/event';
Expand DownExpand Up@@ -2732,6 +2733,82 @@ describe('Client', () => {
 const promise = await withMonitor('test-monitor', callback);
 await expect(promise).rejects.toThrowError(error);
 });

 describe('isolateTrace', () => {
 const startNewTraceSpy = vi.spyOn(traceModule, 'startNewTrace').mockImplementation(cb => cb());

 beforeEach(() => {
 startNewTraceSpy.mockClear();
 });

 it('starts a new trace when isolateTrace is true (sync)', () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it('starts a new trace when isolateTrace is true (async)', async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: true,
 });
 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).toHaveBeenCalledTimes(1);
 });

 it("doesn't start a new trace when isolateTrace is false (sync)", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace when isolateTrace is false (async)", async () => {
 const result = 'foo';
 const callback = vi.fn().mockResolvedValue(result);

 const promise = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 isolateTrace: false,
 });

 await expect(promise).resolves.toEqual(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });

 it("doesn't start a new trace by default", () => {
 const result = 'foo';
 const callback = vi.fn().mockReturnValue(result);

 const returnedResult = withMonitor('test-monitor', callback, {
 schedule: { type: 'crontab', value: '* * * * *' },
 });

 expect(returnedResult).toBe(result);
 expect(callback).toHaveBeenCalledTimes(1);
 expect(startNewTraceSpy).not.toHaveBeenCalled();
 });
 });
 });

 describe('enableLogs', () => {
Expand Down
Loading