@appweaver/cron 2.4.1 → 2.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/cron-scheduler.js +44 -5
  2. package/package.json +3 -3
package/cron-scheduler.js CHANGED
@@ -5,6 +5,11 @@ const cron_1 = require("cron");
5
5
  const common_1 = require("@appweaver/common");
6
6
  const core_1 = require("@appweaver/core");
7
7
  const logger = (0, common_1.createLogger)('scheduler');
8
+ const jobDuration = (0, common_1.telemetryHistogram)('appweaver.scheduler.job.duration', {
9
+ description: 'Duration of the runs of the scheduled jobs.',
10
+ unit: 's',
11
+ advice: { explicitBucketBoundaries: common_1.DURATION_BUCKETS }
12
+ });
8
13
  class CronScheduler extends common_1.Scheduler {
9
14
  /** @internal */
10
15
  _jobs = {};
@@ -32,26 +37,27 @@ class CronScheduler extends common_1.Scheduler {
32
37
  await Promise.allSettled(stopActions);
33
38
  }
34
39
  addJob(jobParams) {
35
- const { cronTime, onTick, timeZone, providerOptions } = jobParams;
40
+ const { cronTime, onTick, timeZone, name, providerOptions } = jobParams;
36
41
  const jobId = (0, common_1.uuid)();
37
42
  this._jobs[jobId] = cron_1.CronJob.from({
38
43
  start: core_1.schedulerConfig.AUTO_START_JOB,
39
44
  waitForCompletion: true,
40
45
  errorHandler: (e) => {
41
- logger.error({ err: e, jobId }, 'Job handler error');
46
+ logger.error({ err: e, jobId, name }, 'Job handler error');
42
47
  },
43
48
  ...providerOptions,
44
49
  cronTime,
45
50
  onTick: async () => {
46
51
  const start = performance.now();
47
- logger.debug({ jobId }, 'Job run started');
48
- await onTick();
49
- logger.debug({ jobId, durationMs: Math.round(performance.now() - start) }, 'Job run finished');
52
+ logger.debug({ jobId, name }, 'Job run started');
53
+ await runTraced(jobId, jobParams);
54
+ logger.debug({ jobId, name, durationMs: Math.round(performance.now() - start) }, 'Job run finished');
50
55
  },
51
56
  timeZone
52
57
  });
53
58
  logger.debug({
54
59
  jobId,
60
+ name,
55
61
  cronTime,
56
62
  timeZone,
57
63
  nextRun: this._jobs[jobId].nextDate().toISO()
@@ -91,3 +97,36 @@ class CronScheduler extends common_1.Scheduler {
91
97
  }
92
98
  }
93
99
  exports.CronScheduler = CronScheduler;
100
+ /** Runs a tick of a job in the root span of a new trace, measuring its duration. */
101
+ async function runTraced(jobId, job) {
102
+ if (!(0, common_1.telemetryEnabled)('scheduler')) {
103
+ await job.onTick();
104
+ return;
105
+ }
106
+ const name = job.name ?? jobId;
107
+ const start = performance.now();
108
+ let failure;
109
+ try {
110
+ await (0, common_1.withSpan)(`scheduler ${job.name ?? 'job'}`, {
111
+ root: true,
112
+ attributes: {
113
+ 'appweaver.scheduler.job.id': jobId,
114
+ 'appweaver.scheduler.job.name': name,
115
+ ...(typeof job.cronTime === 'string'
116
+ ? { 'appweaver.scheduler.job.cron': job.cronTime }
117
+ : {})
118
+ }
119
+ }, async () => job.onTick());
120
+ }
121
+ catch (error) {
122
+ failure = (0, common_1.spanErrorType)(error);
123
+ throw error;
124
+ }
125
+ finally {
126
+ // A job without a name is measured as one series, its id being random
127
+ (0, common_1.recordDuration)(jobDuration(), start, {
128
+ ...(job.name ? { 'appweaver.scheduler.job.name': job.name } : {}),
129
+ ...(failure ? { 'error.type': failure } : {})
130
+ });
131
+ }
132
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@appweaver/cron",
3
- "version": "2.4.1",
3
+ "version": "2.6.0",
4
4
  "description": "Appweaver - the backend framework for AI-first development (@cron)",
5
5
  "author": "Luka Matosevic",
6
6
  "license": "MIT",
@@ -42,8 +42,8 @@
42
42
  "cron": "4.4.0"
43
43
  },
44
44
  "peerDependencies": {
45
- "@appweaver/common": "^2.4.1",
46
- "@appweaver/core": "^2.4.1"
45
+ "@appweaver/common": "^2.6.0",
46
+ "@appweaver/core": "^2.6.0"
47
47
  },
48
48
  "devDependencies": {
49
49
  "@appweaver/common": "^1.12.2",