Merge pull request #304 from matrix-org/hs/async-metrics

Collectors can now be async

changelog.d/304.misc

@@ -0,0 +1 @@
+Fetch metrics asynchronously

src/bridge.ts

@@ -1429,9 +1429,9 @@ export class Bridge {
      *     }
      * })
      */
-    public registerBridgeGauges(counterFunc: () => BridgeGaugesCounts) {
-        this.getPrometheusMetrics().registerBridgeGauges(() => {
-            const counts = counterFunc();
+    public registerBridgeGauges(counterFunc: () => Promise<BridgeGaugesCounts>|BridgeGaugesCounts) {
+        this.getPrometheusMetrics().registerBridgeGauges(async () => {
+            const counts = await counterFunc();
             if (counts.matrixGhosts !== undefined) {
                 counts.matrixGhosts = Object.keys(this.intents.size).length;
             }

src/components/prometheusmetrics.ts

@@ -18,7 +18,8 @@ import { AgeCounters } from "./agecounters";
 import JsSdk from "matrix-js-sdk";
 import { Request, Response } from "express";
 import { Bridge } from "..";
-type CollectorFunction = () => void;
+import Logger from "./logging";
+type CollectorFunction = () => Promise<void>|void;
 
 export interface BridgeGaugesCounts {
     matrixRoomConfigs?: number;
@@ -100,6 +101,9 @@ interface GagueOpts {
  *
  * @constructor
  */
+
+const log = Logger.get('PrometheusMetrics');
+
 export class PrometheusMetrics {
     public static AgeCounters = AgeCounters;
     private timers: {[name: string]: PromClient.Histogram<string>} = {};
@@ -173,13 +177,25 @@ export class PrometheusMetrics {
         });
     }
 
+    /**
+     * Fetch metrics from all configured collectors
+     */
+    public async refresh () {
+        try {
+            await Promise.all(this.collectors.map((f) => f()));
+        }
+        catch (ex) {
+            log.warn(`Failed to refresh metrics:`, ex);
+        }
+    }
+
     /**
      * Registers some exported metrics that expose counts of various kinds of
      * objects within the bridge.
      * @param {BridgeGaugesCallback} counterFunc A function that when invoked
      * returns the current counts of various items in the bridge.
      */
-    public registerBridgeGauges (counterFunc: () => BridgeGaugesCounts) {
+    public async registerBridgeGauges (counterFunc: () => Promise<BridgeGaugesCounts>|BridgeGaugesCounts) {
         const matrixRoomsGauge = this.addGauge({
             name: "matrix_configured_rooms",
             help: "Current count of configured rooms by matrix room ID",
@@ -220,8 +236,8 @@ export class PrometheusMetrics {
             labels: ["age"],
         });
 
-        this.addCollector(function () {
-            const counts = counterFunc();
+        this.addCollector(async () => {
+            const counts = await counterFunc();
 
             if (counts.matrixRoomConfigs) {matrixRoomsGauge.set(counts.matrixRoomConfigs);}
 
@@ -239,10 +255,6 @@ export class PrometheusMetrics {
         });
     }
 
-    public refresh () {
-        this.collectors.forEach((f) => f());
-    }
-
     /**
      * Adds a new collector function. These collector functions are run whenever
      * the /metrics page is about to be generated, allowing code to update values
@@ -381,17 +393,15 @@ export class PrometheusMetrics {
             // For now, leave this unauthenticated.
             checkToken: false,
             handler: async (_req: Request, res: Response) => {
-                this.refresh();
-
                 try {
+                    await this.refresh();
                     const exposition = await this.register.metrics();
 
                     res.set("Content-Type", "text/plain");
                     res.send(exposition);
                 }
                 catch (e) {
                     res.status(500);
-
                     res.set("Content-Type", "text/plain");
                     res.send(e.toString());
                 }