@libp2p/prometheus-metrics 0.0.0 → 1.0.1

package/README.md

@@ -5,11 +5,18 @@
 [![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
+> Collect libp2p metrics for scraping by Prometheus or Graphana
 
 ## Table of contents <!-- omit in toc -->
 
 - [Install](#install)
+- [Usage](#usage)
+  - [Queries](#queries)
+    - [Data sent/received](#data-sentreceived)
+    - [CPU usage](#cpu-usage)
+    - [Memory usage](#memory-usage)
+    - [DHT query time](#dht-query-time)
+    - [TCP transport dialer errors](#tcp-transport-dialer-errors)
 - [License](#license)
 - [Contribute](#contribute)
 
@@ -19,6 +26,60 @@
 $ npm i @libp2p/prometheus-metrics
 ```
 
+## Usage
+
+Configure your libp2p node with Prometheus metrics:
+
+```js
+import { createLibp2p } from 'libp2p'
+import { prometheusMetrics } from '@libp2p/prometheus-metrics'
+
+const node = await createLibp2p({
+  metrics: prometheusMetrics()
+})
+```
+
+Then use the `prom-client` module to supply metrics to the Prometheus/Graphana client using your http framework:
+
+```js
+import client from 'prom-client'
+
+async handler (request, h) {
+  return h.response(await client.register.metrics())
+    .type(client.register.contentType)
+}
+```
+
+All Prometheus metrics are global so there's no other work required to extract them.
+
+### Queries
+
+Some useful queries are:
+
+#### Data sent/received
+
+    rate(libp2p_data_transfer_bytes_total[30s])
+
+#### CPU usage
+
+    rate(process_cpu_user_seconds_total[30s]) * 100
+
+#### Memory usage
+
+    nodejs_memory_usage_bytes
+
+#### DHT query time
+
+    libp2p_kad_dht_wan_query_time_seconds
+
+or
+
+    libp2p_kad_dht_lan_query_time_seconds
+
+#### TCP transport dialer errors
+
+    rate(libp2p_tcp_dialer_errors_total[30s])
+
 ## License
 
 Licensed under either of

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

@@ -0,0 +1,9 @@
+import type { CounterGroup, CalculatedMetricOptions } from '@libp2p/interface-metrics';
+export declare class PrometheusCounterGroup implements CounterGroup {
+    private readonly counter;
+    private readonly label;
+    constructor(name: string, opts: CalculatedMetricOptions<Record<string, number>>);
+    increment(values: Record<string, number | unknown>): void;
+    reset(): void;
+}
+//# sourceMappingURL=counter-group.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"counter-group.d.ts","sourceRoot":"","sources":["../../src/counter-group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,uBAAuB,EAAmB,MAAM,2BAA2B,CAAA;AAIvG,qBAAa,sBAAuB,YAAW,YAAY;IACzD,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;IACrC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAQ;gBAEjB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IA2BhF,SAAS,CAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,GAAG,IAAI;IAQ1D,KAAK,IAAK,IAAI;CAGf"}

package/dist/src/counter-group.js

@@ -0,0 +1,36 @@
+import { Counter as PromCounter } from 'prom-client';
+import { normaliseString } from './utils.js';
+export class PrometheusCounterGroup {
+    constructor(name, opts) {
+        name = normaliseString(name);
+        const help = normaliseString(opts.help ?? name);
+        const label = this.label = normaliseString(opts.label ?? name);
+        let collect;
+        // calculated metric
+        if (opts?.calculate != null) {
+            const calculate = opts.calculate;
+            collect = async function () {
+                const values = await calculate();
+                Object.entries(values).forEach(([key, value]) => {
+                    this.inc({ [label]: key }, value);
+                });
+            };
+        }
+        this.counter = new PromCounter({
+            name,
+            help,
+            labelNames: [this.label],
+            collect
+        });
+    }
+    increment(values) {
+        Object.entries(values).forEach(([key, value]) => {
+            const inc = typeof value === 'number' ? value : 1;
+            this.counter.inc({ [this.label]: key }, inc);
+        });
+    }
+    reset() {
+        this.counter.reset();
+    }
+}
+//# sourceMappingURL=counter-group.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"counter-group.js","sourceRoot":"","sources":["../../src/counter-group.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,OAAO,IAAI,WAAW,EAAmB,MAAM,aAAa,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,OAAO,sBAAsB;IAIjC,YAAa,IAAY,EAAE,IAAqD;QAC9E,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,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;QAC9D,IAAI,OAAsD,CAAA;QAE1D,oBAAoB;QACpB,IAAI,IAAI,EAAE,SAAS,IAAI,IAAI,EAAE;YAC3B,MAAM,SAAS,GAA4C,IAAI,CAAC,SAAS,CAAA;YAEzE,OAAO,GAAG,KAAK;gBACb,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;SACF;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC;YAC7B,IAAI;YACJ,IAAI;YACJ,UAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACxB,OAAO;SACR,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,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,EAAE,GAAG,CAAC,CAAA;QAC9C,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;CACF"}

package/dist/src/counter.d.ts

@@ -0,0 +1,8 @@
+import type { Counter, CalculatedMetricOptions } from '@libp2p/interface-metrics';
+export declare class PrometheusCounter implements Counter {
+    private readonly counter;
+    constructor(name: string, opts: CalculatedMetricOptions);
+    increment(value?: number): void;
+    reset(): void;
+}
+//# sourceMappingURL=counter.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"counter.d.ts","sourceRoot":"","sources":["../../src/counter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAA;AAIjF,qBAAa,iBAAkB,YAAW,OAAO;IAC/C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAa;gBAExB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB;IAyBxD,SAAS,CAAE,KAAK,GAAE,MAAU,GAAG,IAAI;IAInC,KAAK,IAAK,IAAI;CAGf"}

package/dist/src/counter.js

@@ -0,0 +1,31 @@
+import { Counter as PromCounter } from 'prom-client';
+import { normaliseString } from './utils.js';
+export class PrometheusCounter {
+    constructor(name, opts) {
+        name = normaliseString(name);
+        const help = normaliseString(opts.help ?? name);
+        const labels = opts.label != null ? [normaliseString(opts.label)] : [];
+        let collect;
+        // calculated metric
+        if (opts?.calculate != null) {
+            const calculate = opts.calculate;
+            collect = async function () {
+                const value = await calculate();
+                this.inc(value);
+            };
+        }
+        this.counter = new PromCounter({
+            name,
+            help,
+            labelNames: labels,
+            collect
+        });
+    }
+    increment(value = 1) {
+        this.counter.inc(value);
+    }
+    reset() {
+        this.counter.reset();
+    }
+}
+//# sourceMappingURL=counter.js.map

package/dist/src/counter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"counter.js","sourceRoot":"","sources":["../../src/counter.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,OAAO,IAAI,WAAW,EAAE,MAAM,aAAa,CAAA;AACrE,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,OAAO,iBAAiB;IAG5B,YAAa,IAAY,EAAE,IAA6B;QACtD,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;QAC5B,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACtE,IAAI,OAAsD,CAAA;QAE1D,oBAAoB;QACpB,IAAI,IAAI,EAAE,SAAS,IAAI,IAAI,EAAE;YAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;YAEhC,OAAO,GAAG,KAAK;gBACb,MAAM,KAAK,GAAG,MAAM,SAAS,EAAE,CAAA;gBAE/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CAAA;SACF;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,WAAW,CAAC;YAC7B,IAAI;YACJ,IAAI;YACJ,UAAU,EAAE,MAAM;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,SAAS,CAAE,QAAgB,CAAC;QAC1B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACzB,CAAC;IAED,KAAK;QACH,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;CACF"}

package/dist/src/index.d.ts

@@ -1,10 +1,21 @@
 import type { Metrics } from '@libp2p/interface-metrics';
 import { DefaultMetricsCollectorConfiguration } from 'prom-client';
-import { DefaultMetricsInit } from '@libp2p/metrics';
-export interface PrometheusMetricsInit extends DefaultMetricsInit {
+export interface PrometheusMetricsInit {
+    /**
+     * By default we collect default metrics - CPU, memory etc, to not do
+     * this, pass true here
+     */
+    collectDefaultMetrics?: boolean;
+    /**
+     * prom-client options to pass to the `collectDefaultMetrics` function
+     */
     defaultMetrics?: DefaultMetricsCollectorConfiguration;
+    /**
+     * All metrics in prometheus are global so to prevent clashes in naming
+     * we reset the global metrics registry on creation - to not do this,
+     * pass true here
+     */
     preserveExistingMetrics?: boolean;
-    collectDefaultMetrics?: boolean;
 }
 export declare function prometheusMetrics(init?: Partial<PrometheusMetricsInit>): () => Metrics;
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +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"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAsF,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAC5I,OAAO,EAAyB,oCAAoC,EAAY,MAAM,aAAa,CAAA;AAYnG,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAE/B;;OAEG;IACH,cAAc,CAAC,EAAE,oCAAoC,CAAA;IAErD;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;CAClC;AAwJD,wBAAgB,iBAAiB,CAAE,IAAI,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,GAAG,MAAM,OAAO,CAIvF"}

package/dist/src/index.js

@@ -1,38 +1,37 @@
-import { Gauge, collectDefaultMetrics, register } from 'prom-client';
+import { collectDefaultMetrics, register } from 'prom-client';
+import each from 'it-foreach';
 import { PrometheusMetric } from './metric.js';
 import { PrometheusMetricGroup } from './metric-group.js';
-import { DefaultMetrics } from '@libp2p/metrics';
-class PrometheusMetrics extends DefaultMetrics {
+import { PrometheusCounter } from './counter.js';
+import { PrometheusCounterGroup } from './counter-group.js';
+import { logger } from '@libp2p/logger';
+const log = logger('libp2p:prometheus-metrics');
+class PrometheusMetrics {
     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
+            log('Clearing existing metrics');
             register.clear();
         }
         if (init?.preserveExistingMetrics !== false) {
-            // collect memory/CPU and node-specific default metrics
+            log('Collecting default metrics');
             collectDefaultMetrics(init?.defaultMetrics);
         }
-        this.registerMetricGroup('libp2p_data_transfer_bytes', {
+        // holds global and per-protocol sent/received stats
+        this.transferStats = new Map();
+        log('Collecting data transfer metrics');
+        this.registerCounterGroup('libp2p_data_transfer_bytes_total', {
             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);
+                for (const [key, value] of this.transferStats.entries()) {
+                    output[key] = value;
                 }
+                // reset counts for next time
+                this.transferStats = new Map();
                 return output;
             }
         });
+        log('Collecting memory metrics');
         this.registerMetricGroup('nodejs_memory_usage_bytes', {
             label: 'memory',
             calculate: () => {
@@ -42,53 +41,81 @@ class PrometheusMetrics extends DefaultMetrics {
             }
         });
     }
-    registerMetric(name, opts) {
+    /**
+     * Increment the transfer stat for the passed key, making sure
+     * it exists first
+     */
+    _incrementValue(key, value) {
+        const existing = this.transferStats.get(key) ?? 0;
+        this.transferStats.set(key, existing + value);
+    }
+    /**
+     * Override the sink/source of the stream to count the bytes
+     * in and out
+     */
+    _track(stream, name) {
+        const self = this;
+        const sink = stream.sink;
+        stream.sink = async function trackedSink(source) {
+            await sink(each(source, buf => {
+                self._incrementValue(`${name} sent`, buf.byteLength);
+            }));
+        };
+        const source = stream.source;
+        stream.source = each(source, buf => {
+            self._incrementValue(`${name} received`, buf.byteLength);
+        });
+    }
+    trackMultiaddrConnection(maConn) {
+        this._track(maConn, 'global');
+    }
+    trackProtocolStream(stream, connection) {
+        if (stream.stat.protocol == null) {
+            // protocol not negotiated yet, should not happen as the upgrader
+            // calls this handler after protocol negotiation
+            return;
+        }
+        this._track(stream, stream.stat.protocol);
+    }
+    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;
+        log('Register metric', name);
+        const metric = new PrometheusMetric(name, opts ?? {});
+        if (opts.calculate == null) {
+            return metric;
         }
-        return new PrometheusMetric(name, opts ?? {});
     }
-    registerMetricGroup(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;
+        log('Register metric group', name);
+        const group = new PrometheusMetricGroup(name, opts ?? {});
+        if (opts.calculate == null) {
+            return group;
+        }
+    }
+    registerCounter(name, opts = {}) {
+        if (name == null ?? name.trim() === '') {
+            throw new Error('Counter name is required');
+        }
+        log('Register counter', name);
+        const counter = new PrometheusCounter(name, opts);
+        if (opts.calculate == null) {
+            return counter;
+        }
+    }
+    registerCounterGroup(name, opts = {}) {
+        if (name == null ?? name.trim() === '') {
+            throw new Error('Metric name is required');
+        }
+        log('Register counter group', name);
+        const group = new PrometheusCounterGroup(name, opts);
+        if (opts.calculate == null) {
+            return group;
         }
-        return new PrometheusMetricGroup(name, opts ?? {});
     }
 }
 export function prometheusMetrics(init) {

package/dist/src/index.js.map

@@ -1 +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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,qBAAqB,EAAwC,QAAQ,EAAE,MAAM,aAAa,CAAA;AAGnG,OAAO,IAAI,MAAM,YAAY,CAAA;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAA;AAChD,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAC3D,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAA;AAEvC,MAAM,GAAG,GAAG,MAAM,CAAC,2BAA2B,CAAC,CAAA;AAsB/C,MAAM,iBAAiB;IAGrB,YAAa,IAAqC;QAChD,IAAI,IAAI,EAAE,uBAAuB,KAAK,IAAI,EAAE;YAC1C,GAAG,CAAC,2BAA2B,CAAC,CAAA;YAChC,QAAQ,CAAC,KAAK,EAAE,CAAA;SACjB;QAED,IAAI,IAAI,EAAE,uBAAuB,KAAK,KAAK,EAAE;YAC3C,GAAG,CAAC,4BAA4B,CAAC,CAAA;YACjC,qBAAqB,CAAC,IAAI,EAAE,cAAc,CAAC,CAAA;SAC5C;QAED,oDAAoD;QACpD,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAA;QAE9B,GAAG,CAAC,kCAAkC,CAAC,CAAA;QACvC,IAAI,CAAC,oBAAoB,CAAC,kCAAkC,EAAE;YAC5D,KAAK,EAAE,UAAU;YACjB,SAAS,EAAE,GAAG,EAAE;gBACd,MAAM,MAAM,GAA2B,EAAE,CAAA;gBAEzC,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,EAAE;oBACvD,MAAM,CAAC,GAAG,CAAC,GAAG,KAAK,CAAA;iBACpB;gBAED,6BAA6B;gBAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAA;gBAE9B,OAAO,MAAM,CAAA;YACf,CAAC;SACF,CAAC,CAAA;QAEF,GAAG,CAAC,2BAA2B,CAAC,CAAA;QAChC,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;IAED;;;OAGG;IACH,eAAe,CAAE,GAAW,EAAE,KAAa;QACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAEjD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,GAAG,KAAK,CAAC,CAAA;IAC/C,CAAC;IAED;;;OAGG;IACH,MAAM,CAAE,MAAmB,EAAE,IAAY;QACvC,MAAM,IAAI,GAAG,IAAI,CAAA;QAEjB,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACxB,MAAM,CAAC,IAAI,GAAG,KAAK,UAAU,WAAW,CAAE,MAAM;YAC9C,MAAM,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;gBAC5B,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,OAAO,EAAE,GAAG,CAAC,UAAU,CAAC,CAAA;YACtD,CAAC,CAAC,CAAC,CAAA;QACL,CAAC,CAAA;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE;YACjC,IAAI,CAAC,eAAe,CAAC,GAAG,IAAI,WAAW,EAAE,GAAG,CAAC,UAAU,CAAC,CAAA;QAC1D,CAAC,CAAC,CAAA;IACJ,CAAC;IAED,wBAAwB,CAAE,MAA2B;QACnD,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAA;IAC/B,CAAC;IAED,mBAAmB,CAAE,MAAc,EAAE,UAAsB;QACzD,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,IAAI,IAAI,EAAE;YAChC,iEAAiE;YACjE,gDAAgD;YAChD,OAAM;SACP;QAED,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;IAC3C,CAAC;IAID,cAAc,CAAE,IAAY,EAAE,OAAY,EAAE;QAC1C,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC3C;QAED,GAAG,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAA;QAC5B,MAAM,MAAM,GAAG,IAAI,gBAAgB,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;QAErD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YAC1B,OAAO,MAAM,CAAA;SACd;IACH,CAAC;IAID,mBAAmB,CAAE,IAAY,EAAE,OAAY,EAAE;QAC/C,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC3C;QAED,GAAG,CAAC,uBAAuB,EAAE,IAAI,CAAC,CAAA;QAClC,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,IAAI,EAAE,CAAC,CAAA;QAEzD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YAC1B,OAAO,KAAK,CAAA;SACb;IACH,CAAC;IAID,eAAe,CAAE,IAAY,EAAE,OAAY,EAAE;QAC3C,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;SAC5C;QAED,GAAG,CAAC,kBAAkB,EAAE,IAAI,CAAC,CAAA;QAC7B,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAEjD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YAC1B,OAAO,OAAO,CAAA;SACf;IACH,CAAC;IAID,oBAAoB,CAAE,IAAY,EAAE,OAAY,EAAE;QAChD,IAAI,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACtC,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;SAC3C;QAED,GAAG,CAAC,wBAAwB,EAAE,IAAI,CAAC,CAAA;QACnC,MAAM,KAAK,GAAG,IAAI,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAEpD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,EAAE;YAC1B,OAAO,KAAK,CAAA;SACb;IACH,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

@@ -1,8 +1,8 @@
-import type { MetricOptions, MetricGroup, StopTimer } from '@libp2p/interface-metrics';
+import type { CalculatedMetricOptions, MetricGroup, StopTimer } from '@libp2p/interface-metrics';
 export declare class PrometheusMetricGroup implements MetricGroup {
     private readonly gauge;
     private readonly label;
-    constructor(name: string, opts: MetricOptions);
+    constructor(name: string, opts: CalculatedMetricOptions<Record<string, number>>);
     update(values: Record<string, number>): void;
     increment(values: Record<string, number | unknown>): void;
     decrement(values: Record<string, number | unknown>): void;

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

@@ -1 +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"}
+{"version":3,"file":"metric-group.d.ts","sourceRoot":"","sources":["../../src/metric-group.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,uBAAuB,EAAmB,WAAW,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAIjH,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,uBAAuB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IA2BhF,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

@@ -4,11 +4,23 @@ export class PrometheusMetricGroup {
     constructor(name, opts) {
         name = normaliseString(name);
         const help = normaliseString(opts.help ?? name);
-        this.label = normaliseString(opts.label ?? name);
+        const label = this.label = normaliseString(opts.label ?? name);
+        let collect;
+        // calculated metric
+        if (opts?.calculate != null) {
+            const calculate = opts.calculate;
+            collect = async function () {
+                const values = await calculate();
+                Object.entries(values).forEach(([key, value]) => {
+                    this.set({ [label]: key }, value);
+                });
+            };
+        }
         this.gauge = new Gauge({
             name,
             help,
-            labelNames: [this.label]
+            labelNames: [this.label],
+            collect
         });
     }
     update(values) {

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

@@ -1 +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"}
+{"version":3,"file":"metric-group.js","sourceRoot":"","sources":["../../src/metric-group.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,KAAK,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,OAAO,qBAAqB;IAIhC,YAAa,IAAY,EAAE,IAAqD;QAC9E,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,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAA;QAC9D,IAAI,OAAgD,CAAA;QAEpD,oBAAoB;QACpB,IAAI,IAAI,EAAE,SAAS,IAAI,IAAI,EAAE;YAC3B,MAAM,SAAS,GAA4C,IAAI,CAAC,SAAS,CAAA;YAEzE,OAAO,GAAG,KAAK;gBACb,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;SACF;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC;YACrB,IAAI;YACJ,IAAI;YACJ,UAAU,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC;YACxB,OAAO;SACR,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

@@ -1,7 +1,7 @@
-import type { Metric, MetricOptions, StopTimer } from '@libp2p/interface-metrics';
+import type { Metric, CalculatedMetricOptions, StopTimer } from '@libp2p/interface-metrics';
 export declare class PrometheusMetric implements Metric {
     private readonly gauge;
-    constructor(name: string, opts: MetricOptions);
+    constructor(name: string, opts: CalculatedMetricOptions);
     update(value: number): void;
     increment(value?: number): void;
     decrement(value?: number): void;

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

@@ -1 +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"}
+{"version":3,"file":"metric.d.ts","sourceRoot":"","sources":["../../src/metric.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,EAAE,uBAAuB,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAA;AAI3F,qBAAa,gBAAiB,YAAW,MAAM;IAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAO;gBAEhB,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,uBAAuB;IAyBxD,MAAM,CAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAI5B,SAAS,CAAE,KAAK,GAAE,MAAU,GAAG,IAAI;IAInC,SAAS,CAAE,KAAK,GAAE,MAAU,GAAG,IAAI;IAInC,KAAK,IAAK,IAAI;IAId,KAAK,IAAK,SAAS;CAGpB"}

package/dist/src/metric.js

@@ -4,11 +4,21 @@ export class PrometheusMetric {
     constructor(name, opts) {
         name = normaliseString(name);
         const help = normaliseString(opts.help ?? name);
-        const label = opts.label != null ? normaliseString(opts.label) : undefined;
+        const labels = opts.label != null ? [normaliseString(opts.label)] : [];
+        let collect;
+        // calculated metric
+        if (opts?.calculate != null) {
+            const calculate = opts.calculate;
+            collect = async function () {
+                const value = await calculate();
+                this.set(value);
+            };
+        }
         this.gauge = new Gauge({
             name,
             help,
-            labelNames: label != null ? [label] : []
+            labelNames: labels,
+            collect
         });
     }
     update(value) {

package/dist/src/metric.js.map

@@ -1 +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"}
+{"version":3,"file":"metric.js","sourceRoot":"","sources":["../../src/metric.ts"],"names":[],"mappings":"AACA,OAAO,EAAmB,KAAK,EAAE,MAAM,aAAa,CAAA;AACpD,OAAO,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5C,MAAM,OAAO,gBAAgB;IAG3B,YAAa,IAAY,EAAE,IAA6B;QACtD,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,CAAA;QAC5B,MAAM,IAAI,GAAG,eAAe,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,CAAA;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;QACtE,IAAI,OAAgD,CAAA;QAEpD,oBAAoB;QACpB,IAAI,IAAI,EAAE,SAAS,IAAI,IAAI,EAAE;YAC3B,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAA;YAEhC,OAAO,GAAG,KAAK;gBACb,MAAM,KAAK,GAAG,MAAM,SAAS,EAAE,CAAA;gBAE/B,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;YACjB,CAAC,CAAA;SACF;QAED,IAAI,CAAC,KAAK,GAAG,IAAI,KAAK,CAAC;YACrB,IAAI;YACJ,IAAI;YACJ,UAAU,EAAE,MAAM;YAClB,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED,MAAM,CAAE,KAAa;QACnB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,SAAS,CAAE,QAAgB,CAAC;QAC1B,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,CAAA;IACvB,CAAC;IAED,SAAS,CAAE,QAAgB,CAAC;QAC1B,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/utils.d.ts

@@ -1,4 +1,8 @@
 export declare const ONE_SECOND = 1000;
 export declare const ONE_MINUTE: number;
+/**
+ * See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
+ * for rules on valid naming
+ */
 export declare function normaliseString(str: string): string;
 //# sourceMappingURL=utils.d.ts.map

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

@@ -1 +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"}
+{"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;;;GAGG;AACH,wBAAgB,eAAe,CAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAIpD"}

package/dist/src/utils.js

@@ -1,6 +1,12 @@
 export const ONE_SECOND = 1000;
 export const ONE_MINUTE = 60 * ONE_SECOND;
+/**
+ * See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
+ * for rules on valid naming
+ */
 export function normaliseString(str) {
-    return str.replace(/-/g, '_');
+    return str
+        .replace(/[^a-zA-Z0-9_]/g, '_')
+        .replace(/_+/g, '_');
 }
 //# sourceMappingURL=utils.js.map

package/dist/src/utils.js.map

@@ -1 +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"}
+{"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;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAE,GAAW;IAC1C,OAAO,GAAG;SACP,OAAO,CAAC,gBAAgB,EAAE,GAAG,CAAC;SAC9B,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAA;AACxB,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@libp2p/prometheus-metrics",
-  "version": "0.0.0",
-  "description": "Collect libp2p metrics for scraping by Prometheus",
+  "version": "1.0.1",
+  "description": "Collect libp2p metrics for scraping by Prometheus or Graphana",
   "author": "",
   "license": "Apache-2.0 OR MIT",
   "homepage": "https://github.com/libp2p/js-libp2p-prometheus-metrics#readme",
@@ -132,24 +132,25 @@
     "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"
+    "@libp2p/interface-connection": "^3.0.2",
+    "@libp2p/interface-metrics": "^4.0.2",
+    "@libp2p/logger": "^2.0.2",
+    "it-foreach": "^1.0.0",
+    "it-stream-types": "^1.0.4"
   },
   "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-drain": "^2.0.0",
     "it-pair": "^2.0.3",
-    "it-stream-types": "^1.0.4",
+    "it-pipe": "^2.0.4",
     "p-defer": "^4.0.0",
     "prom-client": "^14.1.0",
     "uint8arraylist": "^2.3.3"
+  },
+  "peerDependencies": {
+    "prom-client": "^14.1.0"
   }
 }

package/src/counter-group.ts

@@ -0,0 +1,47 @@
+import type { CounterGroup, CalculatedMetricOptions, CalculateMetric } from '@libp2p/interface-metrics'
+import { Counter as PromCounter, CollectFunction } from 'prom-client'
+import { normaliseString } from './utils.js'
+
+export class PrometheusCounterGroup implements CounterGroup {
+  private readonly counter: PromCounter
+  private readonly label: string
+
+  constructor (name: string, opts: CalculatedMetricOptions<Record<string, number>>) {
+    name = normaliseString(name)
+    const help = normaliseString(opts.help ?? name)
+    const label = this.label = normaliseString(opts.label ?? name)
+    let collect: CollectFunction<PromCounter<any>> | undefined
+
+    // calculated metric
+    if (opts?.calculate != null) {
+      const calculate: CalculateMetric<Record<string, number>> = opts.calculate
+
+      collect = async function () {
+        const values = await calculate()
+
+        Object.entries(values).forEach(([key, value]) => {
+          this.inc({ [label]: key }, value)
+        })
+      }
+    }
+
+    this.counter = new PromCounter({
+      name,
+      help,
+      labelNames: [this.label],
+      collect
+    })
+  }
+
+  increment (values: Record<string, number | unknown>): void {
+    Object.entries(values).forEach(([key, value]) => {
+      const inc = typeof value === 'number' ? value : 1
+
+      this.counter.inc({ [this.label]: key }, inc)
+    })
+  }
+
+  reset (): void {
+    this.counter.reset()
+  }
+}

package/src/counter.ts

@@ -0,0 +1,40 @@
+import type { Counter, CalculatedMetricOptions } from '@libp2p/interface-metrics'
+import { CollectFunction, Counter as PromCounter } from 'prom-client'
+import { normaliseString } from './utils.js'
+
+export class PrometheusCounter implements Counter {
+  private readonly counter: PromCounter
+
+  constructor (name: string, opts: CalculatedMetricOptions) {
+    name = normaliseString(name)
+    const help = normaliseString(opts.help ?? name)
+    const labels = opts.label != null ? [normaliseString(opts.label)] : []
+    let collect: CollectFunction<PromCounter<any>> | undefined
+
+    // calculated metric
+    if (opts?.calculate != null) {
+      const calculate = opts.calculate
+
+      collect = async function () {
+        const value = await calculate()
+
+        this.inc(value)
+      }
+    }
+
+    this.counter = new PromCounter({
+      name,
+      help,
+      labelNames: labels,
+      collect
+    })
+  }
+
+  increment (value: number = 1): void {
+    this.counter.inc(value)
+  }
+
+  reset (): void {
+    this.counter.reset()
+  }
+}

package/src/index.ts

@@ -1,56 +1,71 @@
-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 type { CalculatedMetricOptions, Counter, CounterGroup, Metric, MetricGroup, MetricOptions, Metrics } from '@libp2p/interface-metrics'
+import { collectDefaultMetrics, DefaultMetricsCollectorConfiguration, register } from 'prom-client'
+import type { MultiaddrConnection, Stream, Connection } from '@libp2p/interface-connection'
+import type { Duplex } from 'it-stream-types'
+import each from 'it-foreach'
 import { PrometheusMetric } from './metric.js'
 import { PrometheusMetricGroup } from './metric-group.js'
-import { DefaultMetrics, DefaultMetricsInit } from '@libp2p/metrics'
+import { PrometheusCounter } from './counter.js'
+import { PrometheusCounterGroup } from './counter-group.js'
+import { logger } from '@libp2p/logger'
 
-export interface PrometheusMetricsInit extends DefaultMetricsInit {
+const log = logger('libp2p:prometheus-metrics')
+
+export interface PrometheusMetricsInit {
+  /**
+   * By default we collect default metrics - CPU, memory etc, to not do
+   * this, pass true here
+   */
+  collectDefaultMetrics?: boolean
+
+  /**
+   * prom-client options to pass to the `collectDefaultMetrics` function
+   */
   defaultMetrics?: DefaultMetricsCollectorConfiguration
+
+  /**
+   * All metrics in prometheus are global so to prevent clashes in naming
+   * we reset the global metrics registry on creation - to not do this,
+   * pass true here
+   */
   preserveExistingMetrics?: boolean
-  collectDefaultMetrics?: boolean
 }
 
-class PrometheusMetrics extends DefaultMetrics implements Metrics, Startable {
-  constructor (init?: Partial<PrometheusMetricsInit>) {
-    super(init)
+class PrometheusMetrics implements Metrics {
+  private transferStats: Map<string, number>
 
+  constructor (init?: Partial<PrometheusMetricsInit>) {
     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
+      log('Clearing existing metrics')
       register.clear()
     }
 
     if (init?.preserveExistingMetrics !== false) {
-      // collect memory/CPU and node-specific default metrics
+      log('Collecting default metrics')
       collectDefaultMetrics(init?.defaultMetrics)
     }
 
-    this.registerMetricGroup('libp2p_data_transfer_bytes', {
+    // holds global and per-protocol sent/received stats
+    this.transferStats = new Map()
+
+    log('Collecting data transfer metrics')
+    this.registerCounterGroup('libp2p_data_transfer_bytes_total', {
       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)
+        for (const [key, value] of this.transferStats.entries()) {
+          output[key] = value
         }
 
+        // reset counts for next time
+        this.transferStats = new Map()
+
         return output
       }
     })
 
+    log('Collecting memory metrics')
     this.registerMetricGroup('nodejs_memory_usage_bytes', {
       label: 'memory',
       calculate: () => {
@@ -61,70 +76,108 @@ class PrometheusMetrics extends DefaultMetrics implements Metrics, Startable {
     })
   }
 
-  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')
-    }
+  /**
+   * Increment the transfer stat for the passed key, making sure
+   * it exists first
+   */
+  _incrementValue (key: string, value: number) {
+    const existing = this.transferStats.get(key) ?? 0
 
-    if (opts?.calculate != null) {
-      const calculate = opts.calculate
+    this.transferStats.set(key, existing + value)
+  }
 
-      // calculated metric
-      const collect: CollectFunction<Gauge<any>> = async function () {
-        const value = await calculate()
+  /**
+   * Override the sink/source of the stream to count the bytes
+   * in and out
+   */
+  _track (stream: Duplex<any>, name: string) {
+    const self = this
+
+    const sink = stream.sink
+    stream.sink = async function trackedSink (source) {
+      await sink(each(source, buf => {
+        self._incrementValue(`${name} sent`, buf.byteLength)
+      }))
+    }
 
-        this.set(value)
-      }
+    const source = stream.source
+    stream.source = each(source, buf => {
+      self._incrementValue(`${name} received`, buf.byteLength)
+    })
+  }
 
-      // prom-client metrics are global
-      new Gauge({ // eslint-disable-line no-new
-        name,
-        help: opts.help ?? name,
-        labelNames: [opts.label ?? name],
-        collect
-      })
+  trackMultiaddrConnection (maConn: MultiaddrConnection): void {
+    this._track(maConn, 'global')
+  }
 
+  trackProtocolStream (stream: Stream, connection: Connection): void {
+    if (stream.stat.protocol == null) {
+      // protocol not negotiated yet, should not happen as the upgrader
+      // calls this handler after protocol negotiation
       return
     }
 
-    return new PrometheusMetric(name, opts ?? {})
+    this._track(stream, stream.stat.protocol)
+  }
+
+  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')
+    }
+
+    log('Register metric', name)
+    const metric = new PrometheusMetric(name, opts ?? {})
+
+    if (opts.calculate == null) {
+      return metric
+    }
   }
 
   registerMetricGroup (name: string, opts: CalculatedMetricOptions<Record<string, number>>): void
   registerMetricGroup (name: string, opts?: MetricOptions): MetricGroup
-  registerMetricGroup (name: string, opts: any): any {
+  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
+    log('Register metric group', name)
+    const group = new PrometheusMetricGroup(name, opts ?? {})
 
-      // calculated metric
-      const collect: CollectFunction<Gauge<any>> = async function () {
-        const values = await calculate()
+    if (opts.calculate == null) {
+      return group
+    }
+  }
 
-        Object.entries(values).forEach(([key, value]) => {
-          this.set({ [label]: key }, value)
-        })
-      }
+  registerCounter (name: string, opts: CalculatedMetricOptions): void
+  registerCounter (name: string, opts?: MetricOptions): Counter
+  registerCounter (name: string, opts: any = {}): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Counter name is required')
+    }
 
-      // prom-client metrics are global
-      new Gauge({ // eslint-disable-line no-new
-        name,
-        help: opts.help ?? name,
-        labelNames: [opts.label ?? name],
-        collect
-      })
+    log('Register counter', name)
+    const counter = new PrometheusCounter(name, opts)
 
-      return
+    if (opts.calculate == null) {
+      return counter
     }
+  }
 
-    return new PrometheusMetricGroup(name, opts ?? {})
+  registerCounterGroup (name: string, opts: CalculatedMetricOptions<Record<string, number>>): void
+  registerCounterGroup (name: string, opts?: MetricOptions): CounterGroup
+  registerCounterGroup (name: string, opts: any = {}): any {
+    if (name == null ?? name.trim() === '') {
+      throw new Error('Metric name is required')
+    }
+
+    log('Register counter group', name)
+    const group = new PrometheusCounterGroup(name, opts)
+
+    if (opts.calculate == null) {
+      return group
+    }
   }
 }
 

package/src/metric-group.ts

@@ -1,20 +1,35 @@
-import type { MetricOptions, MetricGroup, StopTimer } from '@libp2p/interface-metrics'
-import { Gauge } from 'prom-client'
+import type { CalculatedMetricOptions, CalculateMetric, MetricGroup, StopTimer } from '@libp2p/interface-metrics'
+import { CollectFunction, 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) {
+  constructor (name: string, opts: CalculatedMetricOptions<Record<string, number>>) {
     name = normaliseString(name)
     const help = normaliseString(opts.help ?? name)
-    this.label = normaliseString(opts.label ?? name)
+    const label = this.label = normaliseString(opts.label ?? name)
+    let collect: CollectFunction<Gauge<any>> | undefined
+
+    // calculated metric
+    if (opts?.calculate != null) {
+      const calculate: CalculateMetric<Record<string, number>> = opts.calculate
+
+      collect = async function () {
+        const values = await calculate()
+
+        Object.entries(values).forEach(([key, value]) => {
+          this.set({ [label]: key }, value)
+        })
+      }
+    }
 
     this.gauge = new Gauge({
       name,
       help,
-      labelNames: [this.label]
+      labelNames: [this.label],
+      collect
     })
   }
 

package/src/metric.ts

@@ -1,19 +1,32 @@
-import type { Metric, MetricOptions, StopTimer } from '@libp2p/interface-metrics'
-import { Gauge } from 'prom-client'
+import type { Metric, CalculatedMetricOptions, StopTimer } from '@libp2p/interface-metrics'
+import { CollectFunction, Gauge } from 'prom-client'
 import { normaliseString } from './utils.js'
 
 export class PrometheusMetric implements Metric {
   private readonly gauge: Gauge
 
-  constructor (name: string, opts: MetricOptions) {
+  constructor (name: string, opts: CalculatedMetricOptions) {
     name = normaliseString(name)
     const help = normaliseString(opts.help ?? name)
-    const label = opts.label != null ? normaliseString(opts.label) : undefined
+    const labels = opts.label != null ? [normaliseString(opts.label)] : []
+    let collect: CollectFunction<Gauge<any>> | undefined
+
+    // calculated metric
+    if (opts?.calculate != null) {
+      const calculate = opts.calculate
+
+      collect = async function () {
+        const value = await calculate()
+
+        this.set(value)
+      }
+    }
 
     this.gauge = new Gauge({
       name,
       help,
-      labelNames: label != null ? [label] : []
+      labelNames: labels,
+      collect
     })
   }
 
@@ -21,11 +34,11 @@ export class PrometheusMetric implements Metric {
     this.gauge.set(value)
   }
 
-  increment (value = 1): void {
+  increment (value: number = 1): void {
     this.gauge.inc(value)
   }
 
-  decrement (value = 1): void {
+  decrement (value: number = 1): void {
     this.gauge.dec(value)
   }
 

package/src/utils.ts

@@ -2,6 +2,12 @@
 export const ONE_SECOND = 1000
 export const ONE_MINUTE = 60 * ONE_SECOND
 
+/**
+ * See https://prometheus.io/docs/concepts/data_model/#metric-names-and-labels
+ * for rules on valid naming
+ */
 export function normaliseString (str: string): string {
-  return str.replace(/-/g, '_')
+  return str
+    .replace(/[^a-zA-Z0-9_]/g, '_')
+    .replace(/_+/g, '_')
 }

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

@@ -1,20 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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

@@ -1,40 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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"}