getsentry / getsentry/sentry-javascript

Add crons integration extending OpenTelementry and remove Sentry cron wrapper

Aperta
#11,790 0 commenti 1 reazione 0 assegnatari Vedi su GitHub
Checks Crons Improvement Node.js
Lingua principale
TypeScript
Stelle
8.7k
Fork
1.8k
Merge medio
1g 17h
PR unite (30g)
515

Descrizione

### 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
```

Guida per i contributori

Apri la guida per i contributori

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.