@libp2p/prometheus-metrics 0.0.0

package/LICENSE

@@ -0,0 +1,4 @@
+This project is dual licensed under MIT and Apache-2.0.
+
+MIT: https://www.opensource.org/licenses/mit
+Apache-2.0: https://www.apache.org/licenses/license-2.0

package/README.md

@@ -0,0 +1,31 @@
+# @libp2p/prometheus-metrics <!-- omit in toc -->
+
+[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)
+[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)
+[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-prometheus-metrics.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-prometheus-metrics)
+[![CI](https://img.shields.io/github/workflow/status/libp2p/js-libp2p-prometheus-metrics/test%20&%20maybe%20release/main?style=flat-square)](https://github.com/libp2p/js-libp2p-prometheus-metrics/actions/workflows/js-test-and-release.yml)
+
+> Collect libp2p metrics for scraping by Prometheus
+
+## Table of contents <!-- omit in toc -->
+
+- [Install](#install)
+- [License](#license)
+- [Contribute](#contribute)
+
+## Install
+
+```console
+$ npm i @libp2p/prometheus-metrics
+```
+
+## License
+
+Licensed under either of
+
+- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
+- MIT ([LICENSE-MIT](LICENSE-MIT) / <http://opensource.org/licenses/MIT>)
+
+## Contribute
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

package/dist/src/index.d.ts

@@ -0,0 +1,10 @@
+import type { Metrics } from '@libp2p/interface-metrics';
+import { DefaultMetricsCollectorConfiguration } from 'prom-client';
+import { DefaultMetricsInit } from '@libp2p/metrics';
+export interface PrometheusMetricsInit extends DefaultMetricsInit {
+    defaultMetrics?: DefaultMetricsCollectorConfiguration;
+    preserveExistingMetrics?: boolean;
+    collectDefaultMetrics?: boolean;
+}
+export declare function prometheusMetrics(init?: Partial<PrometheusMetricsInit>): () => Metrics;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAgF,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAEtI,OAAO,EAAiD,oCAAoC,EAAY,MAAM,aAAa,CAAA;AAG3H,OAAO,EAAkB,kBAAkB,EAAE,MAAM,iBAAiB,CAAA;AAEpE,MAAM,WAAW,qBAAsB,SAAQ,kBAAkB;IAC/D,cAAc,CAAC,EAAE,oCAAoC,CAAA;IACrD,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC,qBAAqB,CAAC,EAAE,OAAO,CAAA;CAChC;AAuHD,wBAAgB,iBAAiB,CAAE,IAAI,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,OAAO,CAIvF"}

package/dist/src/index.js

@@ -0,0 +1,99 @@
+import { Gauge, collectDefaultMetrics, register } from 'prom-client';
+import { PrometheusMetric } from './metric.js';
+import { PrometheusMetricGroup } from './metric-group.js';
+import { DefaultMetrics } from '@libp2p/metrics';
+class PrometheusMetrics extends DefaultMetrics {
+    constructor(init) {
+        super(init);
+        if (init?.preserveExistingMetrics !== true) {
+            // all metrics in prometheus are global so it's necessary to remove
+            // existing metrics to make sure we don't error when setting up metrics
+            register.clear();
+        }
+        if (init?.preserveExistingMetrics !== false) {
+            // collect memory/CPU and node-specific default metrics
+            collectDefaultMetrics(init?.defaultMetrics);
+        }
+        this.registerMetricGroup('libp2p_data_transfer_bytes', {
+            label: 'protocol',
+            calculate: () => {
+                const output = {};
+                const global = this.getGlobal().getSnapshot();
+                output['global sent'] = Number(global.dataSent);
+                output['global received'] = Number(global.dataReceived);
+                for (const protocol of this.getProtocols()) {
+                    const stats = this.forProtocol(protocol);
+                    if (stats == null) {
+                        continue;
+                    }
+                    const snapshot = stats.getSnapshot();
+                    output[`${protocol} sent`] = Number(snapshot.dataSent);
+                    output[`${protocol} received`] = Number(snapshot.dataReceived);
+                }
+                return output;
+            }
+        });
+        this.registerMetricGroup('nodejs_memory_usage_bytes', {
+            label: 'memory',
+            calculate: () => {
+                return {
+                    ...process.memoryUsage()
+                };
+            }
+        });
+    }
+    registerMetric(name, opts) {
+        if (name == null ?? name.trim() === '') {
+            throw new Error('Metric name is required');
+        }
+        if (opts?.calculate != null) {
+            const calculate = opts.calculate;
+            // calculated metric
+            const collect = async function () {
+                const value = await calculate();
+                this.set(value);
+            };
+            // prom-client metrics are global
+            new Gauge({
+                name,
+                help: opts.help ?? name,
+                labelNames: [opts.label ?? name],
+                collect
+            });
+            return;
+        }
+        return new PrometheusMetric(name, opts ?? {});
+    }
+    registerMetricGroup(name, opts) {
+        if (name == null ?? name.trim() === '') {
+            throw new Error('Metric name is required');
+        }
+        if (opts?.calculate != null) {
+            // calculated metric
+            const calculate = opts.calculate;
+            const label = opts.label ?? name;
+            // calculated metric
+            const collect = async function () {
+                const values = await calculate();
+                Object.entries(values).forEach(([key, value]) => {
+                    this.set({ [label]: key }, value);
+                });
+            };
+            // prom-client metrics are global
+            new Gauge({
+                name,
+                help: opts.help ?? name,
+                labelNames: [opts.label ?? name],
+                collect
+            });
+            return;
+        }
+        return new PrometheusMetricGroup(name, opts ?? {});
+    }
+}
+export function prometheusMetrics(init) {
+    return () => {
+        return new PrometheusMetrics(init);
+    };
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,EAAmB,qBAAqB,EAAwC,QAAQ,EAAE,MAAM,aAAa,CAAA;AAC3H,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,cAAc,EAAsB,MAAM,iBAAiB,CAAA;AAQpE,MAAM,iBAAkB,SAAQ,cAAc;IAC5C,YAAa,IAAqC;QAChD,KAAK,CAAC,IAAI,CAAC,CAAA;QAEX,IAAI,IAAI,EAAE,uBAAuB,KAAK,IAAI,EAAE;YAC1C,mEAAmE;YACnE,uEAAuE;YACvE,QAAQ,CAAC,KAAK,EAAE,CAAA;SACjB;QAED,IAAI,IAAI,EAAE,uBAAuB,KAAK,KAAK,EAAE;YAC3C,uDAAuD;YACvD,qBAAqB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;SAC5C;QAED,IAAI,CAAC,mBAAmB,CAAC,4BAA4B,EAAE;YACrD,KAAK,EAAE,UAAU;YACjB,SAAS,EAAE,GAAG,EAAE;gBACd,MAAM,MAAM,GAA2B,EAAE,CAAA;gBAEzC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,EAAE,CAAC,WAAW,EAAE,CAAA;gBAC7C,MAAM,CAAC,aAAa,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBAC/C,MAAM,CAAC,iBAAiB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;gBAEvD,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,YAAY,EAAE,EAAE;oBAC1C,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;oBAExC,IAAI,KAAK,IAAI,IAAI,EAAE;wBACjB,SAAQ;qBACT;oBAED,MAAM,QAAQ,GAAG,KAAK,CAAC,WAAW,EAAE,CAAA;oBACpC,MAAM,CAAC,GAAG,QAAQ,OAAO,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;oBACtD,MAAM,CAAC,GAAG,QAAQ,WAAW,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;iBAC/D;gBAED,OAAO,MAAM,CAAA;YACf,CAAC;SACF,CAAC,CAAA;QAEF,IAAI,CAAC,mBAAmB,CAAC,2BAA2B,EAAE;YACpD,KAAK,EAAE,QAAQ;YACf,SAAS,EAAE,GAAG,EAAE;gBACd,OAAO;oBACL,GAAG,OAAO,CAAC,WAAW,EAAE;iBACzB,CAAA;YACH,CAAC;SACF,CAAC,CAAA;IACJ,CAAC;IAID,cAAc,CAAE,IAAY,EAAE,IAAS;QACrC,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC3C;QAED,IAAI,IAAI,EAAE,SAAS,IAAI,IAAI,EAAE;YAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;YAEhC,oBAAoB;YACpB,MAAM,OAAO,GAAgC,KAAK;gBAChD,MAAM,KAAK,GAAG,MAAM,SAAS,EAAE,CAAA;gBAE/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CAAA;YAED,iCAAiC;YACjC,IAAI,KAAK,CAAC;gBACR,IAAI;gBACJ,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI;gBACvB,UAAU,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;gBAChC,OAAO;aACR,CAAC,CAAA;YAEF,OAAM;SACP;QAED,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;IAC/C,CAAC;IAID,mBAAmB,CAAE,IAAY,EAAE,IAAS;QAC1C,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC3C;QAED,IAAI,IAAI,EAAE,SAAS,IAAI,IAAI,EAAE;YAC3B,oBAAoB;YACpB,MAAM,SAAS,GAA4C,IAAI,CAAC,SAAS,CAAA;YACzE,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAA;YAEhC,oBAAoB;YACpB,MAAM,OAAO,GAAgC,KAAK;gBAChD,MAAM,MAAM,GAAG,MAAM,SAAS,EAAE,CAAA;gBAEhC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;oBAC9C,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,KAAK,CAAC,CAAA;gBACnC,CAAC,CAAC,CAAA;YACJ,CAAC,CAAA;YAED,iCAAiC;YACjC,IAAI,KAAK,CAAC;gBACR,IAAI;gBACJ,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,IAAI;gBACvB,UAAU,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC;gBAChC,OAAO;aACR,CAAC,CAAA;YAEF,OAAM;SACP;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;IACpD,CAAC;CACF;AAED,MAAM,UAAU,iBAAiB,CAAE,IAAqC;IACtE,OAAO,GAAG,EAAE;QACV,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC,CAAA;AACH,CAAC"}

package/dist/src/metric-group.d.ts

@@ -0,0 +1,12 @@
+import type { MetricOptions, MetricGroup, StopTimer } from '@libp2p/interface-metrics';
+export declare class PrometheusMetricGroup implements MetricGroup {
+    private readonly gauge;
+    private readonly label;
+    constructor(name: string, opts: MetricOptions);
+    update(values: Record<string, number>): void;
+    increment(values: Record<string, number | unknown>): void;
+    decrement(values: Record<string, number | unknown>): void;
+    reset(): void;
+    timer(key: string): StopTimer;
+}
+//# sourceMappingURL=metric-group.d.ts.map

package/dist/src/metric-group.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric-group.d.ts","sourceRoot":"","sources":["../../src/metric-group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAItF,qBAAa,qBAAsB,YAAW,WAAW;IACvD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;IAC7B,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;gBAEjB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa;IAY9C,MAAM,CAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI;IAM7C,SAAS,CAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI;IAQ1D,SAAS,CAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI;IAQ1D,KAAK,IAAK,IAAI;IAId,KAAK,CAAE,GAAG,EAAE,MAAM,GAAG,SAAS;CAK/B"}

package/dist/src/metric-group.js

@@ -0,0 +1,40 @@
+import { Gauge } from 'prom-client';
+import { normaliseString } from './utils.js';
+export class PrometheusMetricGroup {
+    constructor(name, opts) {
+        name = normaliseString(name);
+        const help = normaliseString(opts.help ?? name);
+        this.label = normaliseString(opts.label ?? name);
+        this.gauge = new Gauge({
+            name,
+            help,
+            labelNames: [this.label]
+        });
+    }
+    update(values) {
+        Object.entries(values).forEach(([key, value]) => {
+            this.gauge.set({ [this.label]: key }, value);
+        });
+    }
+    increment(values) {
+        Object.entries(values).forEach(([key, value]) => {
+            const inc = typeof value === 'number' ? value : 1;
+            this.gauge.inc({ [this.label]: key }, inc);
+        });
+    }
+    decrement(values) {
+        Object.entries(values).forEach(([key, value]) => {
+            const dec = typeof value === 'number' ? value : 1;
+            this.gauge.dec({ [this.label]: key }, dec);
+        });
+    }
+    reset() {
+        this.gauge.reset();
+    }
+    timer(key) {
+        return this.gauge.startTimer({
+            key: 0
+        });
+    }
+}
+//# sourceMappingURL=metric-group.js.map

package/dist/src/metric-group.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric-group.js","sourceRoot":"","sources":["../../src/metric-group.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,OAAO,qBAAqB;IAIhC,YAAa,IAAY,EAAE,IAAmB;QAC5C,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;QAC5B,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAA;QAC/C,IAAI,CAAC,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;QAEhD,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC;YACrB,IAAI;YACJ,IAAI;YACJ,UAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;SACzB,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAE,MAA8B;QACpC,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,KAAK,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,SAAS,CAAE,MAAwC;QACjD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9C,MAAM,GAAG,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAEjD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC,CAAA;QAC5C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,SAAS,CAAE,MAAwC;QACjD,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;YAC9C,MAAM,GAAG,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAA;YAEjD,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC,CAAA;QAC5C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;IACpB,CAAC;IAED,KAAK,CAAE,GAAW;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC;YAC3B,GAAG,EAAE,CAAC;SACP,CAAC,CAAA;IACJ,CAAC;CACF"}

package/dist/src/metric.d.ts

@@ -0,0 +1,11 @@
+import type { Metric, MetricOptions, StopTimer } from '@libp2p/interface-metrics';
+export declare class PrometheusMetric implements Metric {
+    private readonly gauge;
+    constructor(name: string, opts: MetricOptions);
+    update(value: number): void;
+    increment(value?: number): void;
+    decrement(value?: number): void;
+    reset(): void;
+    timer(): StopTimer;
+}
+//# sourceMappingURL=metric.d.ts.map

package/dist/src/metric.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric.d.ts","sourceRoot":"","sources":["../../src/metric.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAIjF,qBAAa,gBAAiB,YAAW,MAAM;IAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;gBAEhB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,aAAa;IAY9C,MAAM,CAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAI5B,SAAS,CAAE,KAAK,SAAI,GAAG,IAAI;IAI3B,SAAS,CAAE,KAAK,SAAI,GAAG,IAAI;IAI3B,KAAK,IAAK,IAAI;IAId,KAAK,IAAK,SAAS;CAGpB"}

package/dist/src/metric.js

@@ -0,0 +1,30 @@
+import { Gauge } from 'prom-client';
+import { normaliseString } from './utils.js';
+export class PrometheusMetric {
+    constructor(name, opts) {
+        name = normaliseString(name);
+        const help = normaliseString(opts.help ?? name);
+        const label = opts.label != null ? normaliseString(opts.label) : undefined;
+        this.gauge = new Gauge({
+            name,
+            help,
+            labelNames: label != null ? [label] : []
+        });
+    }
+    update(value) {
+        this.gauge.set(value);
+    }
+    increment(value = 1) {
+        this.gauge.inc(value);
+    }
+    decrement(value = 1) {
+        this.gauge.dec(value);
+    }
+    reset() {
+        this.gauge.reset();
+    }
+    timer() {
+        return this.gauge.startTimer();
+    }
+}
+//# sourceMappingURL=metric.js.map

package/dist/src/metric.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metric.js","sourceRoot":"","sources":["../../src/metric.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAA;AACnC,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,OAAO,gBAAgB;IAG3B,YAAa,IAAY,EAAE,IAAmB;QAC5C,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;QAC5B,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAA;QAC/C,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QAE1E,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC;YACrB,IAAI;YACJ,IAAI;YACJ,UAAU,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;SACzC,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAE,KAAa;QACnB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,SAAS,CAAE,KAAK,GAAG,CAAC;QAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,SAAS,CAAE,KAAK,GAAG,CAAC;QAClB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;IACpB,CAAC;IAED,KAAK;QACH,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAA;IAChC,CAAC;CACF"}

package/dist/src/moving-average.d.ts

@@ -0,0 +1,20 @@
+export interface MovingAverage {
+    variance: number;
+    movingAverage: number;
+    deviation: number;
+    forecast: number;
+    push: (time: number, value: number) => void;
+}
+export declare class DefaultMovingAverage {
+    movingAverage: number;
+    variance: number;
+    deviation: number;
+    forecast: number;
+    private readonly timespan;
+    private previousTime?;
+    constructor(timespan: number);
+    alpha(t: number, pt: number): number;
+    push(time: number, value: number): void;
+}
+export declare function createMovingAverage(timespan: number): MovingAverage;
+//# sourceMappingURL=moving-average.d.ts.map

package/dist/src/moving-average.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moving-average.d.ts","sourceRoot":"","sources":["../../src/moving-average.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;IACrB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IAEhB,IAAI,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;CAC5C;AAED,qBAAa,oBAAoB;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,QAAQ,EAAE,MAAM,CAAA;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,YAAY,CAAC,CAAQ;gBAEhB,QAAQ,EAAE,MAAM;IAgB7B,KAAK,CAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM;IAI5B,IAAI,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;CAkBlC;AAED,wBAAgB,mBAAmB,CAAE,QAAQ,EAAE,MAAM,GAAG,aAAa,CAEpE"}

package/dist/src/moving-average.js

@@ -0,0 +1,40 @@
+export class DefaultMovingAverage {
+    constructor(timespan) {
+        if (typeof timespan !== 'number') {
+            throw new Error('must provide a timespan to the moving average constructor');
+        }
+        if (timespan <= 0) {
+            throw new Error('must provide a timespan > 0 to the moving average constructor');
+        }
+        this.timespan = timespan;
+        this.movingAverage = 0;
+        this.variance = 0;
+        this.deviation = 0;
+        this.forecast = 0;
+    }
+    alpha(t, pt) {
+        return 1 - (Math.exp(-(t - pt) / this.timespan));
+    }
+    push(time, value) {
+        if (this.previousTime != null) {
+            // calculate moving average
+            const a = this.alpha(time, this.previousTime);
+            const diff = value - this.movingAverage;
+            const incr = a * diff;
+            this.movingAverage = a * value + (1 - a) * this.movingAverage;
+            // calculate variance & deviation
+            this.variance = (1 - a) * (this.variance + diff * incr);
+            this.deviation = Math.sqrt(this.variance);
+            // calculate forecast
+            this.forecast = this.movingAverage + a * diff;
+        }
+        else {
+            this.movingAverage = value;
+        }
+        this.previousTime = time;
+    }
+}
+export function createMovingAverage(timespan) {
+    return new DefaultMovingAverage(timespan);
+}
+//# sourceMappingURL=moving-average.js.map

package/dist/src/moving-average.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moving-average.js","sourceRoot":"","sources":["../../src/moving-average.ts"],"names":[],"mappings":"AASA,MAAM,OAAO,oBAAoB;IAQ/B,YAAa,QAAgB;QAC3B,IAAI,OAAO,QAAQ,KAAK,QAAQ,EAAE;YAChC,MAAM,IAAI,KAAK,CAAC,2DAA2D,CAAC,CAAA;SAC7E;QAED,IAAI,QAAQ,IAAI,CAAC,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC,CAAA;SACjF;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAA;QACtB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;QACjB,IAAI,CAAC,SAAS,GAAG,CAAC,CAAA;QAClB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAA;IACnB,CAAC;IAED,KAAK,CAAE,CAAS,EAAE,EAAU;QAC1B,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;IAClD,CAAC;IAED,IAAI,CAAE,IAAY,EAAE,KAAa;QAC/B,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,EAAE;YAC7B,2BAA2B;YAC3B,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAA;YAC7C,MAAM,IAAI,GAAG,KAAK,GAAG,IAAI,CAAC,aAAa,CAAA;YACvC,MAAM,IAAI,GAAG,CAAC,GAAG,IAAI,CAAA;YACrB,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,aAAa,CAAA;YAC7D,iCAAiC;YACjC,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,IAAI,CAAC,CAAA;YACvD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;YACzC,qBAAqB;YACrB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,aAAa,GAAG,CAAC,GAAG,IAAI,CAAA;SAC9C;aAAM;YACL,IAAI,CAAC,aAAa,GAAG,KAAK,CAAA;SAC3B;QAED,IAAI,CAAC,YAAY,GAAG,IAAI,CAAA;IAC1B,CAAC;CACF;AAED,MAAM,UAAU,mBAAmB,CAAE,QAAgB;IACnD,OAAO,IAAI,oBAAoB,CAAC,QAAQ,CAAC,CAAA;AAC3C,CAAC"}

package/dist/src/utils.d.ts

@@ -0,0 +1,4 @@
+export declare const ONE_SECOND = 1000;
+export declare const ONE_MINUTE: number;
+export declare function normaliseString(str: string): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/src/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,UAAU,OAAO,CAAA;AAC9B,eAAO,MAAM,UAAU,QAAkB,CAAA;AAEzC,wBAAgB,eAAe,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAEpD"}

package/dist/src/utils.js

@@ -0,0 +1,6 @@
+export const ONE_SECOND = 1000;
+export const ONE_MINUTE = 60 * ONE_SECOND;
+export function normaliseString(str) {
+    return str.replace(/-/g, '_');
+}
+//# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../src/utils.ts"],"names":[],"mappings":"AACA,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAA;AAC9B,MAAM,CAAC,MAAM,UAAU,GAAG,EAAE,GAAG,UAAU,CAAA;AAEzC,MAAM,UAAU,eAAe,CAAE,GAAW;IAC1C,OAAO,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAA;AAC/B,CAAC"}

package/package.json

@@ -0,0 +1,155 @@
+{
+  "name": "@libp2p/prometheus-metrics",
+  "version": "0.0.0",
+  "description": "Collect libp2p metrics for scraping by Prometheus",
+  "author": "",
+  "license": "Apache-2.0 OR MIT",
+  "homepage": "https://github.com/libp2p/js-libp2p-prometheus-metrics#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/libp2p/js-libp2p-prometheus-metrics.git"
+  },
+  "bugs": {
+    "url": "https://github.com/libp2p/js-libp2p-prometheus-metrics/issues"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  },
+  "type": "module",
+  "types": "./dist/src/index.d.ts",
+  "files": [
+    "src",
+    "dist/src",
+    "!dist/test",
+    "!**/*.tsbuildinfo"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/src/index.d.ts",
+      "import": "./dist/src/index.js"
+    }
+  },
+  "eslintConfig": {
+    "extends": "ipfs",
+    "parserOptions": {
+      "sourceType": "module"
+    }
+  },
+  "release": {
+    "branches": [
+      "main"
+    ],
+    "plugins": [
+      [
+        "@semantic-release/commit-analyzer",
+        {
+          "preset": "conventionalcommits",
+          "releaseRules": [
+            {
+              "breaking": true,
+              "release": "major"
+            },
+            {
+              "revert": true,
+              "release": "patch"
+            },
+            {
+              "type": "feat",
+              "release": "minor"
+            },
+            {
+              "type": "fix",
+              "release": "patch"
+            },
+            {
+              "type": "docs",
+              "release": "patch"
+            },
+            {
+              "type": "test",
+              "release": "patch"
+            },
+            {
+              "type": "deps",
+              "release": "patch"
+            },
+            {
+              "scope": "no-release",
+              "release": false
+            }
+          ]
+        }
+      ],
+      [
+        "@semantic-release/release-notes-generator",
+        {
+          "preset": "conventionalcommits",
+          "presetConfig": {
+            "types": [
+              {
+                "type": "feat",
+                "section": "Features"
+              },
+              {
+                "type": "fix",
+                "section": "Bug Fixes"
+              },
+              {
+                "type": "chore",
+                "section": "Trivial Changes"
+              },
+              {
+                "type": "docs",
+                "section": "Documentation"
+              },
+              {
+                "type": "deps",
+                "section": "Dependencies"
+              },
+              {
+                "type": "test",
+                "section": "Tests"
+              }
+            ]
+          }
+        }
+      ],
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ]
+  },
+  "scripts": {
+    "clean": "aegir clean",
+    "lint": "aegir lint",
+    "dep-check": "aegir dep-check",
+    "build": "aegir build",
+    "test": "aegir test -t node",
+    "test:node": "aegir test -t node --cov",
+    "test:electron-main": "aegir test -t electron-main --cov",
+    "release": "aegir release"
+  },
+  "dependencies": {
+    "@libp2p/interface-metrics": "^3.0.0",
+    "@libp2p/metrics": "^0.0.0",
+    "it-drain": "^2.0.0",
+    "it-pipe": "^2.0.4"
+  },
+  "peerDependencies": {
+    "prom-client": "^14.1.0"
+  },
+  "devDependencies": {
+    "@libp2p/interface-connection": "^3.0.2",
+    "@libp2p/interface-mocks": "^7.0.3",
+    "@libp2p/peer-id-factory": "^1.0.19",
+    "@multiformats/multiaddr": "^11.0.7",
+    "aegir": "^37.5.6",
+    "it-pair": "^2.0.3",
+    "it-stream-types": "^1.0.4",
+    "p-defer": "^4.0.0",
+    "prom-client": "^14.1.0",
+    "uint8arraylist": "^2.3.3"
+  }
+}

package/src/index.ts

@@ -0,0 +1,135 @@
+import type { CalculatedMetricOptions, CalculateMetric, Metric, MetricGroup, MetricOptions, Metrics } from '@libp2p/interface-metrics'
+import type { Startable } from '@libp2p/interfaces/startable'
+import { Gauge, CollectFunction, collectDefaultMetrics, DefaultMetricsCollectorConfiguration, register } from 'prom-client'
+import { PrometheusMetric } from './metric.js'
+import { PrometheusMetricGroup } from './metric-group.js'
+import { DefaultMetrics, DefaultMetricsInit } from '@libp2p/metrics'
+
+export interface PrometheusMetricsInit extends DefaultMetricsInit {
+  defaultMetrics?: DefaultMetricsCollectorConfiguration
+  preserveExistingMetrics?: boolean
+  collectDefaultMetrics?: boolean
+}
+
+class PrometheusMetrics extends DefaultMetrics implements Metrics, Startable {
+  constructor (init?: Partial<PrometheusMetricsInit>) {
+    super(init)
+
+    if (init?.preserveExistingMetrics !== true) {
+      // all metrics in prometheus are global so it's necessary to remove
+      // existing metrics to make sure we don't error when setting up metrics
+      register.clear()
+    }
+
+    if (init?.preserveExistingMetrics !== false) {
+      // collect memory/CPU and node-specific default metrics
+      collectDefaultMetrics(init?.defaultMetrics)
+    }
+
+    this.registerMetricGroup('libp2p_data_transfer_bytes', {
+      label: 'protocol',
+      calculate: () => {
+        const output: Record<string, number> = {}
+
+        const global = this.getGlobal().getSnapshot()
+        output['global sent'] = Number(global.dataSent)
+        output['global received'] = Number(global.dataReceived)
+
+        for (const protocol of this.getProtocols()) {
+          const stats = this.forProtocol(protocol)
+
+          if (stats == null) {
+            continue
+          }
+
+          const snapshot = stats.getSnapshot()
+          output[`${protocol} sent`] = Number(snapshot.dataSent)
+          output[`${protocol} received`] = Number(snapshot.dataReceived)
+        }
+
+        return output
+      }
+    })
+
+    this.registerMetricGroup('nodejs_memory_usage_bytes', {
+      label: 'memory',
+      calculate: () => {
+        return {
+          ...process.memoryUsage()
+        }
+      }
+    })
+  }
+
+  registerMetric (name: string, opts: CalculatedMetricOptions): void
+  registerMetric (name: string, opts?: MetricOptions): Metric
+  registerMetric (name: string, opts: any): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Metric name is required')
+    }
+
+    if (opts?.calculate != null) {
+      const calculate = opts.calculate
+
+      // calculated metric
+      const collect: CollectFunction<Gauge<any>> = async function () {
+        const value = await calculate()
+
+        this.set(value)
+      }
+
+      // prom-client metrics are global
+      new Gauge({ // eslint-disable-line no-new
+        name,
+        help: opts.help ?? name,
+        labelNames: [opts.label ?? name],
+        collect
+      })
+
+      return
+    }
+
+    return new PrometheusMetric(name, opts ?? {})
+  }
+
+  registerMetricGroup (name: string, opts: CalculatedMetricOptions<Record<string, number>>): void
+  registerMetricGroup (name: string, opts?: MetricOptions): MetricGroup
+  registerMetricGroup (name: string, opts: any): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Metric name is required')
+    }
+
+    if (opts?.calculate != null) {
+      // calculated metric
+      const calculate: CalculateMetric<Record<string, number>> = opts.calculate
+      const label = opts.label ?? name
+
+      // calculated metric
+      const collect: CollectFunction<Gauge<any>> = async function () {
+        const values = await calculate()
+
+        Object.entries(values).forEach(([key, value]) => {
+          this.set({ [label]: key }, value)
+        })
+      }
+
+      // prom-client metrics are global
+      new Gauge({ // eslint-disable-line no-new
+        name,
+        help: opts.help ?? name,
+        labelNames: [opts.label ?? name],
+        collect
+      })
+
+      return
+    }
+
+    return new PrometheusMetricGroup(name, opts ?? {})
+  }
+}
+
+export function prometheusMetrics (init?: Partial<PrometheusMetricsInit>): () => Metrics {
+  return () => {
+    return new PrometheusMetrics(init)
+  }
+}

package/src/metric-group.ts

@@ -0,0 +1,52 @@
+import type { MetricOptions, MetricGroup, StopTimer } from '@libp2p/interface-metrics'
+import { Gauge } from 'prom-client'
+import { normaliseString } from './utils.js'
+
+export class PrometheusMetricGroup implements MetricGroup {
+  private readonly gauge: Gauge
+  private readonly label: string
+
+  constructor (name: string, opts: MetricOptions) {
+    name = normaliseString(name)
+    const help = normaliseString(opts.help ?? name)
+    this.label = normaliseString(opts.label ?? name)
+
+    this.gauge = new Gauge({
+      name,
+      help,
+      labelNames: [this.label]
+    })
+  }
+
+  update (values: Record<string, number>): void {
+    Object.entries(values).forEach(([key, value]) => {
+      this.gauge.set({ [this.label]: key }, value)
+    })
+  }
+
+  increment (values: Record<string, number | unknown>): void {
+    Object.entries(values).forEach(([key, value]) => {
+      const inc = typeof value === 'number' ? value : 1
+
+      this.gauge.inc({ [this.label]: key }, inc)
+    })
+  }
+
+  decrement (values: Record<string, number | unknown>): void {
+    Object.entries(values).forEach(([key, value]) => {
+      const dec = typeof value === 'number' ? value : 1
+
+      this.gauge.dec({ [this.label]: key }, dec)
+    })
+  }
+
+  reset (): void {
+    this.gauge.reset()
+  }
+
+  timer (key: string): StopTimer {
+    return this.gauge.startTimer({
+      key: 0
+    })
+  }
+}

package/src/metric.ts

@@ -0,0 +1,39 @@
+import type { Metric, MetricOptions, StopTimer } from '@libp2p/interface-metrics'
+import { Gauge } from 'prom-client'
+import { normaliseString } from './utils.js'
+
+export class PrometheusMetric implements Metric {
+  private readonly gauge: Gauge
+
+  constructor (name: string, opts: MetricOptions) {
+    name = normaliseString(name)
+    const help = normaliseString(opts.help ?? name)
+    const label = opts.label != null ? normaliseString(opts.label) : undefined
+
+    this.gauge = new Gauge({
+      name,
+      help,
+      labelNames: label != null ? [label] : []
+    })
+  }
+
+  update (value: number): void {
+    this.gauge.set(value)
+  }
+
+  increment (value = 1): void {
+    this.gauge.inc(value)
+  }
+
+  decrement (value = 1): void {
+    this.gauge.dec(value)
+  }
+
+  reset (): void {
+    this.gauge.reset()
+  }
+
+  timer (): StopTimer {
+    return this.gauge.startTimer()
+  }
+}

package/src/utils.ts

@@ -0,0 +1,7 @@
+
+export const ONE_SECOND = 1000
+export const ONE_MINUTE = 60 * ONE_SECOND
+
+export function normaliseString (str: string): string {
+  return str.replace(/-/g, '_')
+}