feat(cron): Add node cron library instrumentation docs #8816
Conversation
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
AbhiPrasad
requested review from
a team,
anonrig,
gaprl and
mydea
and removed request for
a team
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
anonrig
approved these changes
Jan 4, 2024
shanamatthews
approved these changes
Jan 5, 2024
Contributor
shanamatthews
left a comment
shanamatthews
left a comment
There was a problem hiding this comment.
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. |
Contributor
There was a problem hiding this comment.
If both options have this as a prereq, should we move this line to directly under "Automatic Crons Instrumentation"?
Member
Author
There was a problem hiding this comment.
Yes I'll make the change, good idea.
Co-authored-by: Shana Matthews <[email protected]>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Documents getsentry/sentry-javascript#9999 and getsentry/sentry-javascript#9904