X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fperformance%2FPerformanceStatistics.ts;h=b7bc5d27f894c27c9984571e90a4b07187ed8fed;hb=42b8cf5cdca8eaab1e7442f7c92c2a5ed97434f6;hp=9762a3a07fcaf52c822de30ffffc40c288c8347f;hpb=d7d1db72537ac2b012ca901a768d6442f3cf39fe;p=e-mobility-charging-stations-simulator.git diff --git a/src/performance/PerformanceStatistics.ts b/src/performance/PerformanceStatistics.ts index 9762a3a0..b7bc5d27 100644 --- a/src/performance/PerformanceStatistics.ts +++ b/src/performance/PerformanceStatistics.ts @@ -1,32 +1,78 @@ -// Partial Copyright Jerome Benoit. 2021. All Rights Reserved. - -import { CircularArray, DEFAULT_CIRCULAR_ARRAY_SIZE } from '../utils/CircularArray'; -import { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests'; -import { PerformanceEntry, PerformanceObserver, performance } from 'perf_hooks'; -import Statistics, { StatisticsData } from '../types/Statistics'; - -import Configuration from '../utils/Configuration'; -import { MessageType } from '../types/ocpp/MessageType'; -import { URL } from 'url'; -import Utils from '../utils/Utils'; -import { WorkerMessageEvents } from '../types/Worker'; -import logger from '../utils/Logger'; -import { parentPort } from 'worker_threads'; - -export default class PerformanceStatistics { - private objId: string; - private performanceObserver: PerformanceObserver; - private statistics: Statistics; - private displayInterval: NodeJS.Timeout; - - public constructor(objId: string, URI: URL) { +// Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. + +import { type PerformanceEntry, PerformanceObserver, performance } from 'node:perf_hooks'; +import type { URL } from 'node:url'; +import { parentPort } from 'node:worker_threads'; + +import { secondsToMilliseconds } from 'date-fns'; + +import { + ConfigurationSection, + type IncomingRequestCommand, + type LogConfiguration, + MessageType, + type RequestCommand, + type Statistics, + type StorageConfiguration, + type TimestampedData, +} from '../types'; +import { + CircularArray, + Configuration, + Constants, + JSONStringifyWithMapSupport, + average, + buildPerformanceStatisticsMessage, + extractTimeSeriesValues, + formatDurationSeconds, + generateUUID, + logPrefix, + logger, + max, + median, + min, + nthPercentile, + stdDeviation, +} from '../utils'; + +export class PerformanceStatistics { + private static readonly instances: Map = new Map< + string, + PerformanceStatistics + >(); + + private readonly objId: string; + private readonly objName: string; + private performanceObserver!: PerformanceObserver; + private readonly statistics: Statistics; + private displayInterval?: NodeJS.Timeout; + + 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)}~${generateUUID()}`; performance.mark(markId); return markId; } @@ -34,43 +80,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)?.requestCount + ) { + ++this.statistics.statisticsData.get(command)!.requestCount!; } else { - this.statistics.statisticsData[command] = {} as StatisticsData; - this.statistics.statisticsData[command].countRequest = 1; + this.statistics.statisticsData.set(command, { + ...this.statistics.statisticsData.get(command), + requestCount: 1, + }); } 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)?.responseCount + ) { + ++this.statistics.statisticsData.get(command)!.responseCount!; } else { - this.statistics.statisticsData[command] = {} as StatisticsData; - this.statistics.statisticsData[command].countResponse = 1; + this.statistics.statisticsData.set(command, { + ...this.statistics.statisticsData.get(command), + responseCount: 1, + }); } 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)?.errorCount + ) { + ++this.statistics.statisticsData.get(command)!.errorCount!; } else { - this.statistics.statisticsData[command] = {} as StatisticsData; - this.statistics.statisticsData[command].countError = 1; + this.statistics.statisticsData.set(command, { + ...this.statistics.statisticsData.get(command), + errorCount: 1, + }); } break; default: + // eslint-disable-next-line @typescript-eslint/restrict-template-expressions logger.error(`${this.logPrefix()} wrong message type ${messageType}`); break; } @@ -78,16 +136,23 @@ 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}`); + const performanceStorageConfiguration = + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ); + if (performanceStorageConfiguration.enabled) { + logger.info( + `${this.logPrefix()} storage enabled: type ${performanceStorageConfiguration.type}, uri: ${ + performanceStorageConfiguration.uri + }`, + ); } } public stop(): void { - if (this.displayInterval) { - clearInterval(this.displayInterval); - } + this.stopLogStatisticsInterval(); performance.clearMarks(); + performance.clearMeasures(); this.performanceObserver?.disconnect(); } @@ -97,106 +162,108 @@ 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 logConfiguration = Configuration.getConfigurationSection( + ConfigurationSection.log, + ); + const logStatisticsInterval = logConfiguration.enabled + ? logConfiguration.statisticsInterval! + : 0; + if (logStatisticsInterval > 0 && !this.displayInterval) { this.displayInterval = setInterval(() => { this.logStatistics(); - }, Configuration.getLogStatisticsInterval() * 1000); - 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'); + }, secondsToMilliseconds(logStatisticsInterval)); + logger.info( + `${this.logPrefix()} logged every ${formatDurationSeconds(logStatisticsInterval)}`, + ); + } else if (this.displayInterval) { + logger.info( + `${this.logPrefix()} already logged every ${formatDurationSeconds(logStatisticsInterval)}`, + ); + } else if (logConfiguration.enabled) { + logger.info( + `${this.logPrefix()} log interval is set to ${logStatisticsInterval}. 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]; - } // Initialize command statistics - if (!this.statistics.statisticsData[entryName]) { - this.statistics.statisticsData[entryName] = {} as StatisticsData; + if (!this.statistics.statisticsData.has(entry.name)) { + this.statistics.statisticsData.set(entry.name, {}); } // Update current statistics + this.statistics.statisticsData.get(entry.name)!.timeMeasurementCount = + (this.statistics.statisticsData.get(entry.name)?.timeMeasurementCount ?? 0) + 1; + this.statistics.statisticsData.get(entry.name)!.currentTimeMeasurement = entry.duration; + this.statistics.statisticsData.get(entry.name)!.minTimeMeasurement = min( + entry.duration, + this.statistics.statisticsData.get(entry.name)?.minTimeMeasurement ?? Infinity, + ); + this.statistics.statisticsData.get(entry.name)!.maxTimeMeasurement = max( + entry.duration, + this.statistics.statisticsData.get(entry.name)?.maxTimeMeasurement ?? -Infinity, + ); + this.statistics.statisticsData.get(entry.name)!.totalTimeMeasurement = + (this.statistics.statisticsData.get(entry.name)?.totalTimeMeasurement ?? 0) + entry.duration; + this.statistics.statisticsData.get(entry.name)?.measurementTimeSeries instanceof CircularArray + ? this.statistics.statisticsData + .get(entry.name) + ?.measurementTimeSeries?.push({ timestamp: entry.startTime, value: entry.duration }) + : (this.statistics.statisticsData.get(entry.name)!.measurementTimeSeries = + new CircularArray(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, { + timestamp: entry.startTime, + value: entry.duration, + })); + const timeMeasurementValues = extractTimeSeriesValues( + this.statistics.statisticsData.get(entry.name)!.measurementTimeSeries!, + ); + this.statistics.statisticsData.get(entry.name)!.avgTimeMeasurement = + average(timeMeasurementValues); + this.statistics.statisticsData.get(entry.name)!.medTimeMeasurement = + median(timeMeasurementValues); + this.statistics.statisticsData.get(entry.name)!.ninetyFiveThPercentileTimeMeasurement = + nthPercentile(timeMeasurementValues, 95); + this.statistics.statisticsData.get(entry.name)!.stdDevTimeMeasurement = stdDeviation( + timeMeasurementValues, + this.statistics.statisticsData.get(entry.name)!.avgTimeMeasurement, + ); 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(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) { - parentPort.postMessage({ id: WorkerMessageEvents.PERFORMANCE_STATISTICS, data: this.statistics }); + if ( + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ).enabled + ) { + parentPort?.postMessage(buildPerformanceStatisticsMessage(this.statistics)); } } - private logPrefix(): string { - return Utils.logPrefix(` ${this.objId} | Performance statistics`); - } + private logPrefix = (): string => { + return logPrefix(` ${this.objName} | Performance statistics`); + }; }