@remit/queue-sidecar 0.0.10 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/queue-sidecar",
-  "version": "0.0.10",
+  "version": "0.0.11",
   "type": "module",
   "main": "src/index.ts",
   "types": "src/index.ts",

package/src/metrics.test.ts

@@ -141,6 +141,23 @@ describe("the sidecar /metrics endpoint", () => {
 		assert.equal(post.status, 400);
 	});
 
+	it("exports how long each queue has gone without handing out a message", async () => {
+		store.purgeQueue("work");
+		store.sendMessage({ queueName: "work", body: "waiting" });
+		const idle = await get("/metrics");
+		assert.match(
+			idle.body,
+			/^remit_queue_last_receive_age_seconds\{queue="work",role="work"\} \d+$/m,
+		);
+
+		const quiet = store.lastReceiveAgeSeconds("work", Date.now() + 901_000);
+		assert.ok(quiet >= 900);
+
+		store.receiveMessages({ queueName: "work", maxMessages: 1 });
+		assert.equal(store.lastReceiveAgeSeconds("work"), 0);
+		store.purgeQueue("work");
+	});
+
 	it("counts only visible messages as depth", () => {
 		store.sendMessage({ queueName: "work", body: "c" });
 		store.receiveMessages({ queueName: "work", maxMessages: 1 });
@@ -165,6 +182,7 @@ describe("a store that cannot answer for any queue", () => {
 					getQueueAttributes: () => {
 						throw new Error("never reached");
 					},
+					lastReceiveAgeSeconds: () => 0,
 				}),
 			/holds no queues/,
 		);

package/src/metrics.ts

@@ -17,9 +17,16 @@ const queueMessages = new Gauge({
 	registers: [registry],
 });
 
+const queueLastReceiveAge = new Gauge({
+	name: "remit_queue_last_receive_age_seconds",
+	help: "Seconds since a queue last handed a message to a consumer, or since the sidecar started if it has not.",
+	labelNames: ["queue", "role"],
+	registers: [registry],
+});
+
 export type QueueDepthSource = Pick<
 	QueueStore,
-	"listQueues" | "getQueueAttributes"
+	"listQueues" | "getQueueAttributes" | "lastReceiveAgeSeconds"
 >;
 
 export const queueRoles = (
@@ -59,11 +66,13 @@ export const collectQueueDepths = (store: QueueDepthSource): void => {
 	}
 	const roles = queueRoles(queues);
 	queueMessages.reset();
+	queueLastReceiveAge.reset();
 	for (const queue of queues) {
 		const attributes = store.getQueueAttributes(queue.name);
-		queueMessages.set(
-			{ queue: queue.name, role: roles.get(queue.name) ?? "work" },
-			attributes.approximateNumberOfMessages,
-		);
+		const labels = { queue: queue.name, role: roles.get(queue.name) ?? "work" };
+		queueMessages.set(labels, attributes.approximateNumberOfMessages);
+		if (labels.role === "work") {
+			queueLastReceiveAge.set(labels, store.lastReceiveAgeSeconds(queue.name));
+		}
 	}
 };

package/src/store.ts

@@ -97,6 +97,8 @@ const toQueueRecord = (row: QueueRow): QueueRecord => ({
 export class QueueStore {
 	private readonly db: Database.Database;
 	private sequenceCounter: bigint;
+	private readonly startedAt = Date.now();
+	private readonly lastReceiveAt = new Map<string, number>();
 
 	constructor(filename: string) {
 		this.db = new Database(filename);
@@ -357,7 +359,15 @@ export class QueueStore {
 			return picked;
 		});
 
-		return receive();
+		const received = receive();
+		if (received.length > 0) this.lastReceiveAt.set(input.queueName, now);
+		return received;
+	}
+
+	lastReceiveAgeSeconds(queueName: string, now = Date.now()): number {
+		this.requireQueue(queueName);
+		const since = this.lastReceiveAt.get(queueName) ?? this.startedAt;
+		return Math.max(0, Math.floor((now - since) / 1000));
 	}
 
 	deleteMessage(queueName: string, receiptHandle: string): void {