#3666 - Queue Monitoring - Enable Prometheus Metrics

devops/openshift/queue-consumers-deploy.yml

@@ -19,6 +19,10 @@ objects:
         type: Rolling
       template:
         metadata:
+          annotations:
+            prometheus.io/scrape: "true"
+            prometheus.io/port: ${PORT}
+            prometheus.io/path: /metrics
           labels:
             deploymentconfig: ${NAME}
         spec:

devops/openshift/sysdig-team.yml

@@ -7,37 +7,21 @@ spec:
   team:
     description: The Sysdig Team for the OpenShift Project Set SIMS
     users:
-    - name: [email protected]
-      role: ROLE_TEAM_EDIT
-    - name: [email protected]
-      role: ROLE_TEAM_EDIT
-    - name: [email protected]
-      role: ROLE_TEAM_EDIT
-    - name: [email protected]
-      role: ROLE_TEAM_EDIT
-    - name: [email protected]
-      role: ROLE_TEAM_EDIT
-    - name: [email protected]
-      role: ROLE_TEAM_EDIT
-    - name: [email protected]
-      role: ROLE_TEAM_STANDARD
-    - name: [email protected]
-      role: ROLE_TEAM_STANDARD
-    - name: [email protected]
-      role: ROLE_TEAM_STANDARD
-    - name: [email protected]
-      role: ROLE_TEAM_STANDARD
-    - name: [email protected]
-      role: ROLE_TEAM_STANDARD
-    - name: [email protected]
-      role: ROLE_TEAM_READ
-    - name: [email protected]
-      role: ROLE_TEAM_READ
-    - name: [email protected]
-      role: ROLE_TEAM_READ
-    - name: [email protected]
-      role: ROLE_TEAM_READ
-    - name: [email protected]
-      role: ROLE_TEAM_READ
-    - name: [email protected]
-      role: ROLE_TEAM_READ
+      - name: [email protected]
+        role: ROLE_TEAM_EDIT
+      - name: [email protected]
+        role: ROLE_TEAM_EDIT
+      - name: [email protected]
+        role: ROLE_TEAM_EDIT
+      - name: [email protected]
+        role: ROLE_TEAM_EDIT
+      - name: [email protected]
+        role: ROLE_TEAM_EDIT
+      - name: [email protected]
+        role: ROLE_TEAM_EDIT
+      - name: [email protected]
+        role: ROLE_TEAM_EDIT
+      - name: [email protected]
+        role: ROLE_TEAM_STANDARD
+      - name: [email protected]
+        role: ROLE_TEAM_STANDARD

sources/packages/backend/apps/queue-consumers/src/controllers/index.ts

@@ -1 +1,2 @@
 export * from "./health-check/health.controller";
+export * from "./metrics/metrics.controller";

sources/packages/backend/apps/queue-consumers/src/controllers/metrics/metrics.controller.ts

@@ -0,0 +1,38 @@
+import {
+  Controller,
+  Get,
+  Header,
+  InternalServerErrorException,
+} from "@nestjs/common";
+import { MetricsService } from "../../services";
+import { register } from "prom-client";
+import { InjectLogger, LoggerService } from "@sims/utilities/logger";
+
+/**
+ * Allows prometheus to scrape metrics from the queue-consumers.
+ * @see https://developer.gov.bc.ca/docs/default/component/platform-developer-docs/docs/app-monitoring/user-defined-monitoring/#expose-the-metrics-from-your-app
+ */
+@Controller("metrics")
+export class MetricsController {
+  constructor(private readonly metricsService: MetricsService) {}
+
+  /**
+   * Exports metrics from the queue-consumers.
+   * @returns metrics in Prometheus format.
+   */
+  @Get()
+  @Header("content-type", register.contentType)
+  async getMetrics(): Promise<string> {
+    try {
+      return register.metrics();
+    } catch (error) {
+      this.logger.error("Error while getting metrics.", error);
+      throw new InternalServerErrorException(
+        "Error while getting metrics. See server logs for details.",
+      );
+    }
+  }
+
+  @InjectLogger()
+  logger: LoggerService;
+}

sources/packages/backend/apps/queue-consumers/src/queue-consumers.module.ts

@@ -72,13 +72,14 @@ import {
 import { SFASIntegrationModule } from "@sims/integrations/sfas-integration";
 import { ATBCIntegrationModule } from "@sims/integrations/atbc-integration";
 import { ECEIntegrationModule } from "@sims/integrations/institution-integration/ece-integration";
-import { HealthController } from "./controllers";
+import { HealthController, MetricsController } from "./controllers";
 import { MicroserviceHealthIndicator, TerminusModule } from "@nestjs/terminus";
 import { CASSupplierIntegrationService } from "./services/cas-supplier/cas-supplier.service";
 import { VirusScanProcessor } from "./processors/virus-scan/virus-scan.processor";
 import { CASService } from "@sims/integrations/cas/cas.service";
 import { ObjectStorageService } from "@sims/integrations/object-storage";
 import { BullBoardQueuesModule } from "./bull-board/bull-board-queues.module";
+import { QueuesMetricsModule } from "./queues-metrics.module.module";
 
 // TODO: Removed ATBCResponseIntegrationScheduler in providers, the queuename from enum and the decorators of the processor as part of #2539.
 @Module({
@@ -87,6 +88,7 @@ import { BullBoardQueuesModule } from "./bull-board/bull-board-queues.module";
     DatabaseModule,
     QueueModule,
     BullBoardQueuesModule,
+    QueuesMetricsModule,
     ZeebeModule.forRoot(),
     IER12IntegrationModule,
     ECEIntegrationModule,
@@ -161,6 +163,6 @@ import { BullBoardQueuesModule } from "./bull-board/bull-board-queues.module";
     CASActiveSupplierFoundProcessor,
     CASActiveSupplierAndSiteFoundProcessor,
   ],
-  controllers: [HealthController],
+  controllers: [HealthController, MetricsController],
 })
 export class QueueConsumersModule {}

sources/packages/backend/apps/queue-consumers/src/queues-metrics.module.module.ts

@@ -0,0 +1,25 @@
+import { Global, LoggerService, Module, OnModuleInit } from "@nestjs/common";
+import { InjectLogger } from "@sims/utilities/logger";
+import { MetricsService } from "./services";
+
+@Global()
+@Module({
+  providers: [MetricsService],
+  exports: [MetricsService],
+})
+export class QueuesMetricsModule implements OnModuleInit {
+  constructor(private readonly metricsService: MetricsService) {}
+
+  /**
+   * Method that is invoked on application initialization and
+   * is responsible for setting up the metrics for all queues.
+   */
+  async onModuleInit(): Promise<void> {
+    this.logger.log("Associating queue events for metrics.");
+    this.metricsService.setGlobalMetricsConfigurations();
+    await this.metricsService.associateQueueEventsCountersMetrics();
+  }
+
+  @InjectLogger()
+  logger: LoggerService;
+}

sources/packages/backend/apps/queue-consumers/src/services/index.ts

@@ -4,3 +4,4 @@ export * from "./workflow/workflow-enqueuer.service";
 export * from "./cas-supplier/cas-supplier.service";
 export * from "./student-file/student-file.service";
 export * from "./cas-supplier/cas-evaluation-result-processor";
+export * from "./metrics/metrics.service";

sources/packages/backend/apps/queue-consumers/src/services/metrics/metrics.models.ts

@@ -0,0 +1,78 @@
+import { QueueModel } from "@sims/services/queue";
+import { Queue } from "bull";
+
+/**
+ * Bull queues event names to have metrics associated.
+ * @see https://github.com/OptimalBits/bull/blob/develop/REFERENCE.md#events
+ */
+export enum QueuesMetricsEvents {
+  /**
+   * An error occurred, for instance, Redis connectivity issue.
+   */
+  Error = "error",
+  /**
+   * A Job is waiting to be processed as soon as a worker is idling.
+   */
+  Waiting = "waiting",
+  /**
+   * A job has started.
+   */
+  Active = "active",
+  /**
+   * A job has been marked as stalled. This is useful for debugging job
+   * workers that crash or pause the event loop.
+   */
+  Stalled = "stalled",
+  /**
+   * A job successfully completed with a result.
+   */
+  Completed = "completed",
+  /**
+   * A job's progress was updated.
+   */
+  Progress = "progress",
+  /**
+   * A job went to failed state.
+   */
+  Failed = "failed",
+  /**
+   * The job changed to delayed state.
+   */
+  Delayed = "delayed",
+  /**
+   * The queue has been paused.
+   */
+  Paused = "paused",
+  /**
+   * A job was successfully removed.
+   */
+  Removed = "removed",
+  /**
+   * The queue has been resumed.
+   */
+  Resumed = "resumed",
+  /**
+   * Emitted every time the queue has processed all the waiting jobs
+   * (even if there can be some delayed jobs not yet processed).
+   */
+  Drained = "drained",
+  /**
+   * A job failed to extend lock. This will be useful to debug redis
+   * connection issues and jobs getting restarted because workers
+   * are not able to extend locks.
+   */
+  LockExtensionFailed = "lock-extension-failed",
+}
+
+/**
+ * Information to provide metrics to a queue.
+ */
+export interface MonitoredQueue {
+  provider: Queue;
+  queueModel: QueueModel;
+}
+
+/**
+ * Default label added to all the metrics.
+ */
+export const DEFAULT_METRICS_APP_LABEL = "queue-consumers";