libp2p 0.40.0 → 0.41.0

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

@@ -1,87 +0,0 @@
-import { EventEmitter } from '@libp2p/interfaces/events';
-import type { MovingAverages, Stats, TransferStats } from '@libp2p/interface-metrics';
-export interface StatsEvents {
-    'update': CustomEvent<TransferStats>;
-}
-export interface StatsInit {
-    enabled: boolean;
-    initialCounters: ['dataReceived', 'dataSent'];
-    movingAverageIntervals: number[];
-    computeThrottleMaxQueueSize: number;
-    computeThrottleTimeout: number;
-}
-export declare class DefaultStats extends EventEmitter<StatsEvents> implements Stats {
-    private readonly enabled;
-    queue: Array<[string, number, number]>;
-    private stats;
-    private frequencyLastTime;
-    private frequencyAccumulators;
-    private movingAverages;
-    private timeout?;
-    private readonly computeThrottleMaxQueueSize;
-    private readonly computeThrottleTimeout;
-    private readonly movingAverageIntervals;
-    /**
-     * A queue based manager for stat processing
-     */
-    constructor(init: StatsInit);
-    /**
-     * Initializes the internal timer if there are items in the queue. This
-     * should only need to be called if `Stats.stop` was previously called, as
-     * `Stats.push` will also start the processing
-     */
-    start(): void;
-    /**
-     * Stops processing and computing of stats by clearing the internal
-     * timer
-     */
-    stop(): void;
-    /**
-     * Returns a clone of the current stats.
-     */
-    getSnapshot(): TransferStats;
-    /**
-     * Returns a clone of the internal movingAverages
-     */
-    getMovingAverages(): MovingAverages;
-    /**
-     * Pushes the given operation data to the queue, along with the
-     * current Timestamp, then resets the update timer.
-     */
-    push(counter: string, inc: number): void;
-    /**
-     * Resets the timeout for triggering updates.
-     */
-    _resetComputeTimeout(): void;
-    /**
-     * Calculates and returns the timeout for the next update based on
-     * the urgency of the update.
-     */
-    _nextTimeout(): number;
-    /**
-     * If there are items in the queue, they will will be processed and
-     * the frequency for all items will be updated based on the Timestamp
-     * of the last item in the queue. The `update` event will also be emitted
-     * with the latest stats.
-     *
-     * If there are no items in the queue, no action is taken.
-     */
-    _update(): void;
-    /**
-     * For each key in the stats, the frequency and moving averages
-     * will be updated via Stats._updateFrequencyFor based on the time
-     * difference between calls to this method.
-     */
-    _updateFrequency(latestTime: number): void;
-    /**
-     * Updates the `movingAverages` for the given `key` and also
-     * resets the `frequencyAccumulator` for the `key`.
-     */
-    _updateFrequencyFor(key: 'dataReceived' | 'dataSent', timeDiffMS: number, latestTime: number): void;
-    /**
-     * For the given operation, `op`, the stats and `frequencyAccumulator`
-     * will be updated or initialized if they don't already exist.
-     */
-    _applyOp(op: [string, number, number]): void;
-}
-//# sourceMappingURL=stats.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"stats.d.ts","sourceRoot":"","sources":["../../../src/metrics/stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAIrE,OAAO,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAA;AAErF,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,WAAW,CAAC,aAAa,CAAC,CAAA;CACrC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,OAAO,CAAA;IAChB,eAAe,EAAE,CAAC,cAAc,EAAE,UAAU,CAAC,CAAA;IAC7C,sBAAsB,EAAE,MAAM,EAAE,CAAA;IAChC,2BAA2B,EAAE,MAAM,CAAA;IACnC,sBAAsB,EAAE,MAAM,CAAA;CAC/B;AAED,qBAAa,YAAa,SAAQ,YAAY,CAAC,WAAW,CAAE,YAAW,KAAK;IAC1E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IAC1B,KAAK,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IAC7C,OAAO,CAAC,KAAK,CAAe;IAC5B,OAAO,CAAC,iBAAiB,CAAQ;IACjC,OAAO,CAAC,qBAAqB,CAAwB;IACrD,OAAO,CAAC,cAAc,CAAgB;IACtC,OAAO,CAAC,OAAO,CAAC,CAAK;IACrB,OAAO,CAAC,QAAQ,CAAC,2BAA2B,CAAQ;IACpD,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAQ;IAC/C,OAAO,CAAC,QAAQ,CAAC,sBAAsB,CAAU;IAEjD;;OAEG;gBACU,IAAI,EAAE,SAAS;IAmC5B;;;;OAIG;IACH,KAAK;IAUL;;;OAGG;IACH,IAAI;IAOJ;;OAEG;IACH,WAAW;IAIX;;OAEG;IACH,iBAAiB,IAAK,cAAc;IAIpC;;;OAGG;IACH,IAAI,CAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAKlC;;OAEG;IACH,oBAAoB;IAIpB;;;OAGG;IACH,YAAY;IAOZ;;;;;;;OAOG;IACH,OAAO;IAqBP;;;;OAIG;IACH,gBAAgB,CAAE,UAAU,EAAE,MAAM;IASpC;;;OAGG;IACH,mBAAmB,CAAE,GAAG,EAAE,cAAc,GAAG,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM;IAwB7F;;;OAGG;IACH,QAAQ,CAAE,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC;CA2BvC"}

package/dist/src/metrics/stats.js

@@ -1,183 +0,0 @@
-import { CustomEvent, EventEmitter } from '@libp2p/interfaces/events';
-import { createMovingAverage } from './moving-average.js';
-// @ts-expect-error no types
-import retimer from 'retimer';
-export class DefaultStats extends EventEmitter {
-    /**
-     * A queue based manager for stat processing
-     */
-    constructor(init) {
-        super();
-        this.enabled = init.enabled;
-        this.queue = [];
-        this.stats = {
-            dataReceived: 0n,
-            dataSent: 0n
-        };
-        this.frequencyLastTime = Date.now();
-        this.frequencyAccumulators = {};
-        this.movingAverages = {
-            dataReceived: [],
-            dataSent: []
-        };
-        this.computeThrottleMaxQueueSize = init.computeThrottleMaxQueueSize;
-        this.computeThrottleTimeout = init.computeThrottleTimeout;
-        this._update = this._update.bind(this);
-        this.movingAverageIntervals = init.movingAverageIntervals;
-        for (let i = 0; i < init.initialCounters.length; i++) {
-            const key = init.initialCounters[i];
-            this.stats[key] = 0n;
-            this.movingAverages[key] = [];
-            for (let k = 0; k < this.movingAverageIntervals.length; k++) {
-                const interval = this.movingAverageIntervals[k];
-                const ma = this.movingAverages[key][interval] = createMovingAverage(interval);
-                ma.push(this.frequencyLastTime, 0);
-            }
-        }
-    }
-    /**
-     * Initializes the internal timer if there are items in the queue. This
-     * should only need to be called if `Stats.stop` was previously called, as
-     * `Stats.push` will also start the processing
-     */
-    start() {
-        if (!this.enabled) {
-            return;
-        }
-        if (this.queue.length > 0) {
-            this._resetComputeTimeout();
-        }
-    }
-    /**
-     * Stops processing and computing of stats by clearing the internal
-     * timer
-     */
-    stop() {
-        if (this.timeout != null) {
-            this.timeout.clear();
-            this.timeout = null;
-        }
-    }
-    /**
-     * Returns a clone of the current stats.
-     */
-    getSnapshot() {
-        return Object.assign({}, this.stats);
-    }
-    /**
-     * Returns a clone of the internal movingAverages
-     */
-    getMovingAverages() {
-        return Object.assign({}, this.movingAverages);
-    }
-    /**
-     * Pushes the given operation data to the queue, along with the
-     * current Timestamp, then resets the update timer.
-     */
-    push(counter, inc) {
-        this.queue.push([counter, inc, Date.now()]);
-        this._resetComputeTimeout();
-    }
-    /**
-     * Resets the timeout for triggering updates.
-     */
-    _resetComputeTimeout() {
-        this.timeout = retimer(this._update, this._nextTimeout());
-    }
-    /**
-     * Calculates and returns the timeout for the next update based on
-     * the urgency of the update.
-     */
-    _nextTimeout() {
-        // calculate the need for an update, depending on the queue length
-        const urgency = this.queue.length / this.computeThrottleMaxQueueSize;
-        const timeout = Math.max(this.computeThrottleTimeout * (1 - urgency), 0);
-        return timeout;
-    }
-    /**
-     * If there are items in the queue, they will will be processed and
-     * the frequency for all items will be updated based on the Timestamp
-     * of the last item in the queue. The `update` event will also be emitted
-     * with the latest stats.
-     *
-     * If there are no items in the queue, no action is taken.
-     */
-    _update() {
-        this.timeout = null;
-        if (this.queue.length > 0) {
-            let last = ['', 0, 0];
-            for (last of this.queue) {
-                this._applyOp(last);
-            }
-            this.queue = [];
-            if (last.length > 2 && last[0] !== '') {
-                this._updateFrequency(last[2]); // contains timestamp of last op
-            }
-            this.dispatchEvent(new CustomEvent('update', {
-                detail: this.stats
-            }));
-        }
-    }
-    /**
-     * For each key in the stats, the frequency and moving averages
-     * will be updated via Stats._updateFrequencyFor based on the time
-     * difference between calls to this method.
-     */
-    _updateFrequency(latestTime) {
-        const timeDiff = latestTime - this.frequencyLastTime;
-        this._updateFrequencyFor('dataReceived', timeDiff, latestTime);
-        this._updateFrequencyFor('dataSent', timeDiff, latestTime);
-        this.frequencyLastTime = latestTime;
-    }
-    /**
-     * Updates the `movingAverages` for the given `key` and also
-     * resets the `frequencyAccumulator` for the `key`.
-     */
-    _updateFrequencyFor(key, timeDiffMS, latestTime) {
-        const count = this.frequencyAccumulators[key] ?? 0;
-        this.frequencyAccumulators[key] = 0;
-        // if `timeDiff` is zero, `hz` becomes Infinity, so we fallback to 1ms
-        const safeTimeDiff = timeDiffMS ?? 1;
-        const hz = (count / safeTimeDiff) * 1000;
-        let movingAverages = this.movingAverages[key];
-        if (movingAverages == null) {
-            movingAverages = this.movingAverages[key] = [];
-        }
-        const intervals = this.movingAverageIntervals;
-        for (let i = 0; i < intervals.length; i++) {
-            const movingAverageInterval = intervals[i];
-            let movingAverage = movingAverages[movingAverageInterval];
-            if (movingAverage == null) {
-                movingAverage = movingAverages[movingAverageInterval] = createMovingAverage(movingAverageInterval);
-            }
-            movingAverage.push(latestTime, hz);
-        }
-    }
-    /**
-     * For the given operation, `op`, the stats and `frequencyAccumulator`
-     * will be updated or initialized if they don't already exist.
-     */
-    _applyOp(op) {
-        const key = op[0];
-        const inc = op[1];
-        if (typeof inc !== 'number') {
-            throw new Error('invalid increment number');
-        }
-        let n;
-        if (!Object.prototype.hasOwnProperty.call(this.stats, key)) {
-            // @ts-expect-error cannot index type with key
-            n = this.stats[key] = 0n;
-        }
-        else {
-            // @ts-expect-error cannot index type with key
-            n = this.stats[key];
-        }
-        // @ts-expect-error cannot index type with key
-        this.stats[key] = n + BigInt(inc);
-        if (this.frequencyAccumulators[key] == null) {
-            this.frequencyAccumulators[key] = 0;
-        }
-        this.frequencyAccumulators[key] += inc;
-    }
-}
-//# sourceMappingURL=stats.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"stats.js","sourceRoot":"","sources":["../../../src/metrics/stats.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AACrE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAA;AACzD,4BAA4B;AAC5B,OAAO,OAAO,MAAM,SAAS,CAAA;AAe7B,MAAM,OAAO,YAAa,SAAQ,YAAyB;IAYzD;;OAEG;IACH,YAAa,IAAe;QAC1B,KAAK,EAAE,CAAA;QAEP,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAA;QAC3B,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,KAAK,GAAG;YACX,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,EAAE;SACb,CAAA;QACD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACnC,IAAI,CAAC,qBAAqB,GAAG,EAAE,CAAA;QAC/B,IAAI,CAAC,cAAc,GAAG;YACpB,YAAY,EAAE,EAAE;YAChB,QAAQ,EAAE,EAAE;SACb,CAAA;QACD,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC,2BAA2B,CAAA;QACnE,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAA;QAEzD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAEtC,IAAI,CAAC,sBAAsB,GAAG,IAAI,CAAC,sBAAsB,CAAA;QAEzD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpD,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;YACnC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;YACpB,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;YAE7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;gBAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAA;gBAC/C,MAAM,EAAE,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAA;gBAC7E,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC,CAAC,CAAA;aACnC;SACF;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK;QACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE;YACjB,OAAM;SACP;QAED,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,CAAC,oBAAoB,EAAE,CAAA;SAC5B;IACH,CAAC;IAED;;;OAGG;IACH,IAAI;QACF,IAAI,IAAI,CAAC,OAAO,IAAI,IAAI,EAAE;YACxB,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAA;YACpB,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;SACpB;IACH,CAAC;IAED;;OAEG;IACH,WAAW;QACT,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA;IACtC,CAAC;IAED;;OAEG;IACH,iBAAiB;QACf,OAAO,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,IAAI,CAAC,cAAc,CAAC,CAAA;IAC/C,CAAC;IAED;;;OAGG;IACH,IAAI,CAAE,OAAe,EAAE,GAAW;QAChC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;QAC3C,IAAI,CAAC,oBAAoB,EAAE,CAAA;IAC7B,CAAC;IAED;;OAEG;IACH,oBAAoB;QAClB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,EAAE,CAAC,CAAA;IAC3D,CAAC;IAED;;;OAGG;IACH,YAAY;QACV,kEAAkE;QAClE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,IAAI,CAAC,2BAA2B,CAAA;QACpE,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,CAAC,GAAG,OAAO,CAAC,EAAE,CAAC,CAAC,CAAA;QACxE,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;OAOG;IACH,OAAO;QACL,IAAI,CAAC,OAAO,GAAG,IAAI,CAAA;QACnB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;YACzB,IAAI,IAAI,GAA6B,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;YAE/C,KAAK,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE;gBACvB,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;aACpB;YAED,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;YAEf,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,EAAE,EAAE;gBACrC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA,CAAC,gCAAgC;aAChE;YAED,IAAI,CAAC,aAAa,CAAC,IAAI,WAAW,CAAgB,QAAQ,EAAE;gBAC1D,MAAM,EAAE,IAAI,CAAC,KAAK;aACnB,CAAC,CAAC,CAAA;SACJ;IACH,CAAC;IAED;;;;OAIG;IACH,gBAAgB,CAAE,UAAkB;QAClC,MAAM,QAAQ,GAAG,UAAU,GAAG,IAAI,CAAC,iBAAiB,CAAA;QAEpD,IAAI,CAAC,mBAAmB,CAAC,cAAc,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA;QAC9D,IAAI,CAAC,mBAAmB,CAAC,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAA;QAE1D,IAAI,CAAC,iBAAiB,GAAG,UAAU,CAAA;IACrC,CAAC;IAED;;;OAGG;IACH,mBAAmB,CAAE,GAAgC,EAAE,UAAkB,EAAE,UAAkB;QAC3F,MAAM,KAAK,GAAG,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAA;QAClD,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QACnC,sEAAsE;QACtE,MAAM,YAAY,GAAG,UAAU,IAAI,CAAC,CAAA;QACpC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,YAAY,CAAC,GAAG,IAAI,CAAA;QAExC,IAAI,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,CAAA;QAC7C,IAAI,cAAc,IAAI,IAAI,EAAE;YAC1B,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;SAC/C;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAA;QAE7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACzC,MAAM,qBAAqB,GAAG,SAAS,CAAC,CAAC,CAAC,CAAA;YAC1C,IAAI,aAAa,GAAG,cAAc,CAAC,qBAAqB,CAAC,CAAA;YACzD,IAAI,aAAa,IAAI,IAAI,EAAE;gBACzB,aAAa,GAAG,cAAc,CAAC,qBAAqB,CAAC,GAAG,mBAAmB,CAAC,qBAAqB,CAAC,CAAA;aACnG;YACD,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,CAAC,CAAA;SACnC;IACH,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAE,EAA4B;QACpC,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;QACjB,MAAM,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,CAAA;QAEjB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC3B,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;SAC5C;QAED,IAAI,CAAS,CAAA;QAEb,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE;YAC1D,8CAA8C;YAC9C,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;SACzB;aAAM;YACL,8CAA8C;YAC9C,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;SACpB;QAED,8CAA8C;QAC9C,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC,CAAA;QAEjC,IAAI,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,IAAI,EAAE;YAC3C,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;SACpC;QAED,IAAI,CAAC,qBAAqB,CAAC,GAAG,CAAC,IAAI,GAAG,CAAA;IACxC,CAAC;CACF"}

package/src/metrics/index.ts

@@ -1,311 +0,0 @@
-import { pipe } from 'it-pipe'
-import each from 'it-foreach'
-import LRU from 'hashlru'
-import { METRICS as defaultOptions } from '../constants.js'
-import { DefaultStats, StatsInit } from './stats.js'
-import type { ComponentMetricsUpdate, Metrics, Stats, TrackedMetric, TrackStreamOptions } from '@libp2p/interface-metrics'
-import type { PeerId } from '@libp2p/interface-peer-id'
-import type { Startable } from '@libp2p/interfaces/startable'
-
-const initialCounters: ['dataReceived', 'dataSent'] = [
-  'dataReceived',
-  'dataSent'
-]
-
-const directionToEvent = {
-  in: 'dataReceived',
-  out: 'dataSent'
-}
-
-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 class DefaultMetrics implements Metrics, Startable {
-  public globalStats: DefaultStats
-
-  private readonly enabled: boolean
-  private readonly peerStats: Map<string, DefaultStats>
-  private readonly protocolStats: Map<string, DefaultStats>
-  private readonly oldPeers: ReturnType<typeof LRU>
-  private running: boolean
-  private readonly systems: Map<string, Map<string, Map<string, TrackedMetric>>>
-  private readonly statsInit: StatsInit
-
-  constructor (init: MetricsInit) {
-    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: ComponentMetricsUpdate) {
-    const { system = 'libp2p', component, metric, value, label, help } = 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, {
-      label,
-      help,
-      calculate: typeof value !== 'function' ? () => value : value
-    })
-  }
-
-  /**
-   * Returns the `Stats` object for the given `PeerId` whether it
-   * is a live peer, or in the disconnected peer LRU cache.
-   */
-  forPeer (peerId: PeerId): Stats | undefined {
-    const idString = peerId.toString()
-    return this.peerStats.get(idString) ?? this.oldPeers.get(idString)
-  }
-
-  /**
-   * Returns a list of all protocol strings currently being tracked
-   */
-  getProtocols (): string[] {
-    return Array.from(this.protocolStats.keys())
-  }
-
-  /**
-   * Returns the `Stats` object for the given `protocol`
-   */
-  forProtocol (protocol: string): Stats | undefined {
-    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: 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: OnMessageOptions) {
-    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, peerId: 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: TrackStreamOptions): void {
-    const { stream, remotePeer, protocol } = opts
-
-    if (!this.running) {
-      return
-    }
-
-    const source = stream.source
-    stream.source = each(source, chunk => this._onMessage({
-      remotePeer,
-      protocol,
-      direction: 'in',
-      dataLength: chunk.byteLength
-    }))
-
-    const sink = stream.sink
-    stream.sink = async source => {
-      return await pipe(
-        source,
-        (source) => each(source, chunk => {
-          this._onMessage({
-            remotePeer,
-            protocol,
-            direction: 'out',
-            dataLength: chunk.byteLength
-          })
-        }),
-        sink
-      )
-    }
-  }
-}
-
-/**
- * Merges `other` into `target`. `target` will be modified
- * and returned
- */
-function mergeStats (target: DefaultStats, other: DefaultStats) {
-  target.stop()
-  other.stop()
-
-  // Merge queues
-  target.queue = [...target.queue, ...other.queue]
-
-  // TODO: how to merge moving averages?
-  return target
-}

package/src/metrics/moving-average.ts

@@ -1,53 +0,0 @@
-import type { MovingAverage } from '@libp2p/interface-metrics'
-
-export class DefaultMovingAverage {
-  public movingAverage: number
-  public variance: number
-  public deviation: number
-  public forecast: number
-  private readonly timespan: number
-  private previousTime?: number
-
-  constructor (timespan: number) {
-    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: number, pt: number) {
-    return 1 - (Math.exp(-(t - pt) / this.timespan))
-  }
-
-  push (time: number, value: number) {
-    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: number): MovingAverage {
-  return new DefaultMovingAverage(timespan)
-}