libp2p 0.36.2 → 0.37.0

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

@@ -1,112 +1,77 @@
-export = Metrics;
-/**
- * @typedef {import('peer-id')} PeerId
- * @typedef {import('libp2p-interfaces/src/transport/types').MultiaddrConnection} MultiaddrConnection
- */
-/**
- * @typedef MetricsOptions
- * @property {number} [computeThrottleMaxQueueSize = defaultOptions.computeThrottleMaxQueueSize]
- * @property {number} [computeThrottleTimeout = defaultOptions.computeThrottleTimeout]
- * @property {number[]} [movingAverageIntervals = defaultOptions.movingAverageIntervals]
- * @property {number} [maxOldPeersRetention = defaultOptions.maxOldPeersRetention]
- */
-declare class Metrics {
-    /**
-     * Merges `other` into `target`. `target` will be modified
-     * and returned.
-     *
-     * @param {Stats} target
-     * @param {Stats} other
-     * @returns {Stats}
-     */
-    static mergeStats(target: Stats, other: Stats): Stats;
-    /**
-     * @class
-     * @param {MetricsOptions} options
-     */
-    constructor(options: MetricsOptions);
-    _options: any;
-    _globalStats: Stats;
-    _peerStats: Map<any, any>;
-    _protocolStats: Map<any, any>;
-    _oldPeers: any;
-    _running: boolean;
-    /**
-     * Takes the metadata for a message and tracks it in the
-     * appropriate categories. If the protocol is present, protocol
-     * stats will also be tracked.
-     *
-     * @private
-     * @param {object} params
-     * @param {PeerId} params.remotePeer - Remote peer
-     * @param {string} [params.protocol] - Protocol string the stream is running
-     * @param {string} params.direction - One of ['in','out']
-     * @param {number} params.dataLength - Size of the message
-     * @returns {void}
-     */
-    private _onMessage;
-    _systems: Map<any, any>;
+import { DefaultStats } from './stats.js';
+import type { ComponentMetricsUpdate, Metrics, Stats, TrackStreamOptions } from '@libp2p/interfaces/metrics';
+import type { PeerId } from '@libp2p/interfaces/peer-id';
+import type { Startable } from '@libp2p/interfaces/startable';
+import type { Duplex } from 'it-stream-types';
+export interface OnMessageOptions {
+    remotePeer: PeerId;
+    protocol?: string;
+    direction: 'in' | 'out';
+    dataLength: number;
+}
+export interface MetricsInit {
+    enabled: boolean;
+    computeThrottleMaxQueueSize: number;
+    computeThrottleTimeout: number;
+    movingAverageIntervals: number[];
+    maxOldPeersRetention: number;
+}
+export declare class DefaultMetrics implements Metrics, Startable {
+    globalStats: DefaultStats;
+    private readonly enabled;
+    private readonly peerStats;
+    private readonly protocolStats;
+    private readonly oldPeers;
+    private running;
+    private readonly systems;
+    private readonly statsInit;
+    constructor(init: MetricsInit);
+    isStarted(): boolean;
     /**
      * Must be called for stats to saved. Any data pushed for tracking
      * will be ignored.
      */
-    start(): void;
+    start(): Promise<void>;
     /**
      * Stops all averages timers and prevents new data from being tracked.
      * Once `stop` is called, `start` must be called to resume stats tracking.
      */
-    stop(): void;
+    stop(): Promise<void>;
     /**
      * Gets the global `Stats` object
-     *
-     * @returns {Stats}
      */
-    get global(): Stats;
+    getGlobal(): DefaultStats;
     /**
      * Returns a list of `PeerId` strings currently being tracked
-     *
-     * @returns {string[]}
      */
-    get peers(): string[];
-    /**
-     * @returns {Map<string, Map<string, Map<string, any>>>}
-     */
-    getComponentMetrics(): Map<string, Map<string, Map<string, any>>>;
-    updateComponentMetric({ system, component, metric, value }: {
-        system?: string | undefined;
-        component: any;
-        metric: any;
-        value: any;
-    }): void;
+    getPeers(): string[];
+    getComponentMetrics(): Map<string, Map<string, Map<string, number>>>;
+    updateComponentMetric(update: ComponentMetricsUpdate): void;
     /**
      * Returns the `Stats` object for the given `PeerId` whether it
      * is a live peer, or in the disconnected peer LRU cache.
-     *
-     * @param {PeerId} peerId
-     * @returns {Stats}
      */
-    forPeer(peerId: PeerId): Stats;
+    forPeer(peerId: PeerId): Stats | undefined;
     /**
-     * Returns a list of all protocol strings currently being tracked.
-     *
-     * @returns {string[]}
+     * Returns a list of all protocol strings currently being tracked
      */
-    get protocols(): string[];
+    getProtocols(): string[];
     /**
-     * Returns the `Stats` object for the given `protocol`.
-     *
-     * @param {string} protocol
-     * @returns {Stats}
+     * Returns the `Stats` object for the given `protocol`
      */
-    forProtocol(protocol: string): Stats;
+    forProtocol(protocol: string): Stats | undefined;
     /**
      * Should be called when all connections to a given peer
      * have closed. The `Stats` collection for the peer will
      * be stopped and moved to an LRU for temporary retention.
-     *
-     * @param {PeerId} peerId
      */
     onPeerDisconnected(peerId: PeerId): void;
+    /**
+     * Takes the metadata for a message and tracks it in the
+     * appropriate categories. If the protocol is present, protocol
+     * stats will also be tracked.
+     */
+    _onMessage(opts: OnMessageOptions): void;
     /**
      * Replaces the `PeerId` string with the given `peerId`.
      * If stats are already being tracked for the given `peerId`, the
@@ -123,29 +88,7 @@ declare class Metrics {
      * returned. This allows lazy tracking of a peer when the peer is not yet known.
      * When the `PeerId` is known, `Metrics.updatePlaceholder` should be called
      * with the placeholder string returned from here, and the known `PeerId`.
-     *
-     * @param {Object} options
-     * @param {MultiaddrConnection} options.stream - A duplex iterable stream
-     * @param {PeerId} [options.remotePeer] - The id of the remote peer that's connected
-     * @param {string} [options.protocol] - The protocol the stream is running
-     * @returns {MultiaddrConnection} The peerId string or placeholder string
      */
-    trackStream({ stream, remotePeer, protocol }: {
-        stream: MultiaddrConnection;
-        remotePeer?: import("peer-id") | undefined;
-        protocol?: string | undefined;
-    }): MultiaddrConnection;
-}
-declare namespace Metrics {
-    export { PeerId, MultiaddrConnection, MetricsOptions };
+    trackStream<T extends Duplex<Uint8Array>>(opts: TrackStreamOptions<T>): T;
 }
-import Stats = require("./stats");
-type PeerId = import('peer-id');
-type MultiaddrConnection = import('libp2p-interfaces/src/transport/types').MultiaddrConnection;
-type MetricsOptions = {
-    computeThrottleMaxQueueSize?: number | undefined;
-    computeThrottleTimeout?: number | undefined;
-    movingAverageIntervals?: number[] | undefined;
-    maxOldPeersRetention?: number | undefined;
-};
 //# sourceMappingURL=index.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/metrics/index.js"],"names":[],"mappings":";AAoBA;;;GAGG;AAEH;;;;;;GAMG;AAEH;IA4OE;;;;;;;OAOG;IACH,0BAJW,KAAK,SACL,KAAK,GACH,KAAK,CAWjB;IA5PD;;;OAGG;IACH,qBAFW,cAAc,EAWxB;IARC,cAAqD;IACrD,oBAA6D;IAC7D,0BAA2B;IAC3B,8BAA+B;IAC/B,eAA+D;IAC/D,kBAAqB;IAqHvB;;;;;;;;;;;;OAYG;IACH,mBAwBC;IAxJC,wBAAyB;IAG3B;;;OAGG;IACH,cAEC;IAED;;;OAGG;IACH,aASC;IAED;;;;OAIG;IACH,oBAEC;IAED;;;;OAIG;IACH,sBAEC;IAED;;OAEG;IACH,uBAFa,IAAI,MAAM,EAAE,IAAI,MAAM,EAAE,IAAI,MAAM,EAAE,GAAG,CAAC,CAAC,CAAC,CAItD;IAED;;;;;aAcC;IAED;;;;;;OAMG;IACH,gBAHW,MAAM,GACJ,KAAK,CAKjB;IAED;;;;OAIG;IACH,0BAEC;IAED;;;;;OAKG;IACH,sBAHW,MAAM,GACJ,KAAK,CAIjB;IAED;;;;;;OAMG;IACH,2BAFW,MAAM,QAUhB;IAyCD;;;;;;;;OAQG;IACH,+BAJW,MAAM,UACN,MAAM,GACJ,IAAI,CAoBhB;IAED;;;;;;;;;;;;OAYG;IACH;QALwC,MAAM,EAAnC,mBAAmB;QACF,UAAU;QACV,QAAQ;QACvB,mBAAmB,CA2B/B;CAoBF;;;;;cA1QY,OAAO,SAAS,CAAC;2BACjB,OAAO,uCAAuC,EAAE,mBAAmB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/metrics/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,YAAY,EAAa,MAAM,YAAY,CAAA;AACpD,OAAO,KAAK,EAAE,sBAAsB,EAAE,OAAO,EAAE,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC5G,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAA;AACxD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAA;AAC7D,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,iBAAiB,CAAA;AAY7C,MAAM,WAAW,gBAAgB;IAC/B,UAAU,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,SAAS,EAAE,IAAI,GAAG,KAAK,CAAA;IACvB,UAAU,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,OAAO,CAAA;IAChB,2BAA2B,EAAE,MAAM,CAAA;IACnC,sBAAsB,EAAE,MAAM,CAAA;IAC9B,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAChC,oBAAoB,EAAE,MAAM,CAAA;CAC7B;AAED,qBAAa,cAAe,YAAW,OAAO,EAAE,SAAS;IAChD,WAAW,EAAE,YAAY,CAAA;IAEhC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA2B;IACrD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA2B;IACzD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAwB;IACjD,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAA+C;IACvE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAW;gBAExB,IAAI,EAAE,WAAW;IAe9B,SAAS;IAIT;;;OAGG;IACG,KAAK;IAQX;;;OAGG;IACG,IAAI;IAiBV;;OAEG;IACH,SAAS;IAIT;;OAEG;IACH,QAAQ;IAIR,mBAAmB;IAInB,qBAAqB,CAAE,MAAM,EAAE,sBAAsB;IA0BrD;;;OAGG;IACH,OAAO,CAAE,MAAM,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAK3C;;OAEG;IACH,YAAY,IAAK,MAAM,EAAE;IAIzB;;OAEG;IACH,WAAW,CAAE,QAAQ,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS;IAIjD;;;;OAIG;IACH,kBAAkB,CAAE,MAAM,EAAE,MAAM;IAYlC;;;;OAIG;IACH,UAAU,CAAE,IAAI,EAAE,gBAAgB;IAkClC;;;;;;;;OAQG;IACH,iBAAiB,CAAE,WAAW,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM;IAwBtD;;;;;;OAMG;IACH,WAAW,CAAE,CAAC,SAAS,MAAM,CAAC,UAAU,CAAC,EAAG,IAAI,EAAE,kBAAkB,CAAC,CAAC,CAAC,GAAG,CAAC;CAiC5E"}

package/dist/src/metrics/index.js

@@ -0,0 +1,231 @@
+import { pipe } from 'it-pipe';
+import each from 'it-foreach';
+import LRU from 'hashlru';
+import { METRICS as defaultOptions } from '../constants.js';
+import { DefaultStats } from './stats.js';
+const initialCounters = [
+    'dataReceived',
+    'dataSent'
+];
+const directionToEvent = {
+    in: 'dataReceived',
+    out: 'dataSent'
+};
+export class DefaultMetrics {
+    constructor(init) {
+        this.enabled = init.enabled;
+        this.statsInit = {
+            ...init,
+            initialCounters
+        };
+        this.globalStats = new DefaultStats(this.statsInit);
+        this.peerStats = new Map();
+        this.protocolStats = new Map();
+        this.oldPeers = LRU(init.maxOldPeersRetention ?? defaultOptions.maxOldPeersRetention);
+        this.running = false;
+        this._onMessage = this._onMessage.bind(this);
+        this.systems = new Map();
+    }
+    isStarted() {
+        return this.running;
+    }
+    /**
+     * Must be called for stats to saved. Any data pushed for tracking
+     * will be ignored.
+     */
+    async start() {
+        if (!this.enabled) {
+            return;
+        }
+        this.running = true;
+    }
+    /**
+     * Stops all averages timers and prevents new data from being tracked.
+     * Once `stop` is called, `start` must be called to resume stats tracking.
+     */
+    async stop() {
+        if (!this.running) {
+            return;
+        }
+        this.running = false;
+        this.globalStats.stop();
+        for (const stats of this.peerStats.values()) {
+            stats.stop();
+        }
+        for (const stats of this.protocolStats.values()) {
+            stats.stop();
+        }
+    }
+    /**
+     * Gets the global `Stats` object
+     */
+    getGlobal() {
+        return this.globalStats;
+    }
+    /**
+     * Returns a list of `PeerId` strings currently being tracked
+     */
+    getPeers() {
+        return Array.from(this.peerStats.keys());
+    }
+    getComponentMetrics() {
+        return this.systems;
+    }
+    updateComponentMetric(update) {
+        const { system = 'libp2p', component, metric, value } = update;
+        if (!this.systems.has(system)) {
+            this.systems.set(system, new Map());
+        }
+        const systemMetrics = this.systems.get(system);
+        if (systemMetrics == null) {
+            throw new Error('Unknown metric system');
+        }
+        if (!systemMetrics.has(component)) {
+            systemMetrics.set(component, new Map());
+        }
+        const componentMetrics = systemMetrics.get(component);
+        if (componentMetrics == null) {
+            throw new Error('Unknown metric component');
+        }
+        componentMetrics.set(metric, value);
+    }
+    /**
+     * Returns the `Stats` object for the given `PeerId` whether it
+     * is a live peer, or in the disconnected peer LRU cache.
+     */
+    forPeer(peerId) {
+        const idString = peerId.toString();
+        return this.peerStats.get(idString) ?? this.oldPeers.get(idString);
+    }
+    /**
+     * Returns a list of all protocol strings currently being tracked
+     */
+    getProtocols() {
+        return Array.from(this.protocolStats.keys());
+    }
+    /**
+     * Returns the `Stats` object for the given `protocol`
+     */
+    forProtocol(protocol) {
+        return this.protocolStats.get(protocol);
+    }
+    /**
+     * Should be called when all connections to a given peer
+     * have closed. The `Stats` collection for the peer will
+     * be stopped and moved to an LRU for temporary retention.
+     */
+    onPeerDisconnected(peerId) {
+        const idString = peerId.toString();
+        const peerStats = this.peerStats.get(idString);
+        if (peerStats != null) {
+            peerStats.stop();
+            this.peerStats.delete(idString);
+            this.oldPeers.set(idString, peerStats);
+        }
+    }
+    /**
+     * Takes the metadata for a message and tracks it in the
+     * appropriate categories. If the protocol is present, protocol
+     * stats will also be tracked.
+     */
+    _onMessage(opts) {
+        if (!this.running) {
+            return;
+        }
+        const { remotePeer, protocol, direction, dataLength } = opts;
+        const key = directionToEvent[direction];
+        let peerStats = this.forPeer(remotePeer);
+        if (peerStats == null) {
+            const stats = new DefaultStats(this.statsInit);
+            this.peerStats.set(remotePeer.toString(), stats);
+            peerStats = stats;
+        }
+        // Peer and global stats
+        peerStats.push(key, dataLength);
+        this.globalStats.push(key, dataLength);
+        // Protocol specific stats
+        if (protocol != null) {
+            let protocolStats = this.forProtocol(protocol);
+            if (protocolStats == null) {
+                const stats = new DefaultStats(this.statsInit);
+                this.protocolStats.set(protocol, stats);
+                protocolStats = stats;
+            }
+            protocolStats.push(key, dataLength);
+        }
+    }
+    /**
+     * Replaces the `PeerId` string with the given `peerId`.
+     * If stats are already being tracked for the given `peerId`, the
+     * placeholder stats will be merged with the existing stats.
+     *
+     * @param {PeerId} placeholder - A peerId string
+     * @param {PeerId} peerId
+     * @returns {void}
+     */
+    updatePlaceholder(placeholder, peerId) {
+        if (!this.running) {
+            return;
+        }
+        const placeholderString = placeholder.toString();
+        const placeholderStats = this.peerStats.get(placeholderString) ?? this.oldPeers.get(placeholderString);
+        const peerIdString = peerId.toString();
+        const existingStats = this.peerStats.get(peerIdString) ?? this.oldPeers.get(peerIdString);
+        let mergedStats = placeholderStats;
+        // If we already have stats, merge the two
+        if (existingStats != null) {
+            // If existing, merge
+            mergedStats = mergeStats(existingStats, mergedStats);
+            // Attempt to delete from the old peers list just in case it was tracked there
+            this.oldPeers.remove(peerIdString);
+        }
+        this.peerStats.delete(placeholder.toString());
+        this.peerStats.set(peerIdString, mergedStats);
+        mergedStats.start();
+    }
+    /**
+     * Tracks data running through a given Duplex Iterable `stream`. If
+     * the `peerId` is not provided, a placeholder string will be created and
+     * returned. This allows lazy tracking of a peer when the peer is not yet known.
+     * When the `PeerId` is known, `Metrics.updatePlaceholder` should be called
+     * with the placeholder string returned from here, and the known `PeerId`.
+     */
+    trackStream(opts) {
+        const { stream, remotePeer, protocol } = opts;
+        if (!this.running) {
+            return stream;
+        }
+        const source = stream.source;
+        stream.source = each(source, chunk => this._onMessage({
+            remotePeer,
+            protocol,
+            direction: 'in',
+            dataLength: chunk.length
+        }));
+        const sink = stream.sink;
+        stream.sink = async (source) => {
+            return await pipe(source, (source) => each(source, chunk => {
+                this._onMessage({
+                    remotePeer,
+                    protocol,
+                    direction: 'out',
+                    dataLength: chunk.length
+                });
+            }), sink);
+        };
+        return stream;
+    }
+}
+/**
+ * Merges `other` into `target`. `target` will be modified
+ * and returned
+ */
+function mergeStats(target, other) {
+    target.stop();
+    other.stop();
+    // Merge queues
+    target.queue = [...target.queue, ...other.queue];
+    // TODO: how to merge moving averages?
+    return target;
+}
+//# sourceMappingURL=index.js.map

package/dist/src/metrics/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/metrics/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,SAAS,CAAA;AAC9B,OAAO,IAAI,MAAM,YAAY,CAAA;AAC7B,OAAO,GAAG,MAAM,SAAS,CAAA;AACzB,OAAO,EAAE,OAAO,IAAI,cAAc,EAAE,MAAM,iBAAiB,CAAA;AAC3D,OAAO,EAAE,YAAY,EAAa,MAAM,YAAY,CAAA;AAMpD,MAAM,eAAe,GAAiC;IACpD,cAAc;IACd,UAAU;CACX,CAAA;AAED,MAAM,gBAAgB,GAAG;IACvB,EAAE,EAAE,cAAc;IAClB,GAAG,EAAE,UAAU;CAChB,CAAA;AAiBD,MAAM,OAAO,cAAc;IAWzB,YAAa,IAAiB;QAC5B,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,SAAS,GAAG;YACf,GAAG,IAAI;YACP,eAAe;SAChB,CAAA;QACD,IAAI,CAAC,WAAW,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACnD,IAAI,CAAC,SAAS,GAAG,IAAI,GAAG,EAAE,CAAA;QAC1B,IAAI,CAAC,aAAa,GAAG,IAAI,GAAG,EAAE,CAAA;QAC9B,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,IAAI,CAAC,oBAAoB,IAAI,cAAc,CAAC,oBAAoB,CAAC,CAAA;QACrF,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAC5C,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAA;IAC1B,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,KAAK;QACT,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAM;SACP;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;IACrB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI;QACR,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAM;SACP;QAED,IAAI,CAAC,OAAO,GAAG,KAAK,CAAA;QACpB,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,CAAA;QAEvB,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE;YAC3C,KAAK,CAAC,IAAI,EAAE,CAAA;SACb;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,EAAE;YAC/C,KAAK,CAAC,IAAI,EAAE,CAAA;SACb;IACH,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAED;;OAEG;IACH,QAAQ;QACN,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAA;IAC1C,CAAC;IAED,mBAAmB;QACjB,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;IAED,qBAAqB,CAAE,MAA8B;QACnD,MAAM,EAAE,MAAM,GAAG,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,CAAA;QAE9D,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC7B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;SACpC;QAED,MAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;QAE9C,IAAI,aAAa,IAAI,IAAI,EAAE;YACzB,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAA;SACzC;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE;YACjC,aAAa,CAAC,GAAG,CAAC,SAAS,EAAE,IAAI,GAAG,EAAE,CAAC,CAAA;SACxC;QAED,MAAM,gBAAgB,GAAG,aAAa,CAAC,GAAG,CAAC,SAAS,CAAC,CAAA;QAErD,IAAI,gBAAgB,IAAI,IAAI,EAAE;YAC5B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;SAC5C;QAED,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;IACrC,CAAC;IAED;;;OAGG;IACH,OAAO,CAAE,MAAc;QACrB,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;QAClC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACpE,CAAC;IAED;;OAEG;IACH,YAAY;QACV,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,CAAA;IAC9C,CAAC;IAED;;OAEG;IACH,WAAW,CAAE,QAAgB;QAC3B,OAAO,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IACzC,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAE,MAAc;QAChC,MAAM,QAAQ,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;QAClC,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QAE9C,IAAI,SAAS,IAAI,IAAI,EAAE;YACrB,SAAS,CAAC,IAAI,EAAE,CAAA;YAEhB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC/B,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAA;SACvC;IACH,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAE,IAAsB;QAChC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAM;SACP;QAED,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,GAAG,IAAI,CAAA;QAE5D,MAAM,GAAG,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAA;QAEvC,IAAI,SAAS,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACxC,IAAI,SAAS,IAAI,IAAI,EAAE;YACrB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YAC9C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,UAAU,CAAC,QAAQ,EAAE,EAAE,KAAK,CAAC,CAAA;YAChD,SAAS,GAAG,KAAK,CAAA;SAClB;QAED,wBAAwB;QACxB,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAC/B,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;QAEtC,0BAA0B;QAC1B,IAAI,QAAQ,IAAI,IAAI,EAAE;YACpB,IAAI,aAAa,GAAG,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAE9C,IAAI,aAAa,IAAI,IAAI,EAAE;gBACzB,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;gBAC9C,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAA;gBACvC,aAAa,GAAG,KAAK,CAAA;aACtB;YAED,aAAa,CAAC,IAAI,CAAC,GAAG,EAAE,UAAU,CAAC,CAAA;SACpC;IACH,CAAC;IAED;;;;;;;;OAQG;IACH,iBAAiB,CAAE,WAAmB,EAAE,MAAc;QACpD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAM;SACP;QAED,MAAM,iBAAiB,GAAG,WAAW,CAAC,QAAQ,EAAE,CAAA;QAChD,MAAM,gBAAgB,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;QACtG,MAAM,YAAY,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QACzF,IAAI,WAAW,GAAG,gBAAgB,CAAA;QAElC,0CAA0C;QAC1C,IAAI,aAAa,IAAI,IAAI,EAAE;YACzB,qBAAqB;YACrB,WAAW,GAAG,UAAU,CAAC,aAAa,EAAE,WAAW,CAAC,CAAA;YACpD,8EAA8E;YAC9E,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAA;SACnC;QAED,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;QAC7C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;QAC7C,WAAW,CAAC,KAAK,EAAE,CAAA;IACrB,CAAC;IAED;;;;;;OAMG;IACH,WAAW,CAAiC,IAA2B;QACrE,MAAM,EAAE,MAAM,EAAE,UAAU,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAA;QAE7C,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAO,MAAM,CAAA;SACd;QAED,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAA;QAC5B,MAAM,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC;YACpD,UAAU;YACV,QAAQ;YACR,SAAS,EAAE,IAAI;YACf,UAAU,EAAE,KAAK,CAAC,MAAM;SACzB,CAAC,CAAC,CAAA;QAEH,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACxB,MAAM,CAAC,IAAI,GAAG,KAAK,EAAC,MAAM,EAAC,EAAE;YAC3B,OAAO,MAAM,IAAI,CACf,MAAM,EACN,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;gBAC/B,IAAI,CAAC,UAAU,CAAC;oBACd,UAAU;oBACV,QAAQ;oBACR,SAAS,EAAE,KAAK;oBAChB,UAAU,EAAE,KAAK,CAAC,MAAM;iBACzB,CAAC,CAAA;YACJ,CAAC,CAAC,EACF,IAAI,CACL,CAAA;QACH,CAAC,CAAA;QAED,OAAO,MAAM,CAAA;IACf,CAAC;CACF;AAED;;;GAGG;AACH,SAAS,UAAU,CAAE,MAAoB,EAAE,KAAmB;IAC5D,MAAM,CAAC,IAAI,EAAE,CAAA;IACb,KAAK,CAAC,IAAI,EAAE,CAAA;IAEZ,eAAe;IACf,MAAM,CAAC,KAAK,GAAG,CAAC,GAAG,MAAM,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,KAAK,CAAC,CAAA;IAEhD,sCAAsC;IACtC,OAAO,MAAM,CAAA;AACf,CAAC"}

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

@@ -0,0 +1,14 @@
+import type { MovingAverage } from '@libp2p/interfaces/metrics';
+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/metrics/moving-average.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"moving-average.d.ts","sourceRoot":"","sources":["../../../src/metrics/moving-average.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAE/D,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/metrics/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/metrics/moving-average.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"moving-average.js","sourceRoot":"","sources":["../../../src/metrics/moving-average.ts"],"names":[],"mappings":"AAEA,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"}