Skip to content

feat(node): Add nodeCronIntegration to monitor node-cron tasks - #25473

Open
wedamija wants to merge 11 commits into
developfrom
danf/node-cron-monitor-jobs
Open

wedamija wants to merge 11 commits into
developfrom
danf/node-cron-monitor-jobs

Conversation

@wedamija

@wedamija wedamija commented Oct 17, 2026 •

Copy link
Copy Markdown
Member

Part of a series adding automatic Crons monitoring for the most-used job schedulers in each SDK. Check-ins for a monitor that doesn't exist yet are dropped, so today each monitor has to be created by hand with its schedule copied from the code. Sending the job's schedule as the monitor config lets Sentry create the monitor and keep it in sync.

Adds nodeCronIntegration, which sends check-ins for every named node-cron task (3.x and 4.x) with its schedule and time zone as the monitor config. Today each module has to be wrapped in Sentry.cron.instrumentNodeCron; with this, adding the integration is enough. It is not a default integration. Tasks without a name aren't monitored.

Sentry.init({
  dsn: '...',
  integrations: [Sentry.nodeCronIntegration({ excludeJobs: ['cleanup', /^debug-/] })],
});

cron.schedule('0 9 * * 1-5', sendReport, { name: 'daily-report', timezone: 'Europe/Vienna' });

Schedules Crons can't express, like every 10 seconds, check in without a config, and so do node-cron 3 schedules with steps it reads differently from standard cron, like */2 days. Tasks already wrapped by instrumentNodeCron are skipped, so using both doesn't send duplicate check-ins.

@github-actions

github-actions Bot commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor

size-limit report 📦

Compared: de7a020 (PR test merge using develop at a33cba8)

Against: a33cba8 (develop) · base run #64006

✅ Baseline matches: this diff contains only this PR's changes.

Path Size % Change Change
@sentry/browser 30.34 kB - -
@sentry/browser - with treeshaking flags 28.46 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 28.35 kB - -
@sentry/browser (incl. Tracing) 52.61 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 52.62 kB - -
@sentry/browser (incl. Tracing, Profiling) 55.54 kB - -
@sentry/browser (incl. Tracing, Replay) 92.81 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 81.43 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 97.54 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 110.52 kB - -
@sentry/browser (incl. Feedback) 47.9 kB - -
@sentry/browser (incl. sendFeedback) 35.41 kB - -
@sentry/browser (incl. FeedbackAsync) 40.52 kB - -
@sentry/browser (incl. Metrics) 31.35 kB - -
@sentry/browser (incl. Logs) 31.63 kB - -
@sentry/browser (incl. Metrics & Logs) 32.31 kB - -
@sentry/react 32.16 kB - -
@sentry/react (incl. Tracing) 54.89 kB - -
@sentry/vue 38.61 kB - -
@sentry/vue (incl. Tracing) 55.5 kB - -
@sentry/svelte 30.37 kB - -
@sentry/remix (Remix 3 client bundle) 57.65 kB - -
CDN Bundle 32.07 kB - -
CDN Bundle (incl. Tracing) 53.1 kB - -
CDN Bundle (incl. Logs, Metrics) 34.27 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 55.05 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 75.69 kB - -
CDN Bundle (incl. Tracing, Replay) 91.23 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 93.17 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 97.36 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 99.34 kB - -
CDN Bundle - uncompressed 94.31 kB - -
CDN Bundle (incl. Tracing) - uncompressed 157.3 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 100.86 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 163.27 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 232.36 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 278.93 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 284.88 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 292.63 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 298.58 kB - -
@sentry/nextjs (client) 57.75 kB - -
@sentry/sveltekit (client) 53.06 kB - -
@sentry/core/server 44.29 kB - -
@sentry/core/browser 13.95 kB - -
@sentry/node 155.17 kB +0.09% +132 B 🔺
@sentry/node/import (ESM hook with diagnostics-channel injection) 81.77 kB +0.13% +102 B 🔺
@sentry/node - without tracing 95.87 kB +0.12% +106 B 🔺
@sentry/node - without channel injection 135.78 kB +0.08% +107 B 🔺
@sentry/aws-serverless 104.05 kB +0.11% +114 B 🔺
@sentry/cloudflare (withSentry) - minified 197.89 kB - -
@sentry/cloudflare (withSentry) 491.81 kB - -
@sentry/nextjs/cloudflare (withSentry) - minified 218.47 kB - -

View base workflow run

wedamija and others added 4 commits October 19, 2026 17:48
Sends check-ins for every named node-cron task through the orchestrion
createTask channel, with the task's schedule and time zone as monitor
config when Sentry reads it the same way. Tasks without a name, and
tasks wrapped by Sentry.cron.instrumentNodeCron, are skipped.

Co-Authored-By: Claude <noreply@anthropic.com>
Prepares for other scheduler integrations; the helper also handles
schedulers that run on either day field (cron-parser, cron).

Co-Authored-By: Claude <noreply@anthropic.com>
The error event and the error check-in can arrive in either order.

Co-Authored-By: Claude <noreply@anthropic.com>
…-in modules

`bun run` can't inject channels into libraries. nodeCronIntegration is
opt-in, so it has no lazy channel-integration definition.

Co-Authored-By: Claude <noreply@anthropic.com>
@wedamija
wedamija force-pushed the danf/node-cron-monitor-jobs branch from 2c2c600 to 905ed6b Compare October 20, 2026 00:51
…reads differently

node-cron 4.0 to 4.2 ship `dist/cjs` and `dist/esm` builds, which weren't instrumented. node-cron 3 keeps the values of a stepped field that are multiples of the step (`*/2` days run on 2, 4, ...), so those tasks now check in without a monitor config.

Also moves the channel subscription and job filtering into shared helpers for the other scheduler integrations.

Co-Authored-By: Claude <noreply@anthropic.com>
@wedamija
wedamija marked this pull request as ready for review October 21, 2026 01:02
@wedamija
wedamija requested review from a team as code owners October 21, 2026 01:02
@wedamija
wedamija requested review from chargome, isaacs, mydea and s1gr1d and removed request for a team October 21, 2026 01:02

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit ffb2c5d. Configure here.

Comment thread packages/node/src/cron/node-cron.ts Outdated
@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Optional E2E tests

Some optional checks were not successful. They do not block the merge. 2 not successful, 65 successful. See the run.

Check Status
❌ CI: Optional E2E Tests / E2E node-anthropic-send-to-sentry (latest) Test (optional) Failing after 3m Details
❌ CI: Optional E2E Tests / E2E react-send-to-sentry Test (optional) Failing after 4m Details
Successful checks
Check Status
✅ CI: Optional E2E Tests / E2E astro-7 Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries Test (optional) Successful in 50s Details
✅ CI: Optional E2E Tests / E2E nextjs-14 (latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (canary, turbopack) Test (optional) Successful in 4m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-flue-send-to-sentry (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-agent Test (optional) Successful in 25s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (deno) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (canary, webpack) Test (optional) Successful in 6m Details
✅ CI: Optional E2E Tests / E2E debug-id-sourcemaps Test (optional) Successful in 22s Details
✅ CI: Optional E2E Tests / E2E astro-7-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E gen-ai-libraries (cloudflare) Test (optional) Successful in 38s Details
✅ CI: Optional E2E Tests / E2E cloudflare-workers-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E angular (canary) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E angular (canary) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (cloudflare, latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E cloudflare-think (ai v6) Test (optional) Successful in 40s Details
✅ CI: Optional E2E Tests / E2E nextjs-14 (canary) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-flue-send-to-sentry Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E deno (latest) Test (optional) Successful in 49s Details
✅ CI: Optional E2E Tests / E2E nextjs-16-tunnel (cloudflare) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-pi-durable (latest) Test (optional) Successful in 27s Details
✅ CI: Optional E2E Tests / E2E cloudflare-mastra Test (optional) Successful in 36s Details
✅ CI: Optional E2E Tests / E2E node-mastra (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-openai-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E nextjs-16-standalone (canary, turbopack) Test (optional) Successful in 40s Details
✅ CI: Optional E2E Tests / E2E nextjs-15 (turbo) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E solidstart-2 Test (optional) Successful in 46s Details
✅ CI: Optional E2E Tests / E2E node-flue (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 Test (optional) Successful in 27s Details
✅ CI: Optional E2E Tests / E2E nextjs-16 (vinext, bun) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-anthropic-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-cloudflare Test (optional) Successful in 50s Details
✅ CI: Optional E2E Tests / E2E cloudflare-pi-durable (latest) Test (optional) Successful in 41s Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-pi-durable Test (optional) Successful in 39s Details
✅ CI: Optional E2E Tests / E2E node-mastra Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions-send-to-sentry (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-flue-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5 Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E nuxt-3 (canary) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-4-static (canary) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E nuxt-4 (canary) Test (optional) Successful in 3m Details
✅ CI: Optional E2E Tests / E2E node-eve (orchestrion) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (static / nuxt generate) Test (optional) Successful in 30s Details
✅ CI: Optional E2E Tests / E2E node-openai-decisions-send-to-sentry Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-eve (latest) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-flue Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v1 Test (optional) Successful in 33s Details
✅ CI: Optional E2E Tests / E2E nextjs-orpc Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps (client source maps kept) Test (optional) Successful in 28s Details
✅ CI: Optional E2E Tests / E2E node-eve Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E react-router-7-framework-instrumentation Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E node-fastify-6 (tracer provider) Test (optional) Successful in 29s Details
✅ CI: Optional E2E Tests / E2E node-express-mcp-v2 Test (optional) Successful in 31s Details
✅ CI: Optional E2E Tests / E2E nuxt-5-sourcemaps Test (optional) Successful in 30s Details
✅ CI: Optional E2E Tests / E2E node-express-send-to-sentry-static Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E node-openai-send-to-sentry (latest) Test (optional) Successful in 2m Details
✅ CI: Optional E2E Tests / E2E supabase-nextjs Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E vue-3 (canary) Test (optional) Successful in 1m Details
✅ CI: Optional E2E Tests / E2E tanstackstart-react-sourcemaps Test (optional) Successful in 28s Details
✅ CI: Optional E2E Tests / E2E vue-3 (no Options API) Test (optional) Successful in 1m Details

Comment thread packages/server-utils/src/integrations/node-cron.ts Outdated
@wedamija
wedamija requested a review from mydea October 23, 2026 17:09
@linear-code

linear-code Bot commented Oct 25, 2026

Copy link
Copy Markdown

JS-187

Comment thread packages/server-utils/src/integrations/node-cron.ts
});
}

/** Whether a job is named, not excluded, and not already monitored by `Sentry.cron.instrument*`. */

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.

is this true? It is set by instrumentCronIntegration I suppose?

const defined = new Set(CHANNEL_INTEGRATION_DEFINITIONS.flatMap(d => d.modules as readonly string[]));

// `@nestjs/*` and `@remix-run/*` are covered by listeners in their own SDK packages.
// Crons integrations are opt-in, so bundler-only SDKs must not install them for every app.

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.

we should state here why this is opt in? I guess because this is paid, which makes sense, but is not clear from reading the code.

@mydea

mydea commented Oct 28, 2026

Copy link
Copy Markdown
Member

This seems generally good to me, left some small comments, I wonder though, what about bun and deno, should this not be exported and work there too?

@wedamija

Copy link
Copy Markdown
Member Author

This seems generally good to me, left some small comments, I wonder though, what about bun and deno, should this not be exported and work there too?

Good call, it looks like we already export this to bun, but I added it to deno.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants