Repository navigation
feat(nestjs): Add an option to monitor every @Cron method - #25471
Merged
Merged
Conversation
When `@SentryCron` is used without a monitor config, read the schedule and time zone from the `@Cron()` decorator of `@nestjs/schedule` on the same method. Check-ins then carry a monitor config, so Sentry creates the monitor on the first run instead of dropping the check-ins. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Only read the `@Cron()` schedule when `@SentryCron` gets
`{ fromCronDecorator: true }`, so existing usage keeps sending check-ins
without a monitor config. Other monitor settings passed alongside the flag
are kept.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
`@SentryCron` now sends the schedule of the method's `@Cron()` decorator unless it gets a monitor config with a schedule. Other monitor settings can still be passed and are merged in, and `fromCronDecorator: false` turns this off. When `@Cron()` has no `timeZone`, the job runs in the server's local time zone, so that zone is sent instead of leaving Sentry to assume UTC. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
`@Cron()` presets are now sent: the ones Sentry accepts as is, and `@midnight`, `@minutely`, `@weekdays` and `@weekends` as crontabs. When no schedule can be derived but monitor settings were passed, a debug warning says no monitor config is sent. The settings type now rejects `schedule` and `timezone`, and a full monitor config rejects `fromCronDecorator`, so mixed objects no longer drop fields silently. Adds an E2E case for a disabled `@Cron()` job triggered through an endpoint. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Skip numeric months (cron 2.x counts from 0), day-of-month/day-of-week combinations Sentry would AND, and time zones Sentry rejects. Clarify the warning when fromCronDecorator is false. Co-Authored-By: Claude <noreply@anthropic.com>
Allow month steps like */3 (CronExpression.EVERY_QUARTER), still skipping month numbers. Drop the @midnight and @annually presets, which cron rejects. Skip full day ranges like 1-31 when the other day field is set, and send the canonical time zone name. Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude <noreply@anthropic.com>
`nestIntegration({ monitorCronJobs: true })` sends check-ins for every
`@Cron()` method, with the schedule from `@Cron()` as monitor config.
The slug is the `@Cron()` name, else `ClassName.methodName`.
`excludeCronJobs` skips jobs; methods with `@SentryCron` keep their slug.
Co-Authored-By: Claude <noreply@anthropic.com>
1 of 3 tasks
Contributor
size-limit report 📦Compared: b14a1fc (PR test merge using develop at 34dfa4d) Against: 34dfa4d (develop) · base run #64564 ✅ Baseline matches: this diff contains only this PR's changes.
|
wedamija
changed the title
wedamija
marked this pull request as ready for review
October 20, 2026 23:53
wedamija
requested review from
chargome and
s1gr1d
and removed request for
a team
October 20, 2026 23:53
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Contributor
@nestjs/schedule runs @Cron methods as cron CronJobs, so with monitorCronJobs and cronJobIntegration both on each run sent two sets of check-ins. Mark the onTick Nest passes to CronJob when the method already sends check-ins.
wedamija
requested review from
andreiborza and
isaacs
and removed request for
a team
October 28, 2026 19:20
…nf/nestjs-cron-auto-monitor # Conflicts: # packages/nestjs/src/integrations/orchestrion-subscriber.ts
wedamija
requested review from
logaretm and
msonnb
and removed request for
a team
October 28, 2026 19:49
Key the monitored check on the @Cron() options metadata, which outer decorators copy, so it doesn't depend on decorator order.
Contributor
Optional E2E testsSome optional checks were not successful. They do not block the merge. 11 not successful, 43 successful. See the run.
Successful checks
|
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 0c123c6. Configure here.
…s on @nestjs/schedule 4+ A day field that covers every day (like sun-sat or 0,1,2,3,4,5,6) is ignored by cron but ORed by Sentry, so those schedules are now found by counting the expanded values. Numeric months are sent when the @Cron() instrumentation saw @nestjs/schedule 4 or later, where cron counts months from 1.
…-nest-auto # Conflicts: # packages/nestjs/src/decorators.ts # packages/nestjs/src/integrations/helpers.ts # packages/nestjs/src/integrations/orchestrion-subscriber.ts
… jobs monitorCronJobs only covers @Cron() methods whose schedule Sentry can represent. Methods with @SentryCron() keep checking in without a config.
…o-monitor # Conflicts: # CHANGELOG.md # dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts # dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.service.ts # dev-packages/e2e-tests/test-applications/nestjs-basic/tests/cron-decorator.test.ts # packages/nestjs/src/decorators.ts # packages/nestjs/src/integrations/helpers.ts # packages/nestjs/src/integrations/orchestrion-subscriber.ts
isaacs
approved these changes
Oct 31, 2026
isaacs
left a comment
isaacs
left a comment
Member
There was a problem hiding this comment.
Approving to unblock. I think this is fine to land once the trace propagation comment is resolved (assuming that it should come before #25477 and not wait for that one to land first; I haven't looked closely at that PR yet, so it might be obvious, but just saw that's where the mentioned method gets added). The others are pretty minor concerns.
Would also be good to add an "Unreleased" CHANGELOG.md entry for monitorCronJobs to say that it is off by default and that each monitored job creates a monitor.
Without it every run shares the trace that was active when the app started.
wedamija
added a commit
that referenced
this pull request
Nov 2, 2026
I missed the request for a changelog entry in #25471, adding it here
wedamija
added a commit
that referenced
this pull request
Nov 3, 2026
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 `cronJobIntegration`, which sends check-ins for every named
`CronJob` of the `cron` package with its cron expression and `timeZone`
as the monitor config. It replaces `Sentry.cron.instrumentCron`. Adding
the integration is the opt-in. Job names came in `cron` 4.3.0, so older
versions aren't instrumented.
```js
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 });
```
Jobs with `utcOffset`, and schedules Crons can't express, like every 10
seconds, aren't monitored. Jobs created by `instrumentCron` are skipped.
`@nestjs/schedule` builds its jobs on `CronJob`. Jobs that
`nestIntegration` already monitors
(#25471) are skipped,
so enabling both sends one set of check-ins. The node integration tests
move to `cron` 4.4.
---------
Co-authored-by: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
monitorCronJobstonestIntegration. When it's on, every@Cron()method sends check-ins with the schedule and time zone from@Cron()as the monitor config, so apps don't need@SentryCronon each method. It is off by default. The slug is the@Cron()name, orClassName.methodNamewithout one.Methods that also have
@SentryCronkeep their slug and send one set of check-ins. Methods with schedules Crons can't express, like every 10 seconds, aren't monitored. It needsenableRuntimeChannelInjection, which is on by default.Stacked on #25013.