Skip to content

feat(node): Add Crons monitoring for graphile-worker crontab jobs - #25475

Draft
wedamija wants to merge 2 commits into
developfrom
danf/graphile-worker-crons
Draft

wedamija wants to merge 2 commits into
developfrom
danf/graphile-worker-crons

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 graphileWorkerIntegration for graphile-worker 0.16 to 0.18. With monitorCronJobs: true, each job the crontab schedules sends an in_progress check-in when it starts and ok or error when it completes. Errors are also captured. The job runs and fails exactly as before: the integration only listens to the runner's job:start and job:complete events, which it gets from the instrumented runCron.

Sentry.init({
  dsn: '...',
  integrations: [
    Sentry.graphileWorkerIntegration({
      monitorCronJobs: true,
      excludeCronJobs: ['cleanup', /^dev_/], // optional
    }),
  ],
});

The slug is the crontab item identifier (?id=, or else the task identifier), which graphile-worker already requires to be unique. A cron job only carries its task, payload and scheduled time, so the integration matches it to the item by task and schedule, then by payload; jobs it can't match to exactly one item, and jobs not scheduled by the crontab, are not monitored. Jobs are only monitored by a process that runs the crontab, which run() does by default.

This PR sends check-ins without a monitor config. The stacked follow-up sends the crontab schedule.

Testing

Unit tests, and a node integration test against Postgres with graphile-worker 0.16 and 0.18 (ESM and CJS) that uses ?fill backfill to run the jobs right away.

`graphileWorkerIntegration({ monitorCronJobs: true })` sends check-ins for
the jobs the graphile-worker crontab schedules, using the crontab item
identifier as monitor slug. `excludeCronJobs` skips items.

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

github-actions Bot commented Oct 17, 2026 •

Copy link
Copy Markdown
Contributor

size-limit report 📦

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.19 kB +0.08% +110 B 🔺
@sentry/node/import (ESM hook with diagnostics-channel injection) 84.09 kB +0.06% +47 B 🔺
@sentry/node - without tracing 94.92 kB +0.05% +44 B 🔺
@sentry/node - without channel injection 131.22 kB +0.06% +74 B 🔺
@sentry/aws-serverless 103.09 kB +0.06% +55 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

Bun's `bun run` doesn't inject the channels, and the CJS test of the
ESM-only graphile-worker 0.18 isn't hooked on Node 20 or Deno.

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

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