Skip to content

feat(node): Add cronJobIntegration to monitor cron jobs - #25477

Draft
wedamija wants to merge 4 commits into
danf/node-schedule-monitor-jobsfrom
danf/cron-monitor-jobs
Draft

wedamija wants to merge 4 commits into
danf/node-schedule-monitor-jobsfrom
danf/cron-monitor-jobs

Conversation

@wedamija

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.

Description

Adds cronJobIntegration, which sends check-ins for every CronJob of the cron package that has a name, without Sentry.cron.instrumentCron. Job names were added in cron 4.3.0, so older versions are not instrumented. Adding the integration is the opt-in. It's named after CronJob because Sentry.cron is already the namespace of the wrapper functions.

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

CronJob.from({ name: 'daily-report', cronTime: '0 30 9 * * 1-5', timeZone: 'Europe/Vienna', onTick: sendReport, start: true });

The slug is the job name; jobs without one, and one-off jobs (a Date or Luxon DateTime), are not monitored. The cron expression and timeZone (the server's time zone without one) are sent as the monitor config. Schedules that can't be expressed in the Crons schedule format (for example, a job that runs every 10 seconds), day-field combinations Sentry reads differently, and utcOffset check in without a config. Jobs created by instrumentCron are skipped.

@nestjs/schedule creates its jobs with CronJob.from() and passes the @Cron() name, so in NestJS apps use nestIntegration({ monitorCronJobs: true }) (#25471) instead of this integration, or both send check-ins for the same job.

The node integration tests move to cron 4.x, the version this needs; the existing instrumentCron scenario only needed running renamed to isActive.

Testing

Node integration test with real cron 4.4 in ESM and CJS.

Stacked on #25474.

Sends check-ins for every named CronJob of the cron package (4.3+)
through the orchestrion channel injection, with the cron expression and
time zone as monitor config when Sentry reads it the same way. Bumps the
cron dev dependency of the node integration tests to 4.x.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

size-limit report 📦

⚠️ Warning: Base artifact is not the latest one, because the latest workflow run is not done yet. This may lead to incorrect results. Try to re-run all tests to get up to date results.

Path Size % Change Change
@sentry/browser 29.88 kB - -
@sentry/browser - with treeshaking flags 28.02 kB - -
@sentry/browser - with treeshaking flags tracing without tracing 27.92 kB - -
@sentry/browser (incl. Tracing) 52.07 kB - -
@sentry/browser (incl. Tracing + Span Streaming) 52.07 kB - -
@sentry/browser (incl. Tracing, Profiling) 55.02 kB - -
@sentry/browser (incl. Tracing, Replay) 91.82 kB - -
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags 80.68 kB - -
@sentry/browser (incl. Tracing, Replay with Canvas) 96.55 kB - -
@sentry/browser (incl. Tracing, Replay, Feedback) 109.49 kB - -
@sentry/browser (incl. Feedback) 47.4 kB - -
@sentry/browser (incl. sendFeedback) 34.94 kB - -
@sentry/browser (incl. FeedbackAsync) 40.05 kB - -
@sentry/browser (incl. Metrics) 30.9 kB - -
@sentry/browser (incl. Logs) 31.18 kB - -
@sentry/browser (incl. Metrics & Logs) 31.81 kB - -
@sentry/react 31.7 kB - -
@sentry/react (incl. Tracing) 54.39 kB - -
@sentry/vue 38.04 kB - -
@sentry/vue (incl. Tracing) 55.01 kB - -
@sentry/svelte 29.9 kB - -
@sentry/remix (Remix 3 client bundle) 57.08 kB - -
CDN Bundle 31.64 kB - -
CDN Bundle (incl. Tracing) 52.58 kB - -
CDN Bundle (incl. Logs, Metrics) 33.84 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) 54.52 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) 74.77 kB - -
CDN Bundle (incl. Tracing, Replay) 90.25 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) 92.18 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) 96.4 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) 98.34 kB - -
CDN Bundle - uncompressed 93.18 kB - -
CDN Bundle (incl. Tracing) - uncompressed 156.03 kB - -
CDN Bundle (incl. Logs, Metrics) - uncompressed 99.72 kB - -
CDN Bundle (incl. Tracing, Logs, Metrics) - uncompressed 161.99 kB - -
CDN Bundle (incl. Replay, Logs, Metrics) - uncompressed 229.76 kB - -
CDN Bundle (incl. Tracing, Replay) - uncompressed 276.2 kB - -
CDN Bundle (incl. Tracing, Replay, Logs, Metrics) - uncompressed 282.14 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed 289.9 kB - -
CDN Bundle (incl. Tracing, Replay, Feedback, Logs, Metrics) - uncompressed 295.84 kB - -
@sentry/nextjs (client) 56.8 kB - -
@sentry/sveltekit (client) 52.45 kB - -
@sentry/core/server 41.12 kB - -
@sentry/core/browser 13.81 kB - -
@sentry/node 153.31 kB +0.15% +228 B 🔺
@sentry/node/import (ESM hook with diagnostics-channel injection) 84.18 kB +0.17% +141 B 🔺
@sentry/node - without tracing 95.03 kB +0.17% +157 B 🔺
@sentry/node - without channel injection 131.31 kB +0.13% +159 B 🔺
@sentry/aws-serverless 103.2 kB +0.16% +164 B 🔺
@sentry/cloudflare (withSentry) - minified 210.6 kB - -
@sentry/cloudflare (withSentry) 522.53 kB - -
@sentry/nextjs/cloudflare (withSentry) - minified 228.27 kB - -

View base workflow run

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.

1 participant