Merge remote-tracking branch 'upstream/main' into develop

Author: prlanzarin

CHANGELOG.md

@@ -2,6 +2,12 @@
 
 All notable changes to this project will be documented in this file.
 
+### v3.3.0
+
+* feat(metrics): add gauges for meeting and user Redis mappings
+* fix(metrics): properly handle Prometheus collection failures
+* fix(metrics): handle promises in setCollectorWithGenerator
+
 ### v3.2.2
 
 * fix: handle missing checksum in API requests

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "bbb-webhooks",
-  "version": "3.2.2",
+  "version": "3.3.0",
   "description": "A BigBlueButton mudule for events WebHooks",
   "type": "module",
   "mconf_version": "2.2.2",

package.json

@@ -25,6 +25,8 @@ const METRIC_NAMES = {
   MODULE_STATUS: `${PREFIX}module_status`,
   EVENT_PROCESS_FAILURES: `${PREFIX}event_process_failures`,
   EVENT_DISPATCH_FAILURES: `${PREFIX}event_dispatch_failures`,
+  MEETING_MAPPINGS: `${PREFIX}meeting_mappings`,
+  USER_MAPPINGS: `${PREFIX}user_mappings`,
 }
 
 let METRICS = {}
@@ -79,6 +81,16 @@ const buildDefaultMetrics = () => {
         help: 'Number of event dispatch failures',
         labelNames: ['outputEventId', 'module'],
       }),
+
+      [METRIC_NAMES.MEETING_MAPPINGS]: new Gauge({
+        name: METRIC_NAMES.MEETING_MAPPINGS,
+        help: 'Number of meeting mappings saved in the database',
+      }),
+
+      [METRIC_NAMES.USER_MAPPINGS]: new Gauge({
+        name: METRIC_NAMES.USER_MAPPINGS,
+        help: 'Number of user mappings saved in the database',
+      }),
     }
   }
 

src/metrics/index.js

@@ -49,14 +49,13 @@ class PrometheusScrapeAgent {
   async _collect (response) {
     try {
       const _response = await this.collect(response);
-      _response.writeHead(200, { 'Content-Type': promclient.register.contentType });
       const content = await promclient.register.metrics();
+      _response.writeHead(200, { 'Content-Type': promclient.register.contentType });
       _response.end(content);
     } catch (error) {
+      this.logger.error('Prometheus: error collecting metrics', error);
       response.writeHead(500)
-      response.end(error.message);
-      this.logger.error('Prometheus: error collecting metrics',
-        { errorCode: error.code, errorMessage: error.message });
+      response.end("Error collecting metrics");
     }
   }
 
@@ -172,8 +171,9 @@ class PrometheusScrapeAgent {
       /**
        * metric.collect.
        */
-      metric.collect = () => {
-        metric.set(generator());
+      metric.collect = async () => {
+        const value = await generator();
+        metric.set(value);
       };
     }
   }

src/metrics/prometheus-agent.js

@@ -21,6 +21,42 @@ export default class EventProcessor {
     this.outputs = outputs;
 
     this._exporter = Metrics.agent;
+    this._setMetricsCollectors();
+  }
+
+  /**
+   * _setMetricsCollectors - Sets the metrics collectors for the event processor.
+   * @private
+   */
+  _setMetricsCollectors() {
+    const collectIDMappings = async () => {
+      try {
+        const mappings = await IDMapping.get().getAll();
+        return mappings?.length || 0;
+      } catch (error) {
+        Logger.error('error getting ID mappings', error);
+        return 0;
+      }
+    }
+
+    const collectUserMappings = async () => {
+      try {
+        const mappings = await UserMapping.get().getAll();
+        return mappings?.length || 0;
+      } catch (error) {
+        Logger.error('error getting user mappings', error);
+        return 0;
+      }
+    }
+
+    this._exporter.setCollectorWithGenerator(
+      Metrics.METRIC_NAMES.MEETING_MAPPINGS,
+      collectIDMappings,
+    );
+    this._exporter.setCollectorWithGenerator(
+      Metrics.METRIC_NAMES.USER_MAPPINGS,
+      collectUserMappings,
+    );
   }
 
   _trackModuleEvents() {