feat: add metrics api endpoint

example.ts

@@ -1,6 +1,6 @@
 import * as Bull from 'bull';
 import Queue3 from 'bull';
-import { Queue as QueueMQ, Worker } from 'bullmq';
+import { MetricsTime, Queue as QueueMQ, Worker } from 'bullmq';
 import express from 'express';
 import { BullMQAdapter } from '@bull-board/api/src/queueAdapters/bullMQ';
 import { BullAdapter } from '@bull-board/api/src/queueAdapters/bull';
@@ -15,7 +15,7 @@ const redisOptions = {
 
 const sleep = (t: number) => new Promise((resolve) => setTimeout(resolve, t * 1000));
 
-const createQueue3 = (name: string) => new Queue3(name, { redis: redisOptions });
+const createQueue3 = (name: string) => new Queue3(name, { redis: redisOptions, metrics: { maxDataPoints: MetricsTime.ONE_WEEK } });
 const createQueueMQ = (name: string) => new QueueMQ(name, { connection: redisOptions });
 
 function setupBullProcessor(bullQueue: Bull.Queue) {
@@ -45,7 +45,12 @@ async function setupBullMQProcessor(queueName: string) {
 
       return { jobId: `This is the return value of job (${job.id})` };
     },
-    { connection: redisOptions }
+    {
+      connection: redisOptions,
+      metrics: {
+        maxDataPoints: MetricsTime.ONE_WEEK,
+      },
+    }
   );
 }
 

packages/api/package.json

@@ -33,7 +33,7 @@
   "devDependencies": {
     "@types/redis-info": "^3.0.0",
     "@types/supertest": "^2.0.12",
-    "bull": "^4.10.4",
+    "bull": "^4.11.3",
     "bullmq": "^4.6.0",
     "ioredis": "^5.3.2",
     "supertest": "^6.3.3"

packages/api/src/handlers/metrics.ts

@@ -0,0 +1,30 @@
+import { BaseAdapter } from '../queueAdapters/base';
+import {
+  BullBoardRequest,
+  ControllerHandlerReturnType,
+} from '../../typings/app';
+import { queueProvider } from '../providers/queue';
+
+async function getMetrics(
+  req: BullBoardRequest,
+  queue: BaseAdapter
+): Promise<ControllerHandlerReturnType> {
+  const type = req.query?.type || 'completed';
+  const metrics = await queue.getMetrics(type);
+
+  if (metrics) {
+    return {
+      status: 200,
+      body: metrics,
+    };
+  } else {
+    return {
+      status: 404,
+      body: { error: 'Metrics not available' },
+    };
+  }
+}
+
+export const metricsHandler = queueProvider(getMetrics, {
+  skipReadOnlyModeCheck: true,
+});

packages/api/src/queueAdapters/base.ts

@@ -2,9 +2,11 @@ import {
   FormatterField,
   JobCleanStatus,
   JobCounts,
+  JobRetryStatus,
   JobStatus,
   QueueAdapterOptions,
   QueueJob,
+  QueueMetrics,
 } from '../../typings/app';
 
 export abstract class BaseAdapter {
@@ -56,6 +58,8 @@ export abstract class BaseAdapter {
 
   public abstract getJobLogs(id: string): Promise<string[]>;
 
+  public abstract getMetrics(type: JobRetryStatus, start?: number, end?: number): Promise<QueueMetrics | undefined | null>;
+
   public abstract getName(): string;
 
   public abstract getRedisInfo(): Promise<string>;

packages/api/src/queueAdapters/bull.ts

@@ -1,5 +1,5 @@
 import { Job, Queue } from 'bull';
-import { JobCleanStatus, JobCounts, JobStatus, QueueAdapterOptions } from '../../typings/app';
+import { JobCleanStatus, JobCounts, JobRetryStatus, JobStatus, QueueAdapterOptions } from '../../typings/app';
 import { STATUSES } from '../constants/statuses';
 import { BaseAdapter } from './base';
 
@@ -49,6 +49,10 @@ export class BullAdapter extends BaseAdapter {
   public getJobLogs(id: string): Promise<string[]> {
     return this.queue.getJobLogs(id).then(({ logs }) => logs);
   }
+
+  public getMetrics(type: JobRetryStatus, start?: number, end?: number) {
+    return this.queue.getMetrics(type, start, end);
+  }
 
   public isPaused(): Promise<boolean> {
     return this.queue.isPaused();

packages/api/src/queueAdapters/bullMQ.ts

@@ -1,5 +1,5 @@
 import { Job, Queue } from 'bullmq';
-import { JobCleanStatus, JobCounts, JobStatus, QueueAdapterOptions } from '../../typings/app';
+import { JobCleanStatus, JobCounts, JobRetryStatus, JobStatus, QueueAdapterOptions } from '../../typings/app';
 import { STATUSES } from '../constants/statuses';
 import { BaseAdapter } from './base';
 
@@ -37,6 +37,10 @@ export class BullMQAdapter extends BaseAdapter {
     return this.queue.getJobLogs(id).then(({ logs }) => logs);
   }
 
+  public getMetrics(type: JobRetryStatus, start?: number, end?: number) {
+    return this.queue.getMetrics(type, start, end);
+  }
+
   public isPaused(): Promise<boolean> {
     return this.queue.isPaused();
   }

packages/api/src/routes.ts

@@ -13,6 +13,7 @@ import { resumeQueueHandler } from './handlers/resumeQueue';
 import { retryAllHandler } from './handlers/retryAll';
 import { retryJobHandler } from './handlers/retryJob';
 import { promoteAllHandler } from './handlers/promoteAll';
+import { metricsHandler } from './handlers/metrics';
 
 export const appRoutes: AppRouteDefs = {
   entryPoint: {
@@ -78,5 +79,10 @@ export const appRoutes: AppRouteDefs = {
       route: '/api/queues/:queueName/:jobId/promote',
       handler: promoteJobHandler,
     },
+    {
+      method: 'get',
+      route: '/api/metrics/:queueName',
+      handler: metricsHandler,
+    },
   ],
 };

packages/api/typings/app.ts

@@ -37,6 +37,16 @@ export interface QueueJob {
   getState(): Promise<Status | 'stuck' | 'waiting-children' | 'prioritized' | 'unknown'>;
 }
 
+export interface QueueMetrics {
+  meta: {
+    count: number;
+    prevTS: number;
+    prevCount: number;
+  };
+  data: number[];
+  count: number;
+}
+
 export interface QueueJobJson {
   // add properties as needed from real Bull/BullMQ jobs
   id?: string | undefined | number | null;

yarn.lock

@@ -5180,6 +5180,19 @@ bull@^4.10.4:
     semver "^7.5.2"
     uuid "^8.3.0"
 
+bull@^4.11.3:
+  version "4.11.3"
+  resolved "https://registry.yarnpkg.com/bull/-/bull-4.11.3.tgz#466214c8d2aa6ac4fc3133c3616d31a37af4c099"
+  integrity sha512-DhS0XtiAuejkAY08iGOdDK35eex/yGNoezlWqGJTu9FqWFF/oBjUhpsusE9SXiI4culyDbOoFs+l3ar0VXhFqQ==
+  dependencies:
+    cron-parser "^4.2.1"
+    get-port "^5.1.1"
+    ioredis "^5.3.2"
+    lodash "^4.17.21"
+    msgpackr "^1.5.2"
+    semver "^7.5.2"
+    uuid "^8.3.0"
+
 bullmq@^4.6.0:
   version "4.7.0"
   resolved "https://registry.yarnpkg.com/bullmq/-/bullmq-4.7.0.tgz#dd2d26219142cf76ab578386a0db75c4757f2380"