feat(lib-prom): pseudo metric support

Author: awlayton

oada/.yarnrc.yml

@@ -48,9 +48,6 @@ packageExtensions:
     peerDependencies:
       "@types/ws": "*"
       fastify: "*"
-  eslint-plugin-sonarjs@*:
-    dependencies:
-      "@typescript-eslint/utils": "*"
   fastify-graceful-shutdown@*:
     peerDependencies:
       fastify: "*"

oada/eslint.config.mjs

@@ -30,7 +30,6 @@ import typescript from 'typescript-eslint';
 
 import _import from 'eslint-plugin-import';
 import ava from 'eslint-plugin-ava';
-import github from 'eslint-plugin-github';
 import noConstructorBind from 'eslint-plugin-no-constructor-bind';
 import noSecrets from 'eslint-plugin-no-secrets';
 import node from 'eslint-plugin-n';
@@ -67,7 +66,7 @@ export default typescript.config(
   regexp.configs['flat/recommended'],
   ...fixupConfigRules(
     compat.extends(
-      'plugin:github/recommended',
+      // 'plugin:github/recommended',
       'plugin:promise/recommended',
       'plugin:optimize-regex/recommended',
       'plugin:import/recommended',
@@ -104,13 +103,13 @@ export default typescript.config(
   },
   {
     plugins: {
-      'github': fixupPluginRules(github),
+      // 'github': fixupPluginRules(github),
       'promise': fixupPluginRules(promise),
       'optimize-regex': fixupPluginRules(optimizeRegex),
       'no-constructor-bind': noConstructorBind,
       'import': fixupPluginRules(_import),
       'no-secrets': noSecrets,
-      // Sonarjs,
+      // sonarjs,
       'ava': fixupPluginRules(ava),
       notice,
     },
@@ -323,6 +322,7 @@ export default typescript.config(
       'no-dupe-class-members': 'off',
       'no-useless-constructor': 'off',
       'no-invalid-this': 'off',
+      'sonarjs/sonar-no-fallthrough': 'off',
       'filenames/match-regex': 'off',
       'i18n-text/no-en': 'off',
       'github/no-implicit-buggy-globals': 'off',

oada/libs/lib-arangodb/package.json

@@ -59,7 +59,7 @@
     "@oada/models": "workspace:^",
     "@oada/oadaify": "^2.1.0",
     "@oada/types": "^4.0.0",
-    "arangojs": "^9.0.0",
+    "arangojs": "^9.1.0",
     "bcryptjs": "^2.4.3",
     "debug": "^4.3.7",
     "deep-equal": "^2.2.3",
@@ -75,7 +75,7 @@
     "@types/deep-equal": "^1.0.4",
     "@types/flat": "^5.0.5",
     "@types/json-pointer": "^1.0.34",
-    "@types/node": "^22.5.5",
+    "@types/node": "^22.7.3",
     "ava": "6.1.3",
     "type-fest": "^4.26.1"
   },

oada/libs/lib-kafka/package.json

@@ -48,7 +48,7 @@
     "@ava/typescript": "^5.0.0",
     "@types/convict": "^6.1.6",
     "@types/debug": "^4.1.12",
-    "@types/node": "^22.5.5",
+    "@types/node": "^22.7.3",
     "@types/uuid": "^10.0.0",
     "ava": "6.1.3"
   },

oada/libs/lib-prom/package.json

@@ -42,10 +42,10 @@
   "devDependencies": {
     "@ava/typescript": "^5.0.0",
     "@types/convict": "^6.1.6",
-    "@types/node": "^22.5.5",
+    "@types/node": "^22.7.3",
     "@types/ws": "^8.5.12",
     "ava": "6.1.3",
-    "fastify-plugin": "^5.0.0"
+    "fastify-plugin": "^5.0.1"
   },
   "volta": {
     "node": "22.5.1"

oada/libs/lib-prom/src/index.ts

@@ -19,7 +19,12 @@ import { config } from './config.js';
 
 import { createServer } from 'node:http';
 
-import { collectDefaultMetrics, register } from 'prom-client';
+import {
+  Gauge,
+  type MetricConfiguration,
+  collectDefaultMetrics,
+  register,
+} from 'prom-client';
 import type NStats from 'nstats';
 
 collectDefaultMetrics({ register });
@@ -37,6 +42,7 @@ export const nstats: typeof NStats = (...parameters) => {
  *
  * *Starts automatically, don't try to start manually.*
  */
+// eslint-disable-next-line sonarjs/no-misused-promises
 export const server = createServer(async (_, response) => {
   try {
     const metrics = await register.metrics();
@@ -60,3 +66,47 @@ const { port, host } = config.get('prometheus');
 server.listen({ host, port });
 
 export * from 'prom-client';
+
+export interface PseudoMetricConfiguration<T extends string> {
+  name: `${string}_info`;
+  help: string;
+  labels?: Record<T, string>;
+  collect?: (this: PseudoMetric<T>) => void | Promise<void>;
+  registers: MetricConfiguration<T>['registers'];
+}
+
+/**
+ * A pseudo-metric that provides metadata about the process to prometheus
+ *
+ * The lables are the reported metadata
+ *
+ * @see {@link https://www.robustperception.io/exposing-the-software-version-to-prometheus/}
+ */
+export class PseudoMetric<T extends string = string> {
+  readonly #gauge;
+
+  constructor({
+    name,
+    help,
+    labels,
+    registers,
+    collect = () => {
+      this.set(labels!);
+    },
+  }: PseudoMetricConfiguration<T>) {
+    this.#gauge = new Gauge<T>({
+      name,
+      help,
+      aggregator: 'first',
+      registers,
+      collect: () => collect.call(this),
+    });
+  }
+
+  /**
+   * !! ***You should only call this from within a collect callback***
+   */
+  public set(labels: Record<T, string>) {
+    this.#gauge.set(labels, 1);
+  }
+}

oada/libs/models/package.json

@@ -38,7 +38,7 @@
     "node": "22.5.1"
   },
   "devDependencies": {
-    "@types/node": "^22.5.5",
-    "jose": "^5.9.2"
+    "@types/node": "^22.7.3",
+    "jose": "^5.9.3"
   }
 }

oada/libs/pino-debug/package.json

@@ -28,13 +28,13 @@
     "pino": "^9.4.0",
     "pino-caller": "^3.4.0",
     "pino-debug": "^2.0.0",
-    "pino-loki": "^2.3.0",
+    "pino-loki": "^2.3.1",
     "pino-pretty": "^11.2.2",
     "tslib": "2.7.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.12",
-    "@types/node": "^22.5.5"
+    "@types/node": "^22.7.3"
   },
   "peerDependencies": {
     "debug": "*"

oada/libs/pino-debug/src/index.ts

@@ -17,7 +17,7 @@
 
 /* eslint-disable unicorn/prefer-module */
 
-/* eslint-disable import/no-dynamic-require */
+ 
 
 import { resolve } from 'node:path';
 

oada/package.json

@@ -18,26 +18,26 @@
     "@eslint/compat": "^1.1.1",
     "@eslint/config-inspector": "^0.5.4",
     "@eslint/eslintrc": "^3.1.0",
-    "@eslint/js": "^9.10.0",
+    "@eslint/js": "^9.11.1",
     "@tsconfig/node20": "^20.1.4",
     "@types/eslint": "^9.6.1",
     "@types/mocha": "^10.0.8",
-    "@types/node": "^22.5.5",
-    "@typescript-eslint/eslint-plugin": "^8.6.0",
-    "@typescript-eslint/parser": "^8.6.0",
+    "@types/node": "^22.7.3",
+    "@typescript-eslint/eslint-plugin": "^8.7.0",
+    "@typescript-eslint/parser": "^8.7.0",
     "@yarnpkg/sdks": "^3.2.0",
-    "browserslist": "^4.23.3",
+    "browserslist": "^4.24.0",
     "c8": "^10.1.2",
-    "eslint": "^9.10.0",
+    "eslint": "^9.11.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-xo": "^0.46.0",
-    "eslint-config-xo-typescript": "^6.0.0",
+    "eslint-config-xo-typescript": "^7.0.0",
     "eslint-formatter-pretty": "^6.0.1",
     "eslint-import-resolver-node": "^0.3.9",
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-array-func": "^5.0.2",
     "eslint-plugin-ava": "^15.0.1",
-    "eslint-plugin-escompat": "^3.11.1",
+    "eslint-plugin-escompat": "^3.11.3",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-filenames": "^1.3.2",
     "eslint-plugin-github": "^5.0.2",
@@ -59,9 +59,9 @@
     "prettier": "^3.3.3",
     "tslib": "2.7.0",
     "typescript": "5.6.2",
-    "typescript-eslint": "^8.6.0",
+    "typescript-eslint": "^8.7.0",
     "update-browserslist-db": "^1.1.0",
-    "zx": "^8.1.7"
+    "zx": "^8.1.8"
   },
   "dependencies": {
     "pino-pretty": "^11.2.2"