@xyo-network/prometheus-node-plugin 5.3.1 → 5.3.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/prometheus-node-plugin",
3
- "version": "5.3.1",
3
+ "version": "5.3.2",
4
4
  "description": "Typescript/Javascript Plugins for XYO Platform",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -35,22 +35,25 @@
35
35
  "!**/*.spec.*",
36
36
  "!**/*.test.*"
37
37
  ],
38
- "dependencies": {
39
- "@xylabs/exists": "~5.0.64",
40
- "@xyo-network/abstract-witness": "~5.3.2",
41
- "@xyo-network/module-model": "~5.3.2",
42
- "@xyo-network/payload-model": "~5.3.2",
43
- "@xyo-network/payloadset-plugin": "~5.3.2",
44
- "@xyo-network/witness-model": "~5.3.2",
45
- "prom-client": "~15.1.3"
46
- },
47
38
  "devDependencies": {
48
- "@xylabs/ts-scripts-yarn3": "~7.3.2",
49
- "@xylabs/tsconfig": "~7.3.2",
50
- "@xylabs/vitest-extended": "~5.0.64",
51
- "@xyo-network/payload-wrapper": "~5.3.2",
39
+ "@xylabs/sdk-js": "^5.0.90",
40
+ "@xylabs/ts-scripts-yarn3": "~7.5.10",
41
+ "@xylabs/tsconfig": "~7.5.10",
42
+ "@xylabs/vitest-extended": "~5.0.90",
43
+ "@xyo-network/abstract-witness": "~5.3.5",
44
+ "@xyo-network/module-model": "~5.3.5",
45
+ "@xyo-network/payload-model": "~5.3.5",
46
+ "@xyo-network/payloadset-plugin": "~5.3.5",
47
+ "@xyo-network/sdk-js": "~5.3.5",
48
+ "@xyo-network/witness-model": "~5.3.5",
49
+ "prom-client": "~15.1.3",
52
50
  "typescript": "~5.9.3",
53
- "vitest": "~4.0.18"
51
+ "vitest": "~4.1.2",
52
+ "zod": "^4.3.6"
53
+ },
54
+ "peerDependencies": {
55
+ "@xylabs/sdk-js": "^5",
56
+ "zod": "^4"
54
57
  },
55
58
  "publishConfig": {
56
59
  "access": "public"
package/src/Witness.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { Server } from 'node:http'
2
2
  import { createServer } from 'node:http'
3
3
 
4
- import { exists } from '@xylabs/exists'
4
+ import { exists } from '@xylabs/sdk-js'
5
5
  import { AbstractWitness } from '@xyo-network/abstract-witness'
6
6
  import type { AnyConfigSchema } from '@xyo-network/module-model'
7
7
  import { creatableModule } from '@xyo-network/module-model'
@@ -1,10 +0,0 @@
1
- import type { Payload } from '@xyo-network/payload-model';
2
- import type { Aggregator, MetricType } from 'prom-client';
3
- import type { PrometheusMetricValueSchema } from './Schema.ts';
4
- export type PrometheusMetricValuePayload = Payload<{
5
- aggregator: Aggregator;
6
- name: string;
7
- type: MetricType;
8
- values: (number | string | object)[];
9
- }, PrometheusMetricValueSchema>;
10
- //# sourceMappingURL=Payload.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Payload.d.ts","sourceRoot":"","sources":["../../src/Payload.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAEzD,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,aAAa,CAAA;AAE9D,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"}
@@ -1,3 +0,0 @@
1
- import { PrometheusNodeWitness } from './Witness.ts';
2
- export declare const PrometheusNodePlugin: () => import("@xyo-network/payloadset-plugin").PayloadSetWitnessPlugin<PrometheusNodeWitness<import("./Witness.ts").PrometheusNodeWitnessParams>>;
3
- //# sourceMappingURL=Plugin.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Plugin.d.ts","sourceRoot":"","sources":["../../src/Plugin.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,qBAAqB,EAAE,MAAM,cAAc,CAAA;AAEpD,eAAO,MAAM,oBAAoB,mJAS9B,CAAA"}
@@ -1,5 +0,0 @@
1
- export type PrometheusMetricValueSchema = typeof PrometheusMetricValueSchema;
2
- export declare const PrometheusMetricValueSchema: "network.xyo.prometheus.metric.value" & {
3
- readonly __schema: true;
4
- };
5
- //# sourceMappingURL=Schema.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Schema.d.ts","sourceRoot":"","sources":["../../src/Schema.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,2BAA2B,GAAG,OAAO,2BAA2B,CAAA;AAC5E,eAAO,MAAM,2BAA2B;;CAAwD,CAAA"}
@@ -1,27 +0,0 @@
1
- import type { Server } from 'node:http';
2
- import { AbstractWitness } from '@xyo-network/abstract-witness';
3
- import type { AnyConfigSchema } from '@xyo-network/module-model';
4
- import { type Payload, type Schema } from '@xyo-network/payload-model';
5
- import type { WitnessConfig, WitnessParams } from '@xyo-network/witness-model';
6
- import { Registry } from 'prom-client';
7
- export type PrometheusNodeWitnessConfigSchema = typeof PrometheusNodeWitnessConfigSchema;
8
- export declare const PrometheusNodeWitnessConfigSchema: "network.xyo.prometheus.node.witness.config" & {
9
- readonly __schema: true;
10
- };
11
- export type PrometheusNodeWitnessConfig = WitnessConfig<{
12
- port?: number;
13
- schema: PrometheusNodeWitnessConfigSchema;
14
- }>;
15
- export type PrometheusNodeWitnessParams = WitnessParams<AnyConfigSchema<PrometheusNodeWitnessConfig>>;
16
- export declare class PrometheusNodeWitness<TParams extends PrometheusNodeWitnessParams = PrometheusNodeWitnessParams> extends AbstractWitness<TParams> {
17
- static readonly configSchemas: Schema[];
18
- static readonly defaultConfigSchema: Schema;
19
- protected _registry: Registry<"text/plain; version=0.0.4; charset=utf-8">;
20
- protected server?: Server;
21
- get registry(): Registry;
22
- protected observeHandler(_payloads?: Partial<Payload>[]): Promise<Payload[]>;
23
- protected startHandler(): Promise<void>;
24
- protected stopHandler(): Promise<void>;
25
- private generateMetricValues;
26
- }
27
- //# sourceMappingURL=Witness.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Witness.d.ts","sourceRoot":"","sources":["../../src/Witness.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAIvC,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAA;AAC/D,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAEhE,OAAO,EACK,KAAK,OAAO,EAAE,KAAK,MAAM,EACpC,MAAM,4BAA4B,CAAA;AACnC,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAC9E,OAAO,EAAyB,QAAQ,EAAE,MAAM,aAAa,CAAA;AAK7D,MAAM,MAAM,iCAAiC,GAAG,OAAO,iCAAiC,CAAA;AACxF,eAAO,MAAM,iCAAiC;;CAA+D,CAAA;AAE7G,MAAM,MAAM,2BAA2B,GAAG,aAAa,CAAC;IACtD,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;AAGrG,qBAAa,qBAAqB,CAAC,OAAO,SAAS,2BAA2B,GAAG,2BAA2B,CAAE,SAAQ,eAAe,CAAC,OAAO,CAAC;IAC5I,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAA8D;IAC9G,gBAAyB,mBAAmB,EAAE,MAAM,CAAoC;IACxF,SAAS,CAAC,SAAS,uDAAiB;IACpC,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAA;IAEzB,IAAI,QAAQ,IAAI,QAAQ,CAEvB;cAEwB,cAAc,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIlE,YAAY;cAcZ,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;YAKvC,oBAAoB;CAUnC"}
@@ -1,5 +0,0 @@
1
- export * from './Payload.ts';
2
- export { PrometheusNodePlugin as default, PrometheusNodePlugin } from './Plugin.ts';
3
- export * from './Schema.ts';
4
- export * from './Witness.ts';
5
- //# sourceMappingURL=index.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,OAAO,EAAE,oBAAoB,IAAI,OAAO,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAA;AACnF,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA"}
@@ -1,79 +0,0 @@
1
- // src/Plugin.ts
2
- import { PayloadSetSchema } from "@xyo-network/payload-model";
3
- import { createPayloadSetWitnessPlugin } from "@xyo-network/payloadset-plugin";
4
-
5
- // src/Schema.ts
6
- import { asSchema } from "@xyo-network/payload-model";
7
- var PrometheusMetricValueSchema = asSchema("network.xyo.prometheus.metric.value", true);
8
-
9
- // src/Witness.ts
10
- import { createServer } from "http";
11
- import { exists } from "@xylabs/exists";
12
- import { AbstractWitness } from "@xyo-network/abstract-witness";
13
- import { creatableModule } from "@xyo-network/module-model";
14
- import {
15
- asSchema as asSchema2
16
- } from "@xyo-network/payload-model";
17
- import { collectDefaultMetrics, Registry } from "prom-client";
18
- var PrometheusNodeWitnessConfigSchema = asSchema2("network.xyo.prometheus.node.witness.config", true);
19
- creatableModule();
20
- var PrometheusNodeWitness = class extends AbstractWitness {
21
- static configSchemas = [...super.configSchemas, PrometheusNodeWitnessConfigSchema];
22
- static defaultConfigSchema = PrometheusNodeWitnessConfigSchema;
23
- _registry = new Registry();
24
- server;
25
- get registry() {
26
- return this._registry;
27
- }
28
- async observeHandler(_payloads) {
29
- return await this.generateMetricValues();
30
- }
31
- async startHandler() {
32
- collectDefaultMetrics({ register: this._registry });
33
- if (this.config.port) {
34
- this.server = createServer(async (_request, response) => {
35
- response.writeHead(200);
36
- response.end(await this._registry.metrics());
37
- });
38
- this.server.listen(this.config.port);
39
- }
40
- return await super.startHandler();
41
- }
42
- async stopHandler() {
43
- this.server?.close();
44
- await super.stopHandler();
45
- }
46
- async generateMetricValues() {
47
- return (await this._registry.getMetricsAsJSON()).map((metric) => {
48
- const values = metric.values;
49
- if (values) {
50
- return {
51
- aggregator: metric.aggregator,
52
- name: metric.name,
53
- schema: PrometheusMetricValueSchema,
54
- type: metric.type,
55
- values
56
- };
57
- }
58
- }).filter(exists);
59
- }
60
- };
61
-
62
- // src/Plugin.ts
63
- var PrometheusNodePlugin = () => createPayloadSetWitnessPlugin(
64
- { required: { [PrometheusMetricValueSchema]: 1 }, schema: PayloadSetSchema },
65
- {
66
- witness: async (params) => {
67
- const result = await PrometheusNodeWitness.create(params);
68
- return result;
69
- }
70
- }
71
- );
72
- export {
73
- PrometheusMetricValueSchema,
74
- PrometheusNodePlugin,
75
- PrometheusNodeWitness,
76
- PrometheusNodeWitnessConfigSchema,
77
- PrometheusNodePlugin as default
78
- };
79
- //# sourceMappingURL=index.mjs.map
@@ -1 +0,0 @@
1
- {"version":3,"sources":["../../src/Plugin.ts","../../src/Schema.ts","../../src/Witness.ts"],"sourcesContent":["import { PayloadSetSchema } from '@xyo-network/payload-model'\nimport { createPayloadSetWitnessPlugin } from '@xyo-network/payloadset-plugin'\n\nimport { PrometheusMetricValueSchema } from './Schema.ts'\nimport { PrometheusNodeWitness } from './Witness.ts'\n\nexport const PrometheusNodePlugin = () =>\n createPayloadSetWitnessPlugin<PrometheusNodeWitness>(\n { required: { [PrometheusMetricValueSchema]: 1 }, schema: PayloadSetSchema },\n {\n witness: async (params) => {\n const result = await PrometheusNodeWitness.create(params)\n return result\n },\n },\n )\n","import { asSchema } from '@xyo-network/payload-model'\n\nexport type PrometheusMetricValueSchema = typeof PrometheusMetricValueSchema\nexport const PrometheusMetricValueSchema = asSchema('network.xyo.prometheus.metric.value', true)\n","import type { Server } from 'node:http'\nimport { createServer } from 'node:http'\n\nimport { exists } from '@xylabs/exists'\nimport { AbstractWitness } from '@xyo-network/abstract-witness'\nimport type { AnyConfigSchema } from '@xyo-network/module-model'\nimport { creatableModule } from '@xyo-network/module-model'\nimport {\n asSchema, type Payload, type Schema,\n} from '@xyo-network/payload-model'\nimport type { WitnessConfig, WitnessParams } from '@xyo-network/witness-model'\nimport { collectDefaultMetrics, Registry } from 'prom-client'\n\nimport type { PrometheusMetricValuePayload } from './Payload.ts'\nimport { PrometheusMetricValueSchema } from './Schema.ts'\n\nexport type PrometheusNodeWitnessConfigSchema = typeof PrometheusNodeWitnessConfigSchema\nexport const PrometheusNodeWitnessConfigSchema = asSchema('network.xyo.prometheus.node.witness.config', true)\n\nexport type PrometheusNodeWitnessConfig = WitnessConfig<{\n port?: number\n schema: PrometheusNodeWitnessConfigSchema\n}>\n\nexport type PrometheusNodeWitnessParams = WitnessParams<AnyConfigSchema<PrometheusNodeWitnessConfig>>\n\ncreatableModule()\nexport class PrometheusNodeWitness<TParams extends PrometheusNodeWitnessParams = PrometheusNodeWitnessParams> extends AbstractWitness<TParams> {\n static override readonly configSchemas: Schema[] = [...super.configSchemas, PrometheusNodeWitnessConfigSchema]\n static override readonly defaultConfigSchema: Schema = PrometheusNodeWitnessConfigSchema\n protected _registry = new Registry()\n protected server?: Server\n\n get registry(): Registry {\n return this._registry\n }\n\n protected override async observeHandler(_payloads?: Partial<Payload>[]): Promise<Payload[]> {\n return await this.generateMetricValues()\n }\n\n protected override async startHandler() {\n collectDefaultMetrics({ register: this._registry })\n if (this.config.port) {\n // eslint-disable-next-line @typescript-eslint/no-misused-promises\n this.server = createServer(async (_request, response) => {\n response.writeHead(200)\n\n response.end(await this._registry.metrics())\n })\n this.server.listen(this.config.port)\n }\n return await super.startHandler()\n }\n\n protected override async stopHandler(): Promise<void> {\n this.server?.close()\n await super.stopHandler()\n }\n\n private async generateMetricValues(): Promise<PrometheusMetricValuePayload[]> {\n return (await this._registry.getMetricsAsJSON()).map((metric) => {\n const values = metric.values\n if (values) {\n return {\n aggregator: metric.aggregator, name: metric.name, schema: PrometheusMetricValueSchema, type: metric.type, values,\n }\n }\n }).filter(exists)\n }\n}\n"],"mappings":";AAAA,SAAS,wBAAwB;AACjC,SAAS,qCAAqC;;;ACD9C,SAAS,gBAAgB;AAGlB,IAAM,8BAA8B,SAAS,uCAAuC,IAAI;;;ACF/F,SAAS,oBAAoB;AAE7B,SAAS,cAAc;AACvB,SAAS,uBAAuB;AAEhC,SAAS,uBAAuB;AAChC;AAAA,EACE,YAAAA;AAAA,OACK;AAEP,SAAS,uBAAuB,gBAAgB;AAMzC,IAAM,oCAAoCC,UAAS,8CAA8C,IAAI;AAS5G,gBAAgB;AACT,IAAM,wBAAN,cAA+G,gBAAyB;AAAA,EAC7I,OAAyB,gBAA0B,CAAC,GAAG,MAAM,eAAe,iCAAiC;AAAA,EAC7G,OAAyB,sBAA8B;AAAA,EAC7C,YAAY,IAAI,SAAS;AAAA,EACzB;AAAA,EAEV,IAAI,WAAqB;AACvB,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,MAAyB,eAAe,WAAoD;AAC1F,WAAO,MAAM,KAAK,qBAAqB;AAAA,EACzC;AAAA,EAEA,MAAyB,eAAe;AACtC,0BAAsB,EAAE,UAAU,KAAK,UAAU,CAAC;AAClD,QAAI,KAAK,OAAO,MAAM;AAEpB,WAAK,SAAS,aAAa,OAAO,UAAU,aAAa;AACvD,iBAAS,UAAU,GAAG;AAEtB,iBAAS,IAAI,MAAM,KAAK,UAAU,QAAQ,CAAC;AAAA,MAC7C,CAAC;AACD,WAAK,OAAO,OAAO,KAAK,OAAO,IAAI;AAAA,IACrC;AACA,WAAO,MAAM,MAAM,aAAa;AAAA,EAClC;AAAA,EAEA,MAAyB,cAA6B;AACpD,SAAK,QAAQ,MAAM;AACnB,UAAM,MAAM,YAAY;AAAA,EAC1B;AAAA,EAEA,MAAc,uBAAgE;AAC5E,YAAQ,MAAM,KAAK,UAAU,iBAAiB,GAAG,IAAI,CAAC,WAAW;AAC/D,YAAM,SAAS,OAAO;AACtB,UAAI,QAAQ;AACV,eAAO;AAAA,UACL,YAAY,OAAO;AAAA,UAAY,MAAM,OAAO;AAAA,UAAM,QAAQ;AAAA,UAA6B,MAAM,OAAO;AAAA,UAAM;AAAA,QAC5G;AAAA,MACF;AAAA,IACF,CAAC,EAAE,OAAO,MAAM;AAAA,EAClB;AACF;;;AFhEO,IAAM,uBAAuB,MAClC;AAAA,EACE,EAAE,UAAU,EAAE,CAAC,2BAA2B,GAAG,EAAE,GAAG,QAAQ,iBAAiB;AAAA,EAC3E;AAAA,IACE,SAAS,OAAO,WAAW;AACzB,YAAM,SAAS,MAAM,sBAAsB,OAAO,MAAM;AACxD,aAAO;AAAA,IACT;AAAA,EACF;AACF;","names":["asSchema","asSchema"]}