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

naaa760 · 2025-11-03T09:36:29Z

Problem: Currently withMonitor() reuses the same trace for all cron executions, making it impossible to distinguish between different runs in Sentry.

Solution: Added optional isolateTrace: boolean to MonitorConfig that creates a separate trace for each monitor execution when enabled.

Benefits:

Clear separation of cron job executions in Sentry UI
Better debugging and performance monitoring
Fully backward compatible (opt-in feature)

Changes:

Added isolateTrace option to MonitorConfig interface
Modified withMonitor() to start new spans when enabled
Added comprehensive tests

Add optional isolateTrace boolean property to MonitorConfig interface to allow creating separate traces for each withMonitor execution.

Modify withMonitor to create new traces when isolateTrace option is enabled. When isolateTrace: true, starts a new span with monitor-specific naming to allow distinguishing between different cron job executions.

Add unit tests for the new isolateTrace option in withMonitor: - Test isolateTrace: true option acceptance - Test isolateTrace: false maintains default behavior - Test isolateTrace works with async operations

Lms24

Hi @naaa760 thanks for opening this PR!

I looked over it and I think we still need to make some changes to the PR. We also discussed this in the team internally, so here's how we'd like this option to be implemented:

If isolateTrace is true:

we only start a new trace. We can achieve this by calling startNewTrace and basically using the same callback you're currently adding to the startSpan callback.
we on purpose do not start a new span. We can revisit this in the future but for now, this is something, we'd rather like our users to take care of. The primary reason is that none of our cron instrumentation currently starts a new span, so if we were to do this, we should more universally agree on it (possibly across other SDKs).

=> isolateTrace should only apply on trace level, but not do more than that.

Furthermore, we need to add some tests that assert on the changed behaviour. The easiest way to test this properly would be to add new tests to our node-integration-tests dev package. In this test you can assert that the trace ids of the two created cron check-ins are distinct. Here's a link to a cron integration test. You can't use it 1:1 but it should provide a starting point.

Update withMonitor to use startNewTrace() instead of startSpan() when isolateTrace is enabled, following PR feedback to only isolate traces without creating spans.

Add node integration test to verify that withMonitor calls with isolateTrace: true generate different trace IDs, confirming trace isolation works as expected.

Lms24

Looks like a few CI jobs are still failing: The integration test (see my comment) as well as linting and formatting. I suggest running yarn lint in the core package and yarn fix:prettier on the entire repo.

Lms24 · 2025-11-10T12:55:22Z

dev-packages/node-integration-tests/suites/public-api/withMonitor/test.ts

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.

Rewrite integration test to use createRunner pattern like other tests. Test now properly captures check-ins and verifies distinct trace IDs when isolateTrace is enabled, following PR review feedback.

naaa760 · 2025-11-26T09:40:03Z

@Lms24
please check , I fixed it.
sorry for being a little late!

packages/core/src/exports.ts

Lms24 · 2025-11-28T12:35:08Z

I made some further changes to this PR that I wanna check with @JPeer264:

wrap the entire withMonitor call in an isolationScope so that the isolation scope is the same for the initial and the terminal checkins
call startNewTrace before making the initial checkin, so that initial and terminal checkins have the same trace

I think this makes sense but would appreciate another set of eyes.

JPeer264 · 2025-12-01T10:13:48Z

@Lms24 just had a look at it, this makes sense, yes. However the tests are still failing on this. @naaa760 do you need help there?

Lms24

I re-implemented a good part of this PR, so approving it kinda feels wrong 😅 However, we talked about this extensively offline and decided that wrapping the isolation scope (and startNewTrace() call optionally) over the entire checkin flow is the correct approach. So I'm gonna do it anyway

This PR contains the following updates: | Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) | |---|---|---|---| | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | [`10.27.0` -> `10.28.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/10.27.0/10.28.0) | ![age](https://developer.mend.io/api/mc/badges/age/npm/@sentry%2freact/10.28.0?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/@sentry%2freact/10.27.0/10.28.0?slim=true) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/react)</summary> ### [`v10.28.0`](https://github.com/getsentry/sentry-javascript/releases/tag/10.28.0) [Compare Source](getsentry/sentry-javascript@10.27.0...10.28.0) ##### Important Changes - **feat(core): Make `matcher` parameter optional in `makeMultiplexedTransport` ([#10798](getsentry/sentry-javascript#10798 The `matcher` parameter in `makeMultiplexedTransport` is now optional with a sensible default. This makes it much easier to use the multiplexed transport for sending events to multiple DSNs based on runtime configuration. **Before:** ```javascript import { makeFetchTransport, makeMultiplexedTransport } from '@sentry/browser'; const EXTRA_KEY = 'ROUTE_TO'; const transport = makeMultiplexedTransport(makeFetchTransport, args => { const event = args.getEvent(); if (event?.extra?.[EXTRA_KEY] && Array.isArray(event.extra[EXTRA_KEY])) { return event.extra[EXTRA_KEY]; } return []; }); Sentry.init({ transport, // ... other options }); // Capture events with routing info Sentry.captureException(error, { extra: { [EXTRA_KEY]: [ { dsn: 'https://key1@sentry.io/project1', release: 'v1.0.0' }, { dsn: 'https://key2@sentry.io/project2' }, ], }, }); ``` **After:** ```javascript import { makeFetchTransport, makeMultiplexedTransport, MULTIPLEXED_TRANSPORT_EXTRA_KEY } from '@sentry/browser'; // Just pass the transport generator - the default matcher handles the rest! Sentry.init({ transport: makeMultiplexedTransport(makeFetchTransport), // ... other options }); // Capture events with routing info using the exported constant Sentry.captureException(error, { extra: { [MULTIPLEXED_TRANSPORT_EXTRA_KEY]: [ { dsn: 'https://key1@sentry.io/project1', release: 'v1.0.0' }, { dsn: 'https://key2@sentry.io/project2' }, ], }, }); ``` The default matcher looks for routing information in `event.extra[MULTIPLEXED_TRANSPORT_EXTRA_KEY]`. You can still provide a custom matcher function for advanced use cases. - **feat(nextjs): Support cacheComponents on turbopack ([#18304](getsentry/sentry-javascript#18304 This release adds support for `cacheComponents` on turbopack builds. We are working on adding support for this feature in webpack builds as well. ##### Other Changes - feat: Publish AWS Lambda Layer for Node 24 ([#18327](getsentry/sentry-javascript#18327)) - feat(browser): Expose langchain instrumentation ([#18342](getsentry/sentry-javascript#18342)) - feat(browser): Expose langgraph instrumentation ([#18345](getsentry/sentry-javascript#18345)) - feat(cloudflare): Allow specifying a custom fetch in Cloudflare transport options ([#18335](getsentry/sentry-javascript#18335)) - feat(core): Add `isolateTrace` option to `Sentry.withMonitor()` ([#18079](getsentry/sentry-javascript#18079)) - feat(deps): bump [@sentry/webpack-plugin](https://github.com/sentry/webpack-plugin) from 4.3.0 to 4.6.1 ([#18272](getsentry/sentry-javascript#18272)) - feat(nextjs): Add cloudflare `waitUntil` detection ([#18336](getsentry/sentry-javascript#18336)) - feat(node): Add LangChain v1 support ([#18306](getsentry/sentry-javascript#18306)) - feat(remix): Add parameterized transaction naming for routes ([#17951](getsentry/sentry-javascript#17951)) - fix(cloudflare): Keep http root span alive until streaming responses are consumed ([#18087](getsentry/sentry-javascript#18087)) - fix(cloudflare): Wait for async events to finish ([#18334](getsentry/sentry-javascript#18334)) - fix(core): `continueTrace` doesn't propagate given trace ID if active span exists ([#18328](getsentry/sentry-javascript#18328)) - fix(node-core): Handle custom scope in log messages without parameters ([#18322](getsentry/sentry-javascript#18322)) - fix(opentelemetry): Ensure Sentry spans don't leak when tracing is disabled ([#18337](getsentry/sentry-javascript#18337)) - fix(react-router): Use underscores in trace origin values ([#18351](getsentry/sentry-javascript#18351)) - chore(tanstackstart-react): Export custom inits from tanstackstart-react ([#18369](getsentry/sentry-javascript#18369)) - chore(tanstackstart-react)!: Remove empty placeholder implementations ([#18338](getsentry/sentry-javascript#18338)) <details> <summary><strong>Internal Changes</strong></summary> - chore: Allow URLs as issue ([#18372](getsentry/sentry-javascript#18372)) - chore(changelog): Add entry for [#18304](getsentry/sentry-javascript#18304) ([#18329](getsentry/sentry-javascript#18329)) - chore(ci): Add action to track all PRs as issues ([#18363](getsentry/sentry-javascript#18363)) - chore(github): Adjust `BUGBOT.md` rules to flag invalid op and origin values during review ([#18352](getsentry/sentry-javascript#18352)) - ci: Add action to create issue on gitflow merge conflicts ([#18319](getsentry/sentry-javascript#18319)) - ci(deps): bump actions/checkout from 5 to 6 ([#18268](getsentry/sentry-javascript#18268)) - ci(deps): bump peter-evans/create-pull-request from 7.0.8 to 7.0.9 ([#18361](getsentry/sentry-javascript#18361)) - test(cloudflare): Add typechecks for cloudflare-worker e2e test ([#18321](getsentry/sentry-javascript#18321)) </details> #### Bundle size 📦 | Path | Size | | ----------------------------------------------------------------------------------------------------- | --------- | | [@sentry/browser](https://github.com/sentry/browser) | 24.22 KB | | [@sentry/browser](https://github.com/sentry/browser) - with treeshaking flags | 22.76 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing) | 40.57 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Profiling) | 45.05 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay) | 78.08 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay) - with treeshaking flags | 68.05 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay with Canvas) | 82.65 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Tracing, Replay, Feedback) | 94.61 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. Feedback) | 40.51 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. sendFeedback) | 28.8 KB | | [@sentry/browser](https://github.com/sentry/browser) (incl. FeedbackAsync) | 33.66 KB | | [@sentry/react](https://github.com/sentry/react) | 25.9 KB | | [@sentry/react](https://github.com/sentry/react) (incl. Tracing) | 42.72 KB | | [@sentry/vue](https://github.com/sentry/vue) | 28.56 KB | | [@sentry/vue](https://github.com/sentry/vue) (incl. Tracing) | 42.32 KB | | [@sentry/svelte](https://github.com/sentry/svelte) | 24.24 KB | | CDN Bundle | 26.57 KB | | CDN Bundle (incl. Tracing) | 41.22 KB | | CDN Bundle (incl. Tracing, Replay) | 76.9 KB | | CDN Bundle (incl. Tracing, Replay, Feedback) | 82.23 KB | | CDN Bundle - uncompressed | 78.09 KB | | CDN Bundle (incl. Tracing) - uncompressed | 122.4 KB | | CDN Bundle (incl. Tracing, Replay) - uncompressed | 235.71 KB | | CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed | 248.17 KB | | [@sentry/nextjs](https://github.com/sentry/nextjs) (client) | 44.88 KB | | [@sentry/sveltekit](https://github.com/sentry/sveltekit) (client) | 40.92 KB | | [@sentry/node-core](https://github.com/sentry/node-core) | 50.06 KB | | [@sentry/node](https://github.com/sentry/node) | 155.7 KB | | [@sentry/node](https://github.com/sentry/node) - without tracing | 90.67 KB | | [@sentry/aws-serverless](https://github.com/sentry/aws-serverless) | 105.61 KB | </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.foxden.network/foxCaves/foxCaves/pulls/12 Co-authored-by: Renovate <renovate@foxden.network> Co-committed-by: Renovate <renovate@foxden.network>

naaa760 added 3 commits November 3, 2025 14:58

feat(core): Add isolateTrace option to MonitorConfig

2b4f7c1

Add optional isolateTrace boolean property to MonitorConfig interface to allow creating separate traces for each withMonitor execution.

feat(core): Implement isolateTrace in withMonitor function

382fdc6

Modify withMonitor to create new traces when isolateTrace option is enabled. When isolateTrace: true, starts a new span with monitor-specific naming to allow distinguishing between different cron job executions.

test(core): Add tests for isolateTrace functionality

4dfa0af

Add unit tests for the new isolateTrace option in withMonitor: - Test isolateTrace: true option acceptance - Test isolateTrace: false maintains default behavior - Test isolateTrace works with async operations

This comment was marked as outdated.

Sign in to view

Lms24 reviewed Nov 4, 2025

View reviewed changes

naaa760 added 2 commits November 7, 2025 15:32

feat: Update isolateTrace implementation to use startNewTrace

e06ae30

Update withMonitor to use startNewTrace() instead of startSpan() when isolateTrace is enabled, following PR feedback to only isolate traces without creating spans.

test: Add integration test for isolateTrace functionality

a16ae77

Add node integration test to verify that withMonitor calls with isolateTrace: true generate different trace IDs, confirming trace isolation works as expected.

naaa760 force-pushed the feat/monitor-trace branch from 4b663d6 to a16ae77 Compare November 7, 2025 10:07

Lms24 changed the title ~~feat: add isolateTrace option to Sentry.withMonitor()~~ feat(core): Add isolateTrace option to Sentry.withMonitor() Nov 8, 2025

Lms24 self-requested a review November 8, 2025 12:46

Lms24 reviewed Nov 10, 2025

View reviewed changes

naaa760 added 3 commits November 26, 2025 15:03

test: Fix withMonitor integration test to use proper test runner

50d5386

Rewrite integration test to use createRunner pattern like other tests. Test now properly captures check-ins and verifies distinct trace IDs when isolateTrace is enabled, following PR review feedback.

fix: Add newline at end of scenario file

4215d49

test: Remove comments from withMonitor scenario file

7d10a53

naaa760 force-pushed the feat/monitor-trace branch from 1f68a9a to 7d10a53 Compare November 26, 2025 09:39

Merge branch 'develop' into feat/monitor-trace

b9b6ba7

cursor bot reviewed Nov 26, 2025

View reviewed changes

packages/core/src/exports.ts Outdated Show resolved Hide resolved

ensure initial checkin and terminal checkin have same trace

ad7c159

formatting and linting

b12304b

Lms24 requested a review from JPeer264 November 28, 2025 12:37

fix unit tests, fix integration tests

4551a8e

Lms24 approved these changes Dec 2, 2025

View reviewed changes

Lms24 merged commit 775ad19 into getsentry:develop Dec 2, 2025
185 checks passed

github-actions bot mentioned this pull request Dec 2, 2025

Add option to create a new trace for Sentry.withMonitor() #18058

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

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

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

Uh oh!

naaa760 commented Nov 3, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Lms24 left a comment

Uh oh!

Lms24 left a comment •

edited

Loading

Uh oh!

Lms24 Nov 10, 2025

Uh oh!

naaa760 commented Nov 26, 2025 •

edited

Loading

Uh oh!

Uh oh!

Lms24 commented Nov 28, 2025

Uh oh!

JPeer264 commented Dec 1, 2025

Uh oh!

Lms24 left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

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

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

Uh oh!

Conversation

naaa760 commented Nov 3, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

Lms24 left a comment

Choose a reason for hiding this comment

Uh oh!

Lms24 left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Lms24 Nov 10, 2025

Choose a reason for hiding this comment

Uh oh!

naaa760 commented Nov 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Lms24 commented Nov 28, 2025

Uh oh!

JPeer264 commented Dec 1, 2025

Uh oh!

Lms24 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

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

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

Lms24 left a comment •

edited

Loading

naaa760 commented Nov 26, 2025 •

edited

Loading