X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fperformance%2FPerformanceStatistics.ts;h=aa0cc72325d903bf2de6ff0a8a44c8b959207f53;hb=32619191f2554bd1839729805dc845aa8737227c;hp=70f9bafdbaedcc704c37eb5ae9d8447c68d489f8;hpb=98dc07faaf264c0263d2c8de382efa9db59cd5b4;p=e-mobility-charging-stations-simulator.git

diff --git a/src/performance/PerformanceStatistics.ts b/src/performance/PerformanceStatistics.ts
index 70f9bafd..aa0cc723 100644
--- a/src/performance/PerformanceStatistics.ts
+++ b/src/performance/PerformanceStatistics.ts
@@ -1,32 +1,57 @@
-// Partial Copyright Jerome Benoit. 2021. All Rights Reserved.
+// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved.
 
-import { CircularArray, DEFAULT_CIRCULAR_ARRAY_SIZE } from '../utils/CircularArray';
-import { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests';
+import type { URL } from 'node:url';
 import { PerformanceEntry, PerformanceObserver, performance } from 'perf_hooks';
-import Statistics, { StatisticsData } from '../types/Statistics';
+import { parentPort } from 'worker_threads';
 
-import { ChargingStationWorkerMessageEvents } from '../types/ChargingStationWorker';
-import Configuration from '../utils/Configuration';
+import { MessageChannelUtils } from '../charging-station/MessageChannelUtils';
 import { MessageType } from '../types/ocpp/MessageType';
-import { URL } from 'url';
-import Utils from '../utils/Utils';
+import type { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests';
+import type { Statistics, TimeSeries } from '../types/Statistics';
+import { CircularArray } from '../utils/CircularArray';
+import Configuration from '../utils/Configuration';
+import Constants from '../utils/Constants';
 import logger from '../utils/Logger';
-import { parentPort } from 'worker_threads';
+import Utils from '../utils/Utils';
 
 export default class PerformanceStatistics {
-  private objId: string;
-  private performanceObserver: PerformanceObserver;
-  private statistics: Statistics;
-  private displayInterval: NodeJS.Timeout;
+  private static readonly instances: Map<string, PerformanceStatistics> = new Map<
+    string,
+    PerformanceStatistics
+  >();
+
+  private readonly objId: string;
+  private readonly objName: string;
+  private performanceObserver!: PerformanceObserver;
+  private readonly statistics: Statistics;
+  private displayInterval!: NodeJS.Timeout;
 
-  public constructor(objId: string, URI: URL) {
+  private constructor(objId: string, objName: string, uri: URL) {
     this.objId = objId;
+    this.objName = objName;
     this.initializePerformanceObserver();
-    this.statistics = { id: this.objId ?? 'Object id not specified', URI: URI.toString(), createdAt: new Date(), statisticsData: {} };
+    this.statistics = {
+      id: this.objId ?? 'Object id not specified',
+      name: this.objName ?? 'Object name not specified',
+      uri: uri.toString(),
+      createdAt: new Date(),
+      statisticsData: new Map(),
+    };
+  }
+
+  public static getInstance(
+    objId: string,
+    objName: string,
+    uri: URL
+  ): PerformanceStatistics | undefined {
+    if (!PerformanceStatistics.instances.has(objId)) {
+      PerformanceStatistics.instances.set(objId, new PerformanceStatistics(objId, objName, uri));
+    }
+    return PerformanceStatistics.instances.get(objId);
   }
 
   public static beginMeasure(id: string): string {
-    const markId = `${id.charAt(0).toUpperCase() + id.slice(1)}~${Utils.generateUUID()}`;
+    const markId = `${id.charAt(0).toUpperCase()}${id.slice(1)}~${Utils.generateUUID()}`;
     performance.mark(markId);
     return markId;
   }
@@ -34,43 +59,55 @@ export default class PerformanceStatistics {
   public static endMeasure(name: string, markId: string): void {
     performance.measure(name, markId);
     performance.clearMarks(markId);
+    performance.clearMeasures(name);
   }
 
-  public addRequestStatistic(command: RequestCommand | IncomingRequestCommand, messageType: MessageType): void {
+  public addRequestStatistic(
+    command: RequestCommand | IncomingRequestCommand,
+    messageType: MessageType
+  ): void {
     switch (messageType) {
       case MessageType.CALL_MESSAGE:
-        if (this.statistics.statisticsData[command] && this.statistics.statisticsData[command].countRequest) {
-          this.statistics.statisticsData[command].countRequest++;
+        if (
+          this.statistics.statisticsData.has(command) &&
+          this.statistics.statisticsData.get(command)?.countRequest
+        ) {
+          this.statistics.statisticsData.get(command).countRequest++;
         } else {
-          this.statistics.statisticsData[command] = {} as StatisticsData;
-          this.statistics.statisticsData[command].countRequest = 1;
+          this.statistics.statisticsData.set(
+            command,
+            Object.assign({ countRequest: 1 }, this.statistics.statisticsData.get(command))
+          );
         }
         break;
       case MessageType.CALL_RESULT_MESSAGE:
-        if (this.statistics.statisticsData[command]) {
-          if (this.statistics.statisticsData[command].countResponse) {
-            this.statistics.statisticsData[command].countResponse++;
-          } else {
-            this.statistics.statisticsData[command].countResponse = 1;
-          }
+        if (
+          this.statistics.statisticsData.has(command) &&
+          this.statistics.statisticsData.get(command)?.countResponse
+        ) {
+          this.statistics.statisticsData.get(command).countResponse++;
         } else {
-          this.statistics.statisticsData[command] = {} as StatisticsData;
-          this.statistics.statisticsData[command].countResponse = 1;
+          this.statistics.statisticsData.set(
+            command,
+            Object.assign({ countResponse: 1 }, this.statistics.statisticsData.get(command))
+          );
         }
         break;
       case MessageType.CALL_ERROR_MESSAGE:
-        if (this.statistics.statisticsData[command]) {
-          if (this.statistics.statisticsData[command].countError) {
-            this.statistics.statisticsData[command].countError++;
-          } else {
-            this.statistics.statisticsData[command].countError = 1;
-          }
+        if (
+          this.statistics.statisticsData.has(command) &&
+          this.statistics.statisticsData.get(command)?.countError
+        ) {
+          this.statistics.statisticsData.get(command).countError++;
         } else {
-          this.statistics.statisticsData[command] = {} as StatisticsData;
-          this.statistics.statisticsData[command].countError = 1;
+          this.statistics.statisticsData.set(
+            command,
+            Object.assign({ countError: 1 }, this.statistics.statisticsData.get(command))
+          );
         }
         break;
       default:
+        // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
         logger.error(`${this.logPrefix()} wrong message type ${messageType}`);
         break;
     }
@@ -79,7 +116,11 @@ export default class PerformanceStatistics {
   public start(): void {
     this.startLogStatisticsInterval();
     if (Configuration.getPerformanceStorage().enabled) {
-      logger.info(`${this.logPrefix()} storage enabled: type ${Configuration.getPerformanceStorage().type}, URI: ${Configuration.getPerformanceStorage().URI}`);
+      logger.info(
+        `${this.logPrefix()} storage enabled: type ${
+          Configuration.getPerformanceStorage().type
+        }, uri: ${Configuration.getPerformanceStorage().uri}`
+      );
     }
   }
 
@@ -88,6 +129,7 @@ export default class PerformanceStatistics {
       clearInterval(this.displayInterval);
     }
     performance.clearMarks();
+    performance.clearMeasures();
     this.performanceObserver?.disconnect();
   }
 
@@ -97,16 +139,22 @@ export default class PerformanceStatistics {
   }
 
   private initializePerformanceObserver(): void {
-    this.performanceObserver = new PerformanceObserver((list) => {
-      const lastPerformanceEntry = list.getEntries()[0];
+    this.performanceObserver = new PerformanceObserver((performanceObserverList) => {
+      const lastPerformanceEntry = performanceObserverList.getEntries()[0];
+      // logger.debug(
+      //   `${this.logPrefix()} '${lastPerformanceEntry.name}' performance entry: %j`,
+      //   lastPerformanceEntry
+      // );
       this.addPerformanceEntryToStatistics(lastPerformanceEntry);
-      logger.debug(`${this.logPrefix()} '${lastPerformanceEntry.name}' performance entry: %j`, lastPerformanceEntry);
     });
     this.performanceObserver.observe({ entryTypes: ['measure'] });
   }
 
   private logStatistics(): void {
-    logger.info(this.logPrefix() + ' %j', this.statistics);
+    logger.info(`${this.logPrefix()}`, {
+      ...this.statistics,
+      statisticsData: Utils.JSONStringifyWithMapSupport(this.statistics.statisticsData),
+    });
   }
 
   private startLogStatisticsInterval(): void {
@@ -114,22 +162,28 @@ export default class PerformanceStatistics {
       this.displayInterval = setInterval(() => {
         this.logStatistics();
       }, Configuration.getLogStatisticsInterval() * 1000);
-      logger.info(this.logPrefix() + ' logged every ' + Utils.formatDurationSeconds(Configuration.getLogStatisticsInterval()));
+      logger.info(
+        `${this.logPrefix()} logged every ${Utils.formatDurationSeconds(
+          Configuration.getLogStatisticsInterval()
+        )}`
+      );
     } else {
-      logger.info(this.logPrefix() + ' log interval is set to ' + Configuration.getLogStatisticsInterval().toString() + '. Not logging statistics');
+      logger.info(
+        `${this.logPrefix()} log interval is set to ${Configuration.getLogStatisticsInterval()?.toString()}. Not logging statistics`
+      );
     }
   }
 
   private median(dataSet: number[]): number {
-    if (Array.isArray(dataSet) && dataSet.length === 1) {
+    if (Array.isArray(dataSet) === true && dataSet.length === 1) {
       return dataSet[0];
     }
-    const sortedDataSet = dataSet.slice().sort((a, b) => (a - b));
+    const sortedDataSet = dataSet.slice().sort((a, b) => a - b);
     const middleIndex = Math.floor(sortedDataSet.length / 2);
     if (sortedDataSet.length % 2) {
       return sortedDataSet[middleIndex / 2];
     }
-    return (sortedDataSet[(middleIndex - 1)] + sortedDataSet[middleIndex]) / 2;
+    return (sortedDataSet[middleIndex - 1] + sortedDataSet[middleIndex]) / 2;
   }
 
   // TODO: use order statistics tree https://en.wikipedia.org/wiki/Order_statistic_tree
@@ -140,14 +194,14 @@ export default class PerformanceStatistics {
     if (Utils.isEmptyArray(dataSet)) {
       return 0;
     }
-    const sortedDataSet = dataSet.slice().sort((a, b) => (a - b));
+    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;
+    const percentileIndex = (percentile / 100) * sortedDataSet.length - 1;
     if (Number.isInteger(percentileIndex)) {
       return (sortedDataSet[percentileIndex] + sortedDataSet[percentileIndex + 1]) / 2;
     }
@@ -169,34 +223,75 @@ export default class PerformanceStatistics {
   }
 
   private addPerformanceEntryToStatistics(entry: PerformanceEntry): void {
-    let entryName = entry.name;
-    // Rename entry name
-    const MAP_NAME: Record<string, string> = {};
-    if (MAP_NAME[entryName]) {
-      entryName = MAP_NAME[entryName];
-    }
+    const entryName = entry.name;
     // Initialize command statistics
-    if (!this.statistics.statisticsData[entryName]) {
-      this.statistics.statisticsData[entryName] = {} as StatisticsData;
+    if (!this.statistics.statisticsData.has(entryName)) {
+      this.statistics.statisticsData.set(entryName, {});
     }
     // Update current statistics
     this.statistics.updatedAt = 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);
+    this.statistics.statisticsData.get(entryName).countTimeMeasurement =
+      this.statistics.statisticsData.get(entryName)?.countTimeMeasurement
+        ? this.statistics.statisticsData.get(entryName).countTimeMeasurement + 1
+        : 1;
+    this.statistics.statisticsData.get(entryName).currentTimeMeasurement = entry.duration;
+    this.statistics.statisticsData.get(entryName).minTimeMeasurement =
+      this.statistics.statisticsData.get(entryName)?.minTimeMeasurement
+        ? this.statistics.statisticsData.get(entryName).minTimeMeasurement > entry.duration
+          ? entry.duration
+          : this.statistics.statisticsData.get(entryName).minTimeMeasurement
+        : entry.duration;
+    this.statistics.statisticsData.get(entryName).maxTimeMeasurement =
+      this.statistics.statisticsData.get(entryName)?.maxTimeMeasurement
+        ? this.statistics.statisticsData.get(entryName).maxTimeMeasurement < entry.duration
+          ? entry.duration
+          : this.statistics.statisticsData.get(entryName).maxTimeMeasurement
+        : entry.duration;
+    this.statistics.statisticsData.get(entryName).totalTimeMeasurement =
+      this.statistics.statisticsData.get(entryName)?.totalTimeMeasurement
+        ? this.statistics.statisticsData.get(entryName).totalTimeMeasurement + entry.duration
+        : entry.duration;
+    this.statistics.statisticsData.get(entryName).avgTimeMeasurement =
+      this.statistics.statisticsData.get(entryName).totalTimeMeasurement /
+      this.statistics.statisticsData.get(entryName).countTimeMeasurement;
+    this.statistics.statisticsData.get(entryName)?.timeMeasurementSeries instanceof CircularArray
+      ? this.statistics.statisticsData
+          .get(entryName)
+          ?.timeMeasurementSeries?.push({ timestamp: entry.startTime, value: entry.duration })
+      : (this.statistics.statisticsData.get(entryName).timeMeasurementSeries =
+          new CircularArray<TimeSeries>(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, {
+            timestamp: entry.startTime,
+            value: entry.duration,
+          }));
+    this.statistics.statisticsData.get(entryName).medTimeMeasurement = this.median(
+      this.extractTimeSeriesValues(
+        this.statistics.statisticsData.get(entryName).timeMeasurementSeries
+      )
+    );
+    this.statistics.statisticsData.get(entryName).ninetyFiveThPercentileTimeMeasurement =
+      this.percentile(
+        this.extractTimeSeriesValues(
+          this.statistics.statisticsData.get(entryName).timeMeasurementSeries
+        ),
+        95
+      );
+    this.statistics.statisticsData.get(entryName).stdDevTimeMeasurement = this.stdDeviation(
+      this.extractTimeSeriesValues(
+        this.statistics.statisticsData.get(entryName).timeMeasurementSeries
+      )
+    );
     if (Configuration.getPerformanceStorage().enabled) {
-      parentPort.postMessage({ id: ChargingStationWorkerMessageEvents.PERFORMANCE_STATISTICS, data: this.statistics });
+      parentPort?.postMessage(
+        MessageChannelUtils.buildPerformanceStatisticsMessage(this.statistics)
+      );
     }
   }
 
-  private logPrefix(): string {
-    return Utils.logPrefix(` ${this.objId} | Performance statistics`);
+  private extractTimeSeriesValues(timeSeries: CircularArray<TimeSeries>): number[] {
+    return timeSeries.map((timeSeriesItem) => timeSeriesItem.value);
   }
+
+  private logPrefix = (): string => {
+    return Utils.logPrefix(` ${this.objName} | Performance statistics`);
+  };
 }