@meltwater/conversations-api-services 1.0.0

package/src/lib/metrics.helper.js

@@ -0,0 +1,107 @@
+import Prometheus from 'prom-client';
+import logger from './logger.js';
+
+const podMetricsByName = new Map();
+
+const metricNames = ['irGetByDocumentId', 'irRatelimited', 'irSearch'];
+
+// todo: make this a dynamic process
+const irGetByDocumentIdHistogram = new Prometheus.Histogram({
+    name: 'irGetByDocumentId_Avg_Reponse_Time',
+    help: 'metric_help',
+    buckets: Prometheus.linearBuckets(0, 200, 40),
+});
+
+const irGetByDocumentIdCountHistogram = new Prometheus.Histogram({
+    name: 'irGetByDocumentId_Count',
+    help: 'metric_help',
+    buckets: Prometheus.linearBuckets(0, 1, 40),
+});
+
+metricNames.forEach((metricName) => {
+    podMetricsByName.set(
+        metricName,
+        new Prometheus.Counter({
+            name: metricName,
+            help: `${metricName}_help`,
+        })
+    );
+});
+
+class Metrics {
+    constructor() {
+        this.requestMetricsByName = new Map();
+        metricNames.forEach((metricName) => {
+            this.requestMetricsByName.set(metricName, []);
+        });
+        this.getMetrics = (metricName) => {
+            return {
+                podMetrics: podMetricsByName.get(metricName),
+                requestMetrics: this.requestMetricsByName.get(metricName),
+            };
+        };
+    }
+
+    count(metricName) {
+        const { podMetrics, requestMetrics } = this.getMetrics(metricName);
+
+        if (podMetrics) {
+            podMetrics.inc();
+        } else {
+            logger.error(`No pod level metric exists for ${metricName}`);
+        }
+
+        const metricObject = {
+            type: 'count',
+            timestamp: Date.now(),
+        };
+        if (requestMetrics) {
+            requestMetrics.push(metricObject);
+        }
+        return metricObject;
+    }
+
+    finishOperation(metricName, metricObject) {
+        const { requestMetrics } = this.getMetrics(metricName);
+
+        if (requestMetrics) {
+            const matchingMetric = requestMetrics.find(
+                (requestMetricExiting) =>
+                    requestMetricExiting.timestamp === metricObject.timestamp
+            );
+            matchingMetric.duration = Date.now() - matchingMetric.timestamp;
+        }
+    }
+
+    async somethingCompleted(name = 'IR.getByDocumentId', start = true) {
+        // duration math
+    }
+
+    async finishRequest() {
+        const { requestMetrics } = this.getMetrics('irGetByDocumentId');
+        let arrHasDuration = requestMetrics.filter((metric) => metric.duration);
+        if (arrHasDuration.length) {
+            let avgDuration =
+                arrHasDuration.reduce(
+                    (avg, metric) => avg + metric.duration,
+                    0
+                ) / arrHasDuration.length;
+            irGetByDocumentIdHistogram.observe(avgDuration);
+        }
+        if (requestMetrics.length > 0) {
+            irGetByDocumentIdCountHistogram.observe(requestMetrics.length);
+        }
+    }
+}
+
+function createEnum(values) {
+    const enumObject = {};
+    for (const val of values) {
+        enumObject[val] = val;
+    }
+    return Object.freeze(enumObject);
+}
+
+const metricN = createEnum(metricNames);
+
+export { Metrics, metricN };