Skip to content

docs(js): Document the graphile-worker crontab monitor config #20068

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.

Sign up for GitHub

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

Draft
wedamija wants to merge 1 commit into
base: danf/graphile-worker-crons
Choose a base branch
from
Draft

docs(js): Document the graphile-worker crontab monitor config #20068

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions includes/javascript-crons-automatic-crons-instrumentation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ For cron strings, each check-in sends the schedule and time zone (your server's

Requires SDK version `11.5.0` or higher and `graphile-worker` version `0.16.0` or higher.

Use `Sentry.graphileWorkerIntegration` to monitor the jobs that the [`graphile-worker`](https://www.npmjs.com/package/graphile-worker) crontab schedules:
Use `Sentry.graphileWorkerIntegration` to monitor the jobs that the [`graphile-worker`](https://www.npmjs.com/package/graphile-worker) crontab schedules. Each run sends a check-in with the crontab schedule, in UTC, so Sentry creates the monitor on the first run:

```JavaScript
Sentry.init({
Expand All @@ -181,4 +181,4 @@ Sentry.init({

The monitor slug is the crontab item's identifier: its `id` option, or the task name if there's no `id`. `excludeCronJobs` skips items whose identifier matches a string exactly or a regular expression. Jobs are monitored by a process that runs the crontab, which `run()` does by default.

Check-ins are sent without a schedule, so create the monitors in Sentry first.
Items with a custom `match` function check in without a schedule, so create those monitors in Sentry first.
Loading