X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fperformance%2FPerformanceStatistics.ts;h=bd158ab80c8bcfe137d44ea213220a96dfec9077;hb=f6778d744cf0bb0c9d352a7960b44c78d896f822;hp=c41b2d59a2e0d157758e7b37643f34d8e17f90ad;hpb=32de5a575189d226213641f5ee36004f8454cb50;p=e-mobility-charging-stations-simulator.git diff --git a/src/performance/PerformanceStatistics.ts b/src/performance/PerformanceStatistics.ts index c41b2d59..bd158ab8 100644 --- a/src/performance/PerformanceStatistics.ts +++ b/src/performance/PerformanceStatistics.ts @@ -1,19 +1,32 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. -import { PerformanceEntry, PerformanceObserver, performance } from 'perf_hooks'; -import { URL } from 'url'; -import { parentPort } from 'worker_threads'; +import { type PerformanceEntry, PerformanceObserver, performance } from 'node:perf_hooks'; +import type { URL } from 'node:url'; +import { parentPort } from 'node:worker_threads'; -import { MessageChannelUtils } from '../charging-station/MessageChannelUtils'; -import { MessageType } from '../types/ocpp/MessageType'; -import { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests'; -import Statistics, { StatisticsData, TimeSeries } from '../types/Statistics'; -import { CircularArray, DEFAULT_CIRCULAR_ARRAY_SIZE } from '../utils/CircularArray'; -import Configuration from '../utils/Configuration'; -import logger from '../utils/Logger'; -import Utils from '../utils/Utils'; +import { + type IncomingRequestCommand, + MessageType, + type RequestCommand, + type Statistics, + type TimestampedData, +} from '../types'; +import { + CircularArray, + Configuration, + Constants, + JSONStringifyWithMapSupport, + buildPerformanceStatisticsMessage, + formatDurationSeconds, + generateUUID, + logPrefix, + logger, + median, + nthPercentile, + stdDeviation, +} from '../utils'; -export default class PerformanceStatistics { +export class PerformanceStatistics { private static readonly instances: Map = new Map< string, PerformanceStatistics @@ -21,9 +34,9 @@ export default class PerformanceStatistics { private readonly objId: string; private readonly objName: string; - private performanceObserver: PerformanceObserver; + private performanceObserver!: PerformanceObserver; private readonly statistics: Statistics; - private displayInterval: NodeJS.Timeout; + private displayInterval!: NodeJS.Timeout; private constructor(objId: string, objName: string, uri: URL) { this.objId = objId; @@ -34,7 +47,7 @@ export default class PerformanceStatistics { name: this.objName ?? 'Object name not specified', uri: uri.toString(), createdAt: new Date(), - statisticsData: new Map>(), + statisticsData: new Map(), }; } @@ -50,7 +63,7 @@ export default class PerformanceStatistics { } 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)}~${generateUUID()}`; performance.mark(markId); return markId; } @@ -58,6 +71,7 @@ export default class PerformanceStatistics { public static endMeasure(name: string, markId: string): void { performance.measure(name, markId); performance.clearMarks(markId); + performance.clearMeasures(name); } public addRequestStatistic( @@ -70,12 +84,12 @@ export default class PerformanceStatistics { this.statistics.statisticsData.has(command) && this.statistics.statisticsData.get(command)?.countRequest ) { - this.statistics.statisticsData.get(command).countRequest++; + ++this.statistics.statisticsData.get(command).countRequest; } else { - this.statistics.statisticsData.set( - command, - Object.assign({ countRequest: 1 }, this.statistics.statisticsData.get(command)) - ); + this.statistics.statisticsData.set(command, { + ...this.statistics.statisticsData.get(command), + countRequest: 1, + }); } break; case MessageType.CALL_RESULT_MESSAGE: @@ -83,12 +97,12 @@ export default class PerformanceStatistics { this.statistics.statisticsData.has(command) && this.statistics.statisticsData.get(command)?.countResponse ) { - this.statistics.statisticsData.get(command).countResponse++; + ++this.statistics.statisticsData.get(command).countResponse; } else { - this.statistics.statisticsData.set( - command, - Object.assign({ countResponse: 1 }, this.statistics.statisticsData.get(command)) - ); + this.statistics.statisticsData.set(command, { + ...this.statistics.statisticsData.get(command), + countResponse: 1, + }); } break; case MessageType.CALL_ERROR_MESSAGE: @@ -96,12 +110,12 @@ export default class PerformanceStatistics { this.statistics.statisticsData.has(command) && this.statistics.statisticsData.get(command)?.countError ) { - this.statistics.statisticsData.get(command).countError++; + ++this.statistics.statisticsData.get(command).countError; } else { - this.statistics.statisticsData.set( - command, - Object.assign({ countError: 1 }, this.statistics.statisticsData.get(command)) - ); + this.statistics.statisticsData.set(command, { + ...this.statistics.statisticsData.get(command), + countError: 1, + }); } break; default: @@ -123,10 +137,9 @@ export default class PerformanceStatistics { } public stop(): void { - if (this.displayInterval) { - clearInterval(this.displayInterval); - } + this.stopLogStatisticsInterval(); performance.clearMarks(); + performance.clearMeasures(); this.performanceObserver?.disconnect(); } @@ -136,96 +149,55 @@ 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: JSONStringifyWithMapSupport(this.statistics.statisticsData), + }); } private startLogStatisticsInterval(): void { - if (Configuration.getLogStatisticsInterval() > 0) { + const logStatisticsInterval = Configuration.getLog().enabled + ? Configuration.getLog().statisticsInterval + : 0; + if (logStatisticsInterval > 0 && !this.displayInterval) { this.displayInterval = setInterval(() => { this.logStatistics(); - }, Configuration.getLogStatisticsInterval() * 1000); + }, logStatisticsInterval * 1000); logger.info( - this.logPrefix() + - ' logged every ' + - Utils.formatDurationSeconds(Configuration.getLogStatisticsInterval()) + `${this.logPrefix()} logged every ${formatDurationSeconds(logStatisticsInterval)}` ); - } else { + } else if (this.displayInterval) { logger.info( - this.logPrefix() + - ' log interval is set to ' + - Configuration.getLogStatisticsInterval().toString() + - '. Not logging statistics' + `${this.logPrefix()} already logged every ${formatDurationSeconds(logStatisticsInterval)}` + ); + } else if (Configuration.getLog().enabled) { + logger.info( + `${this.logPrefix()} log interval is set to ${logStatisticsInterval?.toString()}. Not logging statistics` ); } } - private median(dataSet: number[]): number { - if (Array.isArray(dataSet) && dataSet.length === 1) { - return dataSet[0]; - } - 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; - } - - // 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) { - totalDataSet += data; - } - const dataSetMean = totalDataSet / dataSet.length; - let totalGeometricDeviation = 0; - for (const data of dataSet) { - const deviation = data - dataSetMean; - totalGeometricDeviation += deviation * deviation; + private stopLogStatisticsInterval(): void { + if (this.displayInterval) { + clearInterval(this.displayInterval); + delete this.displayInterval; } - return Math.sqrt(totalGeometricDeviation / dataSet.length); } private addPerformanceEntryToStatistics(entry: PerformanceEntry): void { - let entryName = entry.name; - // Rename entry name - const MAP_NAME: Record = {}; - if (MAP_NAME[entryName]) { - entryName = MAP_NAME[entryName]; - } + const entryName = entry.name; // Initialize command statistics if (!this.statistics.statisticsData.has(entryName)) { this.statistics.statisticsData.set(entryName, {}); @@ -233,67 +205,57 @@ export default class PerformanceStatistics { // Update current statistics this.statistics.updatedAt = new Date(); 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)?.countTimeMeasurement ?? 0) + 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).minTimeMeasurement = Math.min( + entry.duration, + this.statistics.statisticsData.get(entryName)?.minTimeMeasurement ?? Infinity + ); + this.statistics.statisticsData.get(entryName).maxTimeMeasurement = Math.max( + entry.duration, + this.statistics.statisticsData.get(entryName)?.maxTimeMeasurement ?? -Infinity + ); 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)?.totalTimeMeasurement ?? 0) + entry.duration; this.statistics.statisticsData.get(entryName).avgTimeMeasurement = this.statistics.statisticsData.get(entryName).totalTimeMeasurement / this.statistics.statisticsData.get(entryName).countTimeMeasurement; - Array.isArray(this.statistics.statisticsData.get(entryName).timeMeasurementSeries) + this.statistics.statisticsData.get(entryName)?.measurementTimeSeries instanceof CircularArray ? this.statistics.statisticsData .get(entryName) - .timeMeasurementSeries.push({ timestamp: entry.startTime, value: entry.duration }) - : (this.statistics.statisticsData.get(entryName).timeMeasurementSeries = - new CircularArray(DEFAULT_CIRCULAR_ARRAY_SIZE, { + ?.measurementTimeSeries?.push({ timestamp: entry.startTime, value: entry.duration }) + : (this.statistics.statisticsData.get(entryName).measurementTimeSeries = + new CircularArray(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, { timestamp: entry.startTime, value: entry.duration, })); - this.statistics.statisticsData.get(entryName).medTimeMeasurement = this.median( + this.statistics.statisticsData.get(entryName).medTimeMeasurement = median( this.extractTimeSeriesValues( - this.statistics.statisticsData.get(entryName).timeMeasurementSeries + this.statistics.statisticsData.get(entryName).measurementTimeSeries ) ); this.statistics.statisticsData.get(entryName).ninetyFiveThPercentileTimeMeasurement = - this.percentile( + nthPercentile( this.extractTimeSeriesValues( - this.statistics.statisticsData.get(entryName).timeMeasurementSeries + this.statistics.statisticsData.get(entryName).measurementTimeSeries ), 95 ); - this.statistics.statisticsData.get(entryName).stdDevTimeMeasurement = this.stdDeviation( + this.statistics.statisticsData.get(entryName).stdDevTimeMeasurement = stdDeviation( this.extractTimeSeriesValues( - this.statistics.statisticsData.get(entryName).timeMeasurementSeries + this.statistics.statisticsData.get(entryName).measurementTimeSeries ) ); if (Configuration.getPerformanceStorage().enabled) { - parentPort.postMessage( - MessageChannelUtils.buildPerformanceStatisticsMessage(this.statistics) - ); + parentPort?.postMessage(buildPerformanceStatisticsMessage(this.statistics)); } } - private extractTimeSeriesValues(timeSeries: CircularArray): number[] { + private extractTimeSeriesValues(timeSeries: CircularArray): number[] { return timeSeries.map((timeSeriesItem) => timeSeriesItem.value); } - private logPrefix(): string { - return Utils.logPrefix(` ${this.objName} | Performance statistics`); - } + private logPrefix = (): string => { + return logPrefix(` ${this.objName} | Performance statistics`); + }; }