src/utils/PerformanceStatistics.ts

   1 import { CircularArray, DEFAULT_CIRCULAR_ARRAY_SIZE } from './CircularArray';
   2 import { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests';
   3 import { PerformanceEntry, PerformanceObserver, performance } from 'perf_hooks';
   4 import Statistics, { StatisticsData } from '../types/Statistics';
   5
   6 import Configuration from './Configuration';
   7 import { MessageType } from '../types/ocpp/MessageType';
   8 import Utils from './Utils';
   9 import logger from './Logger';
  10
  11 export default class PerformanceStatistics {
  12   private objId: string;
  13   private performanceObserver: PerformanceObserver;
  14   private statistics: Statistics;
  15   private displayInterval: NodeJS.Timeout;
  16
  17   public constructor(objId: string) {
  18     this.objId = objId;
  19     this.initializePerformanceObserver();
  20     this.statistics = { id: this.objId ?? 'Object id not specified', statisticsData: {} };
  21   }
  22
  23   public static beginMeasure(id: string): string {
  24     const beginId = 'begin' + id.charAt(0).toUpperCase() + id.slice(1);
  25     performance.mark(beginId);
  26     return beginId;
  27   }
  28
  29   public static endMeasure(name: string, beginId: string): void {
  30     performance.measure(name, beginId);
  31   }
  32
  33   public addRequestStatistic(command: RequestCommand | IncomingRequestCommand, messageType: MessageType): void {
  34     switch (messageType) {
  35       case MessageType.CALL_MESSAGE:
  36         if (this.statistics.statisticsData[command] && this.statistics.statisticsData[command].countRequest) {
  37           this.statistics.statisticsData[command].countRequest++;
  38         } else {
  39           this.statistics.statisticsData[command] = {} as StatisticsData;
  40           this.statistics.statisticsData[command].countRequest = 1;
  41         }
  42         break;
  43       case MessageType.CALL_RESULT_MESSAGE:
  44         if (this.statistics.statisticsData[command]) {
  45           if (this.statistics.statisticsData[command].countResponse) {
  46             this.statistics.statisticsData[command].countResponse++;
  47           } else {
  48             this.statistics.statisticsData[command].countResponse = 1;
  49           }
  50         } else {
  51           this.statistics.statisticsData[command] = {} as StatisticsData;
  52           this.statistics.statisticsData[command].countResponse = 1;
  53         }
  54         break;
  55       case MessageType.CALL_ERROR_MESSAGE:
  56         if (this.statistics.statisticsData[command]) {
  57           if (this.statistics.statisticsData[command].countError) {
  58             this.statistics.statisticsData[command].countError++;
  59           } else {
  60             this.statistics.statisticsData[command].countError = 1;
  61           }
  62         } else {
  63           this.statistics.statisticsData[command] = {} as StatisticsData;
  64           this.statistics.statisticsData[command].countError = 1;
  65         }
  66         break;
  67       default:
  68         logger.error(`${this.logPrefix()} wrong message type ${messageType}`);
  69         break;
  70     }
  71   }
  72
  73   public start(): void {
  74     this.startDisplayInterval();
  75   }
  76
  77   public stop(): void {
  78     if (this.displayInterval) {
  79       clearInterval(this.displayInterval);
  80     }
  81     performance.clearMarks();
  82     this.performanceObserver.disconnect();
  83   }
  84
  85   private initializePerformanceObserver(): void {
  86     this.performanceObserver = new PerformanceObserver((list) => {
  87       this.logPerformanceEntry(list.getEntries()[0]);
  88     });
  89     this.performanceObserver.observe({ entryTypes: ['measure'] });
  90   }
  91
  92   private logPerformanceEntry(entry: PerformanceEntry): void {
  93     this.addPerformanceStatistic(entry.name, entry.duration);
  94     logger.debug(`${this.logPrefix()} '${entry.name}' performance entry: %j`, entry);
  95   }
  96
  97   private logStatistics(): void {
  98     logger.info(this.logPrefix() + ' %j', this.statistics);
  99   }
 100
 101   private startDisplayInterval(): void {
 102     if (Configuration.getStatisticsDisplayInterval() > 0) {
 103       this.displayInterval = setInterval(() => {
 104         this.logStatistics();
 105       }, Configuration.getStatisticsDisplayInterval() * 1000);
 106       logger.info(this.logPrefix() + ' displayed every ' + Utils.secondsToHHMMSS(Configuration.getStatisticsDisplayInterval()));
 107     } else {
 108       logger.info(this.logPrefix() + ' display interval is set to ' + Configuration.getStatisticsDisplayInterval().toString() + '. Not displaying statistics');
 109     }
 110   }
 111
 112   private median(dataSet: number[]): number {
 113     if (Array.isArray(dataSet) && dataSet.length === 1) {
 114       return dataSet[0];
 115     }
 116     const sortedDataSet = dataSet.slice().sort();
 117     const middleIndex = Math.floor(sortedDataSet.length / 2);
 118     if (sortedDataSet.length % 2) {
 119       return sortedDataSet[middleIndex / 2];
 120     }
 121     return (sortedDataSet[(middleIndex - 1)] + sortedDataSet[middleIndex]) / 2;
 122   }
 123
 124   private stdDeviation(dataSet: number[]): number {
 125     let totalDataSet = 0;
 126     for (const data of dataSet) {
 127       totalDataSet += data;
 128     }
 129     const dataSetMean = totalDataSet / dataSet.length;
 130     let totalGeometricDeviation = 0;
 131     for (const data of dataSet) {
 132       const deviation = data - dataSetMean;
 133       totalGeometricDeviation += deviation * deviation;
 134     }
 135     return Math.sqrt(totalGeometricDeviation / dataSet.length);
 136   }
 137
 138   private addPerformanceStatistic(name: string, duration: number): void {
 139     // Rename entry name
 140     const MAP_NAME = {};
 141     if (MAP_NAME[name]) {
 142       name = MAP_NAME[name] as string;
 143     }
 144     // Initialize command statistics
 145     if (!this.statistics.statisticsData[name]) {
 146       this.statistics.statisticsData[name] = {} as StatisticsData;
 147     }
 148     // Update current statistics timers
 149     this.statistics.statisticsData[name].countTimeMeasurement = this.statistics.statisticsData[name].countTimeMeasurement ? this.statistics.statisticsData[name].countTimeMeasurement + 1 : 1;
 150     this.statistics.statisticsData[name].currentTimeMeasurement = duration;
 151     this.statistics.statisticsData[name].minTimeMeasurement = this.statistics.statisticsData[name].minTimeMeasurement ? (this.statistics.statisticsData[name].minTimeMeasurement > duration ? duration : this.statistics.statisticsData[name].minTimeMeasurement) : duration;
 152     this.statistics.statisticsData[name].maxTimeMeasurement = this.statistics.statisticsData[name].maxTimeMeasurement ? (this.statistics.statisticsData[name].maxTimeMeasurement < duration ? duration : this.statistics.statisticsData[name].maxTimeMeasurement) : duration;
 153     this.statistics.statisticsData[name].totalTimeMeasurement = this.statistics.statisticsData[name].totalTimeMeasurement ? this.statistics.statisticsData[name].totalTimeMeasurement + duration : duration;
 154     this.statistics.statisticsData[name].avgTimeMeasurement = this.statistics.statisticsData[name].totalTimeMeasurement / this.statistics.statisticsData[name].countTimeMeasurement;
 155     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);
 156     this.statistics.statisticsData[name].medTimeMeasurement = this.median(this.statistics.statisticsData[name].timeMeasurementSeries);
 157     this.statistics.statisticsData[name].stdDevTimeMeasurement = this.stdDeviation(this.statistics.statisticsData[name].timeMeasurementSeries);
 158   }
 159
 160   private logPrefix(): string {
 161     return Utils.logPrefix(` ${this.objId} | Performance statistics`);
 162   }
 163 }