@xyo-network/prometheus-node-plugin 2.53.4

package/dist/esm/Plugin.js

@@ -0,0 +1,11 @@
+import { PayloadSetSchema } from '@xyo-network/payload-model';
+import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin';
+import { PrometheusNodeWitness } from './Witness';
+export const PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value';
+export const PrometheusNodePlugin = () => createPayloadSetWitnessPlugin({ required: { [PrometheusMetricValueSchema]: 1 }, schema: PayloadSetSchema }, {
+    witness: async (params) => {
+        const result = await PrometheusNodeWitness.create(params);
+        return result;
+    },
+});
+//# sourceMappingURL=Plugin.js.map

package/dist/esm/Plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.js","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAW,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AACtE,OAAO,EAAE,6BAA6B,EAAE,MAAM,gCAAgC,CAAA;AAG9E,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAGjD,MAAM,CAAC,MAAM,2BAA2B,GAAgC,qCAAqC,CAAA;AAY7G,MAAM,CAAC,MAAM,oBAAoB,GAAG,GAAG,EAAE,CACvC,6BAA6B,CAC3B,EAAE,QAAQ,EAAE,EAAE,CAAC,2BAA2B,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,gBAAgB,EAAE,EAC5E;IACE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE;QACxB,MAAM,MAAM,GAAG,MAAM,qBAAqB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;QACzD,OAAO,MAAM,CAAA;IACf,CAAC;CACF,CACF,CAAA"}

package/dist/esm/Witness.js

@@ -0,0 +1,41 @@
+import { AbstractWitness } from '@xyo-network/witness';
+import { createServer } from 'http';
+import compact from 'lodash/compact';
+import { collectDefaultMetrics, Registry } from 'prom-client';
+import { PrometheusMetricValueSchema } from './Plugin';
+export const PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config';
+export class PrometheusNodeWitness extends AbstractWitness {
+    static configSchema = PrometheusNodeWitnessConfigSchema;
+    _registry = new Registry();
+    server;
+    get registry() {
+        return this._registry;
+    }
+    async observe(_payloads) {
+        return await super.observe(await this.generateMetricValues());
+    }
+    async start(timeout) {
+        collectDefaultMetrics({ register: this._registry });
+        if (this.config.port) {
+            this.server = createServer(async (_request, response) => {
+                response.writeHead(200);
+                response.end(await this._registry.metrics());
+            });
+            this.server.listen(this.config.port);
+        }
+        return await super.start(timeout);
+    }
+    stop(_timeout) {
+        this.server?.close();
+        return this;
+    }
+    async generateMetricValues() {
+        return compact((await this._registry.getMetricsAsJSON()).map((metric) => {
+            const values = metric.values;
+            if (values) {
+                return { aggregator: metric.aggregator, name: metric.name, schema: PrometheusMetricValueSchema, type: metric.type, values };
+            }
+        }));
+    }
+}
+//# sourceMappingURL=Witness.js.map

package/dist/esm/Witness.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.js","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,eAAe,EAAmC,MAAM,sBAAsB,CAAA;AACvF,OAAO,EAAE,YAAY,EAAU,MAAM,MAAM,CAAA;AAC3C,OAAO,OAAO,MAAM,gBAAgB,CAAA;AACpC,OAAO,EAAE,qBAAqB,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAA;AAE7D,OAAO,EAAgC,2BAA2B,EAAE,MAAM,UAAU,CAAA;AAGpF,MAAM,CAAC,MAAM,iCAAiC,GAAsC,4CAA4C,CAAA;AAShI,MAAM,OAAO,qBAAiG,SAAQ,eAAwB;IAC5I,MAAM,CAAU,YAAY,GAAG,iCAAiC,CAAA;IACtD,SAAS,GAAG,IAAI,QAAQ,EAAE,CAAA;IAC1B,MAAM,CAAS;IAEzB,IAAI,QAAQ;QACV,OAAO,IAAI,CAAC,SAAS,CAAA;IACvB,CAAC;IAEQ,KAAK,CAAC,OAAO,CAAC,SAA8B;QACnD,OAAO,MAAM,KAAK,CAAC,OAAO,CAAC,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC,CAAA;IAC/D,CAAC;IAEQ,KAAK,CAAC,KAAK,CAAC,OAAgB;QACnC,qBAAqB,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QACnD,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YACpB,IAAI,CAAC,MAAM,GAAG,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,EAAE;gBACtD,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAA;gBAEvB,QAAQ,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC,CAAA;YAC9C,CAAC,CAAC,CAAA;YACF,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;SACrC;QACD,OAAO,MAAM,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;IACnC,CAAC;IAEQ,IAAI,CAAC,QAAiB;QAC7B,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,CAAA;QACpB,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,KAAK,CAAC,oBAAoB;QAChC,OAAO,OAAO,CACZ,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,gBAAgB,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;YACvD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;YAC5B,IAAI,MAAM,EAAE;gBACV,OAAO,EAAE,UAAU,EAAE,MAAM,CAAC,UAAU,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,2BAA2B,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,CAAA;aAC5H;QACH,CAAC,CAAC,CACH,CAAA;IACH,CAAC"}

package/dist/esm/index.js

@@ -0,0 +1,6 @@
+import { PrometheusNodePlugin } from './Plugin';
+export * from './Witness';
+export { PrometheusNodePlugin };
+// eslint-disable-next-line import/no-default-export
+export default PrometheusNodePlugin;
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,oBAAoB,EAAE,CAAA;AAE/B,oDAAoD;AACpD,eAAe,oBAAoB,CAAA"}

package/dist/types/Plugin.d.ts

@@ -0,0 +1,13 @@
+import { Payload } from '@xyo-network/payload-model';
+import { Aggregator, MetricType } from 'prom-client';
+import { PrometheusNodeWitness } from './Witness';
+export type PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value';
+export declare const PrometheusMetricValueSchema: PrometheusMetricValueSchema;
+export type PrometheusMetricValuePayload = Payload<{
+    aggregator: Aggregator;
+    name: string;
+    type: MetricType;
+    values: (number | string | object)[];
+}, PrometheusMetricValueSchema>;
+export declare const PrometheusNodePlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetWitnessPlugin<PrometheusNodeWitness<import("./Witness").PrometheusNodeWitnessParams>>;
+//# sourceMappingURL=Plugin.d.ts.map

package/dist/types/Plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAoB,MAAM,4BAA4B,CAAA;AAEtE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAEpD,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAEjD,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAA;AAC/E,eAAO,MAAM,2BAA2B,EAAE,2BAAmE,CAAA;AAE7G,MAAM,MAAM,4BAA4B,GAAG,OAAO,CAChD;IACE,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,UAAU,CAAA;IAChB,MAAM,EAAE,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,EAAE,CAAA;CACrC,EACD,2BAA2B,CAC5B,CAAA;AAED,eAAO,MAAM,oBAAoB,gJAS9B,CAAA"}

package/dist/types/Witness.d.ts

@@ -0,0 +1,24 @@
+/// <reference types="node" />
+import { AnyConfigSchema } from '@xyo-network/module';
+import { Payload } from '@xyo-network/payload-model';
+import { AbstractWitness, WitnessParams, XyoWitnessConfig } from '@xyo-network/witness';
+import { Server } from 'http';
+import { Registry } from 'prom-client';
+export type PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config';
+export declare const PrometheusNodeWitnessConfigSchema: PrometheusNodeWitnessConfigSchema;
+export type PrometheusNodeWitnessConfig = XyoWitnessConfig<{
+    port?: number;
+    schema: PrometheusNodeWitnessConfigSchema;
+}>;
+export type PrometheusNodeWitnessParams = WitnessParams<AnyConfigSchema<PrometheusNodeWitnessConfig>>;
+export declare class PrometheusNodeWitness<TParams extends PrometheusNodeWitnessParams = PrometheusNodeWitnessParams> extends AbstractWitness<TParams> {
+    static configSchema: "network.xyo.prometheus.node.witness.config";
+    protected _registry: Registry;
+    protected server?: Server;
+    get registry(): Registry;
+    observe(_payloads?: Partial<Payload>[]): Promise<Payload[]>;
+    start(timeout?: number): Promise<void>;
+    stop(_timeout?: number): this;
+    private generateMetricValues;
+}
+//# sourceMappingURL=Witness.d.ts.map

package/dist/types/Witness.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAA;AACvF,OAAO,EAAgB,MAAM,EAAE,MAAM,MAAM,CAAA;AAE3C,OAAO,EAAyB,QAAQ,EAAE,MAAM,aAAa,CAAA;AAI7D,MAAM,MAAM,iCAAiC,GAAG,4CAA4C,CAAA;AAC5F,eAAO,MAAM,iCAAiC,EAAE,iCAAgF,CAAA;AAEhI,MAAM,MAAM,2BAA2B,GAAG,gBAAgB,CAAC;IACzD,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,iCAAiC,CAAA;CAC1C,CAAC,CAAA;AAEF,MAAM,MAAM,2BAA2B,GAAG,aAAa,CAAC,eAAe,CAAC,2BAA2B,CAAC,CAAC,CAAA;AAErG,qBAAa,qBAAqB,CAAC,OAAO,SAAS,2BAA2B,GAAG,2BAA2B,CAAE,SAAQ,eAAe,CAAC,OAAO,CAAC;IAC5I,OAAgB,YAAY,+CAAoC;IAChE,SAAS,CAAC,SAAS,WAAiB;IACpC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAEzB,IAAI,QAAQ,IAAI,QAAQ,CAEvB;IAEc,OAAO,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAI3D,KAAK,CAAC,OAAO,CAAC,EAAE,MAAM;IAa5B,IAAI,CAAC,QAAQ,CAAC,EAAE,MAAM;YAKjB,oBAAoB;CAUnC"}

package/dist/types/index.d.ts

@@ -0,0 +1,5 @@
+import { PrometheusNodePlugin } from './Plugin';
+export * from './Witness';
+export { PrometheusNodePlugin };
+export default PrometheusNodePlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAE/C,cAAc,WAAW,CAAA;AAEzB,OAAO,EAAE,oBAAoB,EAAE,CAAA;AAG/B,eAAe,oBAAoB,CAAA"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@xyo-network/prometheus-node-plugin",
+  "author": {
+    "email": "support@xyo.network",
+    "name": "XYO Development Team",
+    "url": "https://xyo.network"
+  },
+  "bugs": {
+    "email": "support@xyo.network",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
+  },
+  "dependencies": {
+    "@xyo-network/module": "^2.53.4",
+    "@xyo-network/payload-model": "^2.53.4",
+    "@xyo-network/payloadset-plugin": "^2.53.4",
+    "@xyo-network/witness": "^2.53.4",
+    "lodash": "^4.17.21",
+    "prom-client": "^14.2.0"
+  },
+  "devDependencies": {
+    "@types/lodash": "^4.14.191",
+    "@xylabs/ts-scripts-yarn3": "^2.16.1",
+    "@xylabs/tsconfig": "^2.16.1",
+    "typescript": "^4.9.5"
+  },
+  "description": "Primary SDK for using XYO Protocol 2.0",
+  "browser": "dist/esm/index.js",
+  "docs": "dist/docs.json",
+  "exports": {
+    ".": {
+      "node": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "browser": {
+        "import": "./dist/esm/index.js",
+        "require": "./dist/cjs/index.js"
+      },
+      "default": "./dist/esm/index.js"
+    },
+    "./dist/docs.json": {
+      "default": "./dist/docs.json"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "homepage": "https://xyo.network",
+  "license": "LGPL-3.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
+  },
+  "sideEffects": false,
+  "types": "dist/types/index.d.ts",
+  "version": "2.53.4"
+}

package/src/Plugin.ts

@@ -0,0 +1,29 @@
+import { Payload, PayloadSetSchema } from '@xyo-network/payload-model'
+import { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'
+import { Aggregator, MetricType } from 'prom-client'
+
+import { PrometheusNodeWitness } from './Witness'
+
+export type PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value'
+export const PrometheusMetricValueSchema: PrometheusMetricValueSchema = 'network.xyo.prometheus.metric.value'
+
+export type PrometheusMetricValuePayload = Payload<
+  {
+    aggregator: Aggregator
+    name: string
+    type: MetricType
+    values: (number | string | object)[]
+  },
+  PrometheusMetricValueSchema
+>
+
+export const PrometheusNodePlugin = () =>
+  createPayloadSetWitnessPlugin<PrometheusNodeWitness>(
+    { required: { [PrometheusMetricValueSchema]: 1 }, schema: PayloadSetSchema },
+    {
+      witness: async (params) => {
+        const result = await PrometheusNodeWitness.create(params)
+        return result
+      },
+    },
+  )

package/src/Witness.ts

@@ -0,0 +1,61 @@
+import { AnyConfigSchema } from '@xyo-network/module'
+import { Payload } from '@xyo-network/payload-model'
+import { AbstractWitness, WitnessParams, XyoWitnessConfig } from '@xyo-network/witness'
+import { createServer, Server } from 'http'
+import compact from 'lodash/compact'
+import { collectDefaultMetrics, Registry } from 'prom-client'
+
+import { PrometheusMetricValuePayload, PrometheusMetricValueSchema } from './Plugin'
+
+export type PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config'
+export const PrometheusNodeWitnessConfigSchema: PrometheusNodeWitnessConfigSchema = 'network.xyo.prometheus.node.witness.config'
+
+export type PrometheusNodeWitnessConfig = XyoWitnessConfig<{
+  port?: number
+  schema: PrometheusNodeWitnessConfigSchema
+}>
+
+export type PrometheusNodeWitnessParams = WitnessParams<AnyConfigSchema<PrometheusNodeWitnessConfig>>
+
+export class PrometheusNodeWitness<TParams extends PrometheusNodeWitnessParams = PrometheusNodeWitnessParams> extends AbstractWitness<TParams> {
+  static override configSchema = PrometheusNodeWitnessConfigSchema
+  protected _registry = new Registry()
+  protected server?: Server
+
+  get registry(): Registry {
+    return this._registry
+  }
+
+  override async observe(_payloads?: Partial<Payload>[]): Promise<Payload[]> {
+    return await super.observe(await this.generateMetricValues())
+  }
+
+  override async start(timeout?: number) {
+    collectDefaultMetrics({ register: this._registry })
+    if (this.config.port) {
+      this.server = createServer(async (_request, response) => {
+        response.writeHead(200)
+
+        response.end(await this._registry.metrics())
+      })
+      this.server.listen(this.config.port)
+    }
+    return await super.start(timeout)
+  }
+
+  override stop(_timeout?: number) {
+    this.server?.close()
+    return this
+  }
+
+  private async generateMetricValues(): Promise<PrometheusMetricValuePayload[]> {
+    return compact(
+      (await this._registry.getMetricsAsJSON()).map((metric) => {
+        const values = metric.values
+        if (values) {
+          return { aggregator: metric.aggregator, name: metric.name, schema: PrometheusMetricValueSchema, type: metric.type, values }
+        }
+      }),
+    )
+  }
+}

package/src/index.ts

@@ -0,0 +1,8 @@
+import { PrometheusNodePlugin } from './Plugin'
+
+export * from './Witness'
+
+export { PrometheusNodePlugin }
+
+// eslint-disable-next-line import/no-default-export
+export default PrometheusNodePlugin