getsentry / getsentry/sentry-javascript

Add crons integration extending OpenTelementry and remove Sentry cron wrapper

Open
#11,790 0 comments 1 reaction 0 assignees View on GitHub
Checks Crons Improvement Node.js
Dominant language
TypeScript
Stars
8.7k
Forks
1.8k
Avg merge
1d 17h
Merged PRs (30d)
515

Description

### Problem Statement

The current setup for monitoring crons requires a wrapper function ([link to docs](https://docs.sentry.io/platforms/javascript/guides/node/crons/)). You use it like this:

```js
const CronJobWithCheckIn = Sentry.cron.instrumentCron(CronJob, 'cron_slug');

const job = CronJobWithCheckIn.from({
cronTime: '7 * * * * *',
onTick: () => {
console.log('cron: Job is running every few seconds');
},
});

job.start();
```

### Solution Brainstorm

We could add a new integration which is extending OpenTelementry and publish it as separate packages and remove the wrapper, which is currently needed. These OTEL instrumentations can also automatically create spans, something that is not supported atm.

If we make these integrations, we need them to be opt-in because crons charge per monitor. We have two options:

1. Have users explicitly add integrations, with ability to specify monitors they are only interested in
2. Have all cron integrations enabled by default, but expose a public API options surface to manage what monitors are created.

```[tasklist]
### Phase 1: Initial Implementation
- [ ] Add `@sentry/opentelemetry-instrumentation-cron`
- [ ] Add `@sentry/opentelemetry-instrumentation-node-cron`
- [ ] Add `@sentry/opentelemetry-instrumentation-node-schedule`
- [ ] Add integration for `cron`
- [ ] Add integration for `node-cron`
- [ ] Add integration for `node-schedule`
```

```[tasklist]
### Phase 1: Migration
- [ ] Update docs
- [ ] Deprecate `Sentry.cron` methods
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.