-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(cron): Add node cron library instrumentation docs #8816
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few small comments, but overall looks good!
src/includes/javascript-crons-automatic-crons-instrumentation.mdx
Outdated
Show resolved
Hide resolved
src/includes/javascript-crons-automatic-crons-instrumentation.mdx
Outdated
Show resolved
Hide resolved
src/includes/javascript-crons-automatic-crons-instrumentation.mdx
Outdated
Show resolved
Hide resolved
|
||
Use `Sentry.cron.instrumentNodeCron` to instrument cron export from the `node-cron` library. This returns an object with the same API as the original `cron` export, but with the `schedule` method instrumented. You can pass the name of the cron monitor and an optional timezone as part of the third options argument to the function. | ||
|
||
Requires SDK version `7.92.0` or higher. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If both options have this as a prereq, should we move this line to directly under "Automatic Crons Instrumentation"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes I'll make the change, good idea.
Co-authored-by: Shana Matthews <[email protected]>
Documents getsentry/sentry-javascript#9999 and getsentry/sentry-javascript#9904