Storage: storage records in JSON file as an array to ease import.

[e-mobility-charging-stations-simulator.git] / src / utils / PerformanceStatistics.ts

diff --git a/src/utils/PerformanceStatistics.ts b/src/utils/PerformanceStatistics.ts
index e7cd58e8b9e17a39d1546c37c2a9d39d447d4c22..02b2854e185d7bc794cb4ba5184908366e19141e 100644 (file)
--- a/src/utils/PerformanceStatistics.ts
+++ b/src/utils/PerformanceStatistics.ts
@@ -1,3 +1,5 @@
+// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+
 import { CircularArray, DEFAULT_CIRCULAR_ARRAY_SIZE } from './CircularArray';
 import { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests';
 import { PerformanceEntry, PerformanceObserver, performance } from 'perf_hooks';
@@ -5,10 +7,13 @@ import Statistics, { StatisticsData } from '../types/Statistics';
 
 import Configuration from './Configuration';
 import { MessageType } from '../types/ocpp/MessageType';
+import { Storage } from './performance-storage/Storage';
+import { StorageFactory } from './performance-storage/StorageFactory';
 import Utils from './Utils';
 import logger from './Logger';
 
 export default class PerformanceStatistics {
+  private static storage: Storage;
   private objId: string;
   private performanceObserver: PerformanceObserver;
   private statistics: Statistics;
@@ -17,7 +22,7 @@ export default class PerformanceStatistics {
   public constructor(objId: string) {
     this.objId = objId;
     this.initializePerformanceObserver();
-    this.statistics = { id: this.objId ?? 'Object id not specified', statisticsData: {} };
+    this.statistics = { id: this.objId ?? 'Object id not specified', createdAt: new Date(), statisticsData: {} };
   }
 
   public static beginMeasure(id: string): string {
@@ -28,6 +33,7 @@ export default class PerformanceStatistics {
 
   public static endMeasure(name: string, beginId: string): void {
     performance.measure(name, beginId);
+    performance.clearMarks(beginId);
   }
 
   public addRequestStatistic(command: RequestCommand | IncomingRequestCommand, messageType: MessageType): void {
@@ -71,39 +77,45 @@ export default class PerformanceStatistics {
   }
 
   public start(): void {
-    this.startDisplayInterval();
+    this.startLogStatisticsInterval();
+    if (Configuration.getPerformanceStorage().enabled) {
+      logger.info(`${this.logPrefix()} storage enabled: type ${Configuration.getPerformanceStorage().type}, URI: ${Configuration.getPerformanceStorage().URI}`);
+    }
   }
 
   public stop(): void {
-    clearInterval(this.displayInterval);
+    if (this.displayInterval) {
+      clearInterval(this.displayInterval);
+    }
     performance.clearMarks();
-    this.performanceObserver.disconnect();
+    this.performanceObserver?.disconnect();
+  }
+
+  public restart(): void {
+    this.stop();
+    this.start();
   }
 
   private initializePerformanceObserver(): void {
     this.performanceObserver = new PerformanceObserver((list) => {
-      this.logPerformanceEntry(list.getEntries()[0]);
+      this.addPerformanceEntryToStatistics(list.getEntries()[0]);
+      logger.debug(`${this.logPrefix()} '${list.getEntries()[0].name}' performance entry: %j`, list.getEntries()[0]);
     });
     this.performanceObserver.observe({ entryTypes: ['measure'] });
   }
 
-  private logPerformanceEntry(entry: PerformanceEntry): void {
-    this.addPerformanceStatistic(entry.name, entry.duration);
-    logger.debug(`${this.logPrefix()} '${entry.name}' performance entry: %j`, entry);
-  }
-
   private logStatistics(): void {
     logger.info(this.logPrefix() + ' %j', this.statistics);
   }
 
-  private startDisplayInterval(): void {
-    if (Configuration.getStatisticsDisplayInterval() > 0) {
+  private startLogStatisticsInterval(): void {
+    if (Configuration.getLogStatisticsInterval() > 0) {
       this.displayInterval = setInterval(() => {
         this.logStatistics();
-      }, Configuration.getStatisticsDisplayInterval() * 1000);
-      logger.info(this.logPrefix() + ' displayed every ' + Utils.secondsToHHMMSS(Configuration.getStatisticsDisplayInterval()));
+      }, Configuration.getLogStatisticsInterval() * 1000);
+      logger.info(this.logPrefix() + ' logged every ' + Utils.secondsToHHMMSS(Configuration.getLogStatisticsInterval()));
     } else {
-      logger.info(this.logPrefix() + ' display interval is set to ' + Configuration.getStatisticsDisplayInterval().toString() + '. Not displaying statistics');
+      logger.info(this.logPrefix() + ' log interval is set to ' + Configuration.getLogStatisticsInterval().toString() + '. Not logging statistics');
     }
   }
 
@@ -111,7 +123,7 @@ export default class PerformanceStatistics {
     if (Array.isArray(dataSet) && dataSet.length === 1) {
       return dataSet[0];
     }
-    const sortedDataSet = dataSet.slice().sort();
+    const sortedDataSet = dataSet.slice().sort((a, b) => (a - b));
     const middleIndex = Math.floor(sortedDataSet.length / 2);
     if (sortedDataSet.length % 2) {
       return sortedDataSet[middleIndex / 2];
@@ -119,6 +131,28 @@ export default class PerformanceStatistics {
     return (sortedDataSet[(middleIndex - 1)] + sortedDataSet[middleIndex]) / 2;
   }
 
+  // TODO: use order statistics tree https://en.wikipedia.org/wiki/Order_statistic_tree
+  private percentile(dataSet: number[], percentile: number): number {
+    if (percentile < 0 && percentile > 100) {
+      throw new RangeError('Percentile is not between 0 and 100');
+    }
+    if (Utils.isEmptyArray(dataSet)) {
+      return 0;
+    }
+    const sortedDataSet = dataSet.slice().sort((a, b) => (a - b));
+    if (percentile === 0) {
+      return sortedDataSet[0];
+    }
+    if (percentile === 100) {
+      return sortedDataSet[sortedDataSet.length - 1];
+    }
+    const percentileIndex = ((percentile / 100) * sortedDataSet.length) - 1;
+    if (Number.isInteger(percentileIndex)) {
+      return (sortedDataSet[percentileIndex] + sortedDataSet[percentileIndex + 1]) / 2;
+    }
+    return sortedDataSet[Math.round(percentileIndex)];
+  }
+
   private stdDeviation(dataSet: number[]): number {
     let totalDataSet = 0;
     for (const data of dataSet) {
@@ -133,29 +167,42 @@ export default class PerformanceStatistics {
     return Math.sqrt(totalGeometricDeviation / dataSet.length);
   }
 
-  private addPerformanceStatistic(name: string, duration: number): void {
+  private addPerformanceEntryToStatistics(entry: PerformanceEntry): void {
+    let entryName = entry.name;
     // Rename entry name
-    const MAP_NAME = {};
-    if (MAP_NAME[name]) {
-      name = MAP_NAME[name] as string;
+    const MAP_NAME: Record<string, string> = {};
+    if (MAP_NAME[entryName]) {
+      entryName = MAP_NAME[entryName];
     }
     // Initialize command statistics
-    if (!this.statistics.statisticsData[name]) {
-      this.statistics.statisticsData[name] = {} as StatisticsData;
+    if (!this.statistics.statisticsData[entryName]) {
+      this.statistics.statisticsData[entryName] = {} as StatisticsData;
+    }
+    // Update current statistics
+    this.statistics.lastUpdatedAt = new Date();
+    this.statistics.statisticsData[entryName].countTimeMeasurement = this.statistics.statisticsData[entryName].countTimeMeasurement ? this.statistics.statisticsData[entryName].countTimeMeasurement + 1 : 1;
+    this.statistics.statisticsData[entryName].currentTimeMeasurement = entry.duration;
+    this.statistics.statisticsData[entryName].minTimeMeasurement = this.statistics.statisticsData[entryName].minTimeMeasurement ? (this.statistics.statisticsData[entryName].minTimeMeasurement > entry.duration ? entry.duration : this.statistics.statisticsData[entryName].minTimeMeasurement) : entry.duration;
+    this.statistics.statisticsData[entryName].maxTimeMeasurement = this.statistics.statisticsData[entryName].maxTimeMeasurement ? (this.statistics.statisticsData[entryName].maxTimeMeasurement < entry.duration ? entry.duration : this.statistics.statisticsData[entryName].maxTimeMeasurement) : entry.duration;
+    this.statistics.statisticsData[entryName].totalTimeMeasurement = this.statistics.statisticsData[entryName].totalTimeMeasurement ? this.statistics.statisticsData[entryName].totalTimeMeasurement + entry.duration : entry.duration;
+    this.statistics.statisticsData[entryName].avgTimeMeasurement = this.statistics.statisticsData[entryName].totalTimeMeasurement / this.statistics.statisticsData[entryName].countTimeMeasurement;
+    Array.isArray(this.statistics.statisticsData[entryName].timeMeasurementSeries) ? this.statistics.statisticsData[entryName].timeMeasurementSeries.push(entry.duration) : this.statistics.statisticsData[entryName].timeMeasurementSeries = new CircularArray<number>(DEFAULT_CIRCULAR_ARRAY_SIZE, entry.duration);
+    this.statistics.statisticsData[entryName].medTimeMeasurement = this.median(this.statistics.statisticsData[entryName].timeMeasurementSeries);
+    this.statistics.statisticsData[entryName].ninetyFiveThPercentileTimeMeasurement = this.percentile(this.statistics.statisticsData[entryName].timeMeasurementSeries, 95);
+    this.statistics.statisticsData[entryName].stdDevTimeMeasurement = this.stdDeviation(this.statistics.statisticsData[entryName].timeMeasurementSeries);
+    if (Configuration.getPerformanceStorage().enabled) {
+      this.getStorage().storePerformanceStatistics(this.statistics);
     }
-    // Update current statistics timers
-    this.statistics.statisticsData[name].countTimeMeasurement = this.statistics.statisticsData[name].countTimeMeasurement ? this.statistics.statisticsData[name].countTimeMeasurement + 1 : 1;
-    this.statistics.statisticsData[name].currentTimeMeasurement = duration;
-    this.statistics.statisticsData[name].minTimeMeasurement = this.statistics.statisticsData[name].minTimeMeasurement ? (this.statistics.statisticsData[name].minTimeMeasurement > duration ? duration : this.statistics.statisticsData[name].minTimeMeasurement) : duration;
-    this.statistics.statisticsData[name].maxTimeMeasurement = this.statistics.statisticsData[name].maxTimeMeasurement ? (this.statistics.statisticsData[name].maxTimeMeasurement < duration ? duration : this.statistics.statisticsData[name].maxTimeMeasurement) : duration;
-    this.statistics.statisticsData[name].totalTimeMeasurement = this.statistics.statisticsData[name].totalTimeMeasurement ? this.statistics.statisticsData[name].totalTimeMeasurement + duration : duration;
-    this.statistics.statisticsData[name].avgTimeMeasurement = this.statistics.statisticsData[name].totalTimeMeasurement / this.statistics.statisticsData[name].countTimeMeasurement;
-    Array.isArray(this.statistics.statisticsData[name].timeMeasurementSeries) ? this.statistics.statisticsData[name].timeMeasurementSeries.push(duration) : this.statistics.statisticsData[name].timeMeasurementSeries = new CircularArray<number>(DEFAULT_CIRCULAR_ARRAY_SIZE, duration);
-    this.statistics.statisticsData[name].medTimeMeasurement = this.median(this.statistics.statisticsData[name].timeMeasurementSeries);
-    this.statistics.statisticsData[name].stdDevTimeMeasurement = this.stdDeviation(this.statistics.statisticsData[name].timeMeasurementSeries);
   }
 
   private logPrefix(): string {
     return Utils.logPrefix(` ${this.objId} | Performance statistics`);
   }
+
+  private getStorage(): Storage {
+    if (!PerformanceStatistics.storage) {
+      PerformanceStatistics.storage = StorageFactory.getStorage(Configuration.getPerformanceStorage().type ,Configuration.getPerformanceStorage().URI, this.logPrefix());
+    }
+    return PerformanceStatistics.storage;
+  }
 }