Fix Prometheus Metric Names for Bull Queue Durations

creator-node/src/services/prometheusMonitoring/prometheusRegistry.ts

@@ -84,14 +84,15 @@ export class PrometheusRegistry {
 
     // job duration in seconds
     const jobDuration = (job.finishedOn - job.processedOn!) * 1000
-    this.getMetric(
-      this.metricNames.JOBS_DURATION_MILLISECONDS_HISTOGRAM
-    ).observe(jobLabels, jobDuration)
+    this.getMetric(this.metricNames.JOBS_DURATION_SECONDS_HISTOGRAM).observe(
+      jobLabels,
+      jobDuration
+    )
 
     // job duration in seconds
     const waitingDuration = (job.processedOn! - job.timestamp) * 1000
     this.getMetric(
-      this.metricNames.JOBS_WAITING_DURATION_MILLISECONDS_HISTOGRAM
+      this.metricNames.JOBS_WAITING_DURATION_SECONDS_HISTOGRAM
     ).observe(jobLabels, waitingDuration)
 
     this.getMetric(this.metricNames.JOBS_ATTEMPTS_HISTOGRAM).observe(

creator-node/test/lib/genericBullQueueMock.js

@@ -0,0 +1,40 @@
+const PrometheusRegistry = require('../../src/services/prometheusMonitoring/prometheusRegistry')
+const Bull = require('bull')
+
+const config = require('../../src/config')
+
+// Mock monitoring queue that sets monitor values on construction
+class GenericBullQueue {
+  constructor() {
+    this.queue = Bull('genericBullQueue', {
+      redis: {
+        host: config.get('redisHost'),
+        port: config.get('redisPort')
+      },
+      defaultJobOptions: {
+        removeOnComplete: 0,
+        removeOnFail: 0
+      }
+    })
+    const prometheusRegistry = new PrometheusRegistry()
+    prometheusRegistry.startQueueMetrics(this.queue)
+
+    this.queue.process(1, async (job) => {
+      console.log(this.params)
+
+      const { timeout } = job.data
+      if (timeout) {
+        console.log(`waiting ${timeout}`)
+        setTimeout(() => console.log(`done ${timeout}`), timeout)
+      }
+    })
+  }
+
+  async addTask(params) {
+    const job = await this.queue.add(params)
+
+    return job
+  }
+}
+
+module.exports = GenericBullQueue

creator-node/test/prometheus.test.js

@@ -6,6 +6,7 @@ const { getLibsMock } = require('./lib/libsMock')
 const {
   NAMESPACE_PREFIX
 } = require('../src/services/prometheusMonitoring/prometheus.constants')
+const GenericBullQueue = require('./lib/genericBullQueueMock')
 
 describe('test Prometheus metrics', async function () {
   let app, server, libsMock
@@ -117,4 +118,17 @@ describe('test Prometheus metrics', async function () {
     assert.ok(resp.text.includes(NAMESPACE_PREFIX + '_jobs_active'))
     assert.ok(resp.text.includes(NAMESPACE_PREFIX + '_jobs_delayed'))
   })
+
+  it('Checks the duration of a bull queue job', async function () {
+    const genericBullQueue = new GenericBullQueue()
+    const job = await genericBullQueue.addTask({ timeout: 500 })
+
+    await job.finished()
+
+    const resp = await request(app).get('/prometheus_metrics').expect(200)
+    assert.ok(
+      resp.text.includes(NAMESPACE_PREFIX + '_jobs_duration_seconds_bucket')
+    )
+    assert.ok(resp.text.includes(`queue_name="genericBullQueue"`))
+  })
 })