@vpalmisano/webrtcperf 4.2.0 → 4.3.2

package/build/src/stats.d.ts

@@ -1,4 +1,3 @@
-import axios from 'axios';
 import * as events from 'events';
 import { Stats as FastStats } from 'fast-stats';
 import { Session } from './session';
@@ -9,13 +8,9 @@ export { FastStats };
 declare class StatsWriter {
     fname: string;
     columns: string[];
-    private _header_written;
+    private headerWritten;
     constructor(fname: string | undefined, columns: string[]);
-    /**
-     * push
-     * @param dataColumns
-     */
-    push(dataColumns: string[]): Promise<void>;
+    push(dataColumns: string[], append?: boolean): Promise<void>;
 }
 export interface CollectedStats {
     all: FastStats;
@@ -114,6 +109,7 @@ export declare class Stats extends events.EventEmitter {
     nextSessionId: number;
     statsWriter: StatsWriter | null;
     detailedStatsWriter: StatsWriter | null;
+    detailedStatsSummaryWriter: StatsWriter | null;
     private scheduler?;
     private alertRules;
     readonly alertRulesOutput: string;
@@ -128,17 +124,10 @@ export declare class Stats extends events.EventEmitter {
     private alertTagsMetrics?;
     private readonly customMetricsLabels;
     collectedStats: Record<string, CollectedStats>;
-    collectedStatsConfig: {
-        url: string;
-        pages: number;
-        startTime: number;
-    };
-    externalCollectedStats: Map<string, {
-        addedTime: number;
-        externalStats: any;
-        config: any;
-    }>;
-    pushStatsInstance: axios.AxiosInstance | null;
+    private collectedStatsConfig;
+    private externalCollectedStats;
+    private pushStatsInstance;
+    private detailedStatsSummary;
     private running;
     /**
      * Stats aggregator class.
@@ -199,6 +188,7 @@ export declare class Stats extends events.EventEmitter {
     collectStats(now: number): Promise<void>;
     writeStats(): Promise<void>;
     writeDetailedStats(): Promise<void>;
+    writeDetailedStatsSummary(): Promise<void>;
     /**
      * addCollectedStats
      * @param id
@@ -236,8 +226,5 @@ export declare class Stats extends events.EventEmitter {
      * writeAlertRulesReport
      */
     writeAlertRulesReport(): Promise<void>;
-    /**
-     * Stop the stats collector and the added Sessions.
-     */
     stop(): Promise<void>;
 }

package/build/src/stats.js

@@ -38,7 +38,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Stats = exports.FastStats = void 0;
 const axios_1 = __importDefault(require("axios"));
-const chalk_1 = __importDefault(require("chalk"));
 const events = __importStar(require("events"));
 const fast_stats_1 = require("fast-stats");
 Object.defineProperty(exports, "FastStats", { enumerable: true, get: function () { return fast_stats_1.Stats; } });
@@ -53,6 +52,8 @@ const zlib = __importStar(require("zlib"));
 const rtcstats_1 = require("./rtcstats");
 const utils_1 = require("./utils");
 const log = (0, utils_1.logger)('webrtcperf:stats');
+// eslint-disable-next-line @typescript-eslint/no-require-imports
+const { default: chalk } = require('chalk-template');
 function calculateFailAmountPercentile(stat, percentile = 95) {
     return Math.round(stat.percentile(percentile));
 }
@@ -62,21 +63,17 @@ function calculateFailAmountPercentile(stat, percentile = 95) {
 class StatsWriter {
     fname;
     columns;
-    _header_written = false;
+    headerWritten = false;
     constructor(fname = 'stats.log', columns) {
         this.fname = fname;
         this.columns = columns;
     }
-    /**
-     * push
-     * @param dataColumns
-     */
-    async push(dataColumns) {
-        if (!this._header_written) {
+    async push(dataColumns, append = true) {
+        if (!this.headerWritten || !append) {
             const data = ['datetime', ...this.columns].join(',') + '\n';
             await fs.promises.mkdir(path.dirname(this.fname), { recursive: true });
             await fs.promises.writeFile(this.fname, data);
-            this._header_written = true;
+            this.headerWritten = true;
         }
         //
         const data = [Date.now(), ...dataColumns].join(',') + '\n';
@@ -133,9 +130,9 @@ function formatStats(s, forWriter = false) {
  * @param name
  */
 function sprintfStatsTitle(name) {
-    return (0, sprintf_js_1.sprintf)((0, chalk_1.default) `-- {bold %(name)s} %(fill)s\n`, {
+    return (0, sprintf_js_1.sprintf)(chalk `-- {bold %(name)s} %(fill)s\n`, {
         name,
-        fill: '-'.repeat(100 - name.length - 4),
+        fill: '-'.repeat(110 - name.length - 4),
     });
 }
 /**
@@ -143,7 +140,7 @@ function sprintfStatsTitle(name) {
  */
 function sprintfStatsHeader() {
     return (sprintfStatsTitle(new Date().toUTCString()) +
-        (0, sprintf_js_1.sprintf)((0, chalk_1.default) `{bold %(name)\' 30s} {bold %(length)\' 8s} {bold %(sum)\' 8s} {bold %(mean)\' 8s} {bold %(stddev)\' 8s} {bold %(p5)\' 8s} {bold %(p95)\' 8s} {bold %(min)\' 8s} {bold %(max)\' 8s}\n`, {
+        (0, sprintf_js_1.sprintf)(chalk `{bold %(name)\' 30s} {bold %(length)\' 8s} {bold %(sum)\' 8s} {bold %(mean)\' 8s} {bold %(stddev)\' 8s} {bold %(p5)\' 8s} {bold %(p95)\' 8s} {bold %(min)\' 8s} {bold %(max)\' 8s}\n`, {
             name: 'name',
             length: 'count',
             sum: 'sum',
@@ -166,15 +163,15 @@ function sprintfStats(name, stats, format = '.2f', unit = '', scale = 1, hideSum
         scale = 1;
     }
     const statsData = formatStats(stats.all);
-    return (0, sprintf_js_1.sprintf)((0, chalk_1.default) `{red {bold %(name)\' 30s}}` +
-        (0, chalk_1.default) ` {bold %(length)\' 8d}` +
-        (hideSum ? '         ' : (0, chalk_1.default) ` {bold %(sum)\' 8${format}}`) +
-        (0, chalk_1.default) ` {bold %(mean)\' 8${format}}` +
-        (0, chalk_1.default) ` {bold %(stddev)\' 8${format}}` +
-        (0, chalk_1.default) ` {bold %(p5)\' 8${format}}` +
-        (0, chalk_1.default) ` {bold %(p95)\' 8${format}}` +
-        (0, chalk_1.default) ` {bold %(min)\' 8${format}}` +
-        (0, chalk_1.default) ` {bold %(max)\' 8${format}}%(unit)s\n`, {
+    return (0, sprintf_js_1.sprintf)(chalk `{red {bold %(name)\' 30s}}` +
+        chalk ` {bold %(length)\' 8d}` +
+        (hideSum ? '         ' : chalk ` {bold %(sum)\' 8${format}}`) +
+        chalk ` {bold %(mean)\' 8${format}}` +
+        chalk ` {bold %(stddev)\' 8${format}}` +
+        chalk ` {bold %(p5)\' 8${format}}` +
+        chalk ` {bold %(p95)\' 8${format}}` +
+        chalk ` {bold %(min)\' 8${format}}` +
+        chalk ` {bold %(max)\' 8${format}}%(unit)s\n`, {
         name,
         length: statsData.length,
         sum: statsData.sum * scale,
@@ -184,7 +181,7 @@ function sprintfStats(name, stats, format = '.2f', unit = '', scale = 1, hideSum
         p95: statsData.p95 * scale,
         min: statsData.min * scale,
         max: statsData.max * scale,
-        unit: unit ? (0, chalk_1.default) ` {red {bold ${unit}}}` : '',
+        unit: unit ? chalk ` {red {bold ${unit}}}` : '',
     });
 }
 const promPrefix = 'wst_';
@@ -227,6 +224,7 @@ class Stats extends events.EventEmitter {
     nextSessionId;
     statsWriter;
     detailedStatsWriter;
+    detailedStatsSummaryWriter;
     scheduler;
     alertRules = null;
     alertRulesOutput;
@@ -249,6 +247,7 @@ class Stats extends events.EventEmitter {
     };
     externalCollectedStats = new Map();
     pushStatsInstance = null;
+    detailedStatsSummary = {};
     running = false;
     /**
      * Stats aggregator class.
@@ -286,6 +285,7 @@ class Stats extends events.EventEmitter {
             : {};
         this.statsWriter = null;
         this.detailedStatsWriter = null;
+        this.detailedStatsSummaryWriter = null;
         if (alertRules.trim()) {
             this.alertRules = json5_1.default.parse(alertRules);
             log.debug(`using alertRules: ${JSON.stringify(this.alertRules, undefined, 2)}`);
@@ -404,6 +404,11 @@ class Stats extends events.EventEmitter {
                 'trackId',
                 ...this.statsNames,
             ]);
+            this.detailedStatsSummaryWriter = new StatsWriter(this.detailedStatsPath.replace(/\.(.+)$/, '-summary.$1'), [
+                'participantName',
+                'trackId',
+                ...this.statsNames,
+            ]);
         }
         if (this.prometheusPushgateway) {
             const register = new promClient.Registry();
@@ -587,7 +592,6 @@ class Stats extends events.EventEmitter {
                     }
                     else {
                         for (const [key, value] of Object.entries(obj)) {
-                            // eslint-disable-next-line @typescript-eslint/no-explicit-any
                             if (typeof value === 'number' && isFinite(value)) {
                                 collectedStats.all.push(value);
                                 // Push host label.
@@ -728,18 +732,46 @@ class Stats extends events.EventEmitter {
                     stats = {};
                     participantTrackStats.set(label, stats);
                 }
-                stats[name] = (0, utils_1.toPrecision)(value, 6);
+                stats[name] = value;
             });
         });
         for (const [label, trackStats] of participantTrackStats.entries()) {
             const [participantName, trackId] = label.split(':', 2);
+            if (!this.detailedStatsSummary[label]) {
+                this.detailedStatsSummary[label] = {};
+            }
+            const summary = this.detailedStatsSummary[label];
             const values = [participantName, trackId];
             for (const name of this.statsNames) {
-                values.push(trackStats[name] ?? '');
+                values.push(trackStats[name] !== undefined ? (0, utils_1.toPrecision)(trackStats[name], 6) : '');
+                // Update the summary stats.
+                if (!summary[name]) {
+                    summary[name] = new fast_stats_1.Stats({ store_data: false });
+                }
+                const stat = summary[name];
+                if (trackStats[name] !== undefined) {
+                    stat.push(trackStats[name]);
+                }
             }
             await this.detailedStatsWriter.push(values);
         }
     }
+    async writeDetailedStatsSummary() {
+        if (!this.detailedStatsSummaryWriter)
+            return;
+        let append = false;
+        for (const label of Object.keys(this.detailedStatsSummary)) {
+            const summary = this.detailedStatsSummary[label];
+            const [participantName, trackId] = label.split(':', 2);
+            const values = [participantName, trackId];
+            for (const name of this.statsNames) {
+                const stat = summary[name];
+                values.push(stat?.length > 0 ? (0, utils_1.toPrecision)(stat.amean(), 6) : '');
+            }
+            await this.detailedStatsSummaryWriter.push(values, append);
+            append = true;
+        }
+    }
     /**
      * addCollectedStats
      * @param id
@@ -1260,7 +1292,7 @@ class Stats extends events.EventEmitter {
             });
         }
         else {
-            out += (0, sprintf_js_1.sprintf)((0, chalk_1.default) `{bold %(check)-${colSize}s} {bold %(total)-10s} {bold %(totalFailsTime)-15s} {bold %(totalFailsTimePerc)-15s} {bold %(failAmount)-15s}\n`, {
+            out += (0, sprintf_js_1.sprintf)(chalk `{bold %(check)-${colSize}s} {bold %(total)-10s} {bold %(totalFailsTime)-15s} {bold %(totalFailsTimePerc)-15s} {bold %(failAmount)-15s}\n`, {
                 check: 'Condition',
                 total: 'Fails',
                 totalFailsTime: 'Fail time (s)',
@@ -1282,7 +1314,7 @@ class Stats extends events.EventEmitter {
                         });
                     }
                     else {
-                        out += (0, sprintf_js_1.sprintf)((0, chalk_1.default) `{red {bold %(check)-${colSize}s}} {bold %(totalFails)-10s} {bold %(totalFailsTime)-15s} {bold %(totalFailsTimePerc)-15s} {bold %(failAmountPercentile)-15s}\n`, {
+                        out += (0, sprintf_js_1.sprintf)(chalk `{red {bold %(check)-${colSize}s}} {bold %(totalFails)-10s} {bold %(totalFailsTime)-15s} {bold %(totalFailsTimePerc)-15s} {bold %(failAmountPercentile)-15s}\n`, {
                             check: `${key} ${reportDesc}`,
                             totalFails,
                             totalFailsTime: Math.round(totalFailsTime),
@@ -1303,7 +1335,7 @@ class Stats extends events.EventEmitter {
         }
         else {
             out += (0, sprintf_js_1.sprintf)(`%(fill)s\n`, { fill: '-'.repeat(colSize + 15) });
-            out += (0, sprintf_js_1.sprintf)((0, chalk_1.default) `{bold %(name)-${colSize}s} {bold %(failPerc)-15s}\n`, {
+            out += (0, sprintf_js_1.sprintf)(chalk `{bold %(name)-${colSize}s} {bold %(failPerc)-15s}\n`, {
                 name: 'Tag',
                 failPerc: 'Fail %',
             });
@@ -1318,7 +1350,7 @@ class Stats extends events.EventEmitter {
             }
             else {
                 const color = failPerc < 5 ? 'green' : failPerc < 25 ? 'yellowBright' : failPerc < 50 ? 'yellow' : 'red';
-                out += (0, sprintf_js_1.sprintf)((0, chalk_1.default) `{${color} {bold %(tag)-${colSize}s %(failPerc)-15s}}\n`, {
+                out += (0, sprintf_js_1.sprintf)(chalk `{${color} {bold %(tag)-${colSize}s %(failPerc)-15s}}\n`, {
                     tag,
                     failPerc,
                 });
@@ -1365,17 +1397,13 @@ class Stats extends events.EventEmitter {
             log.error(`writeAlertRulesReport error: ${err.stack}`);
         }
     }
-    /**
-     * Stop the stats collector and the added Sessions.
-     */
     async stop() {
-        if (!this.running) {
+        if (!this.running)
             return;
-        }
         this.running = false;
         log.debug('stop');
         if (this.scheduler) {
-            this.scheduler.stop();
+            await this.scheduler.stop();
             this.scheduler = undefined;
         }
         for (const session of this.sessions.values()) {
@@ -1388,7 +1416,11 @@ class Stats extends events.EventEmitter {
             }
         }
         this.sessions.clear();
+        await this.writeDetailedStatsSummary();
         this.statsWriter = null;
+        this.detailedStatsWriter = null;
+        this.detailedStatsSummaryWriter = null;
+        this.detailedStatsSummary = {};
         // delete metrics
         if (this.gateway) {
             await this.deletePushgatewayStats();