feat: add queue size to running stats

hokify · Oct 12, 2020 · 6271781 · 6271781
1 parent ef85fc5
commit 6271781
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/src/JobDbRepository.ts b/src/JobDbRepository.ts
@@ -57,6 +57,13 @@ export class JobDbRepository {
 		return this.collection.deleteMany(query);
 	}
 
+	async getQueueSize(): Promise<number> {
+		return this.collection.countDocuments({ nextRunAt: { $lt: new Date() } });
+	}
+
+	/**
+	 * Internal method to unlock jobs so that they can be re-run
+	 */
 	async unlockJobs(jobIds: ObjectId[]) {
 		await this.collection.updateMany({ _id: { $in: jobIds } }, { $set: { lockedAt: null } });
 	}

diff --git a/src/JobProcessor.ts b/src/JobProcessor.ts
@@ -23,6 +23,7 @@ export class JobProcessor {
 
 	async getStatus() {
 		return {
+			queueSize: await this.agenda.db.getQueueSize(),
 			jobStatus: this.jobStatus,
 			runningJobs: this.runningJobs.length,
 			lockedJobs: this.lockedJobs.length,

diff --git a/src/index.ts b/src/index.ts
@@ -50,7 +50,10 @@ export class Agenda extends EventEmitter {
 	private ready: Promise<unknown>;
 
 	getRunningStats() {
-		return this.jobProcessor?.getStatus();
+		if (!this.jobProcessor) {
+			throw new Error('agenda not running!');
+		}
+		return this.jobProcessor.getStatus();
 	}
 
 	constructor(