X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=src%2Fperformance%2FPerformanceStatistics.ts;h=b7bc5d27f894c27c9984571e90a4b07187ed8fed;hb=c20d5d72396a96028bee5492fa7ea2475b8a109e;hp=587532b7cf09c6e4729876a961c91c341730e723;hpb=7671fa0be211e944f027ebd83f3a0ad64c2ef2d6;p=e-mobility-charging-stations-simulator.git diff --git a/src/performance/PerformanceStatistics.ts b/src/performance/PerformanceStatistics.ts index 587532b7..b7bc5d27 100644 --- a/src/performance/PerformanceStatistics.ts +++ b/src/performance/PerformanceStatistics.ts @@ -4,20 +4,35 @@ import { type PerformanceEntry, PerformanceObserver, performance } from 'node:pe 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 TimeSeries, + type StorageConfiguration, + type TimestampedData, } from '../types'; import { CircularArray, Configuration, Constants, - MessageChannelUtils, - Utils, + JSONStringifyWithMapSupport, + average, + buildPerformanceStatisticsMessage, + extractTimeSeriesValues, + formatDurationSeconds, + generateUUID, + logPrefix, logger, + max, + median, + min, + nthPercentile, + stdDeviation, } from '../utils'; export class PerformanceStatistics { @@ -30,7 +45,7 @@ export class PerformanceStatistics { private readonly objName: string; 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; @@ -48,7 +63,7 @@ export class PerformanceStatistics { public static getInstance( objId: string, objName: string, - uri: URL + uri: URL, ): PerformanceStatistics | undefined { if (!PerformanceStatistics.instances.has(objId)) { PerformanceStatistics.instances.set(objId, new PerformanceStatistics(objId, objName, uri)); @@ -57,7 +72,7 @@ export 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; } @@ -70,45 +85,45 @@ export class PerformanceStatistics { public addRequestStatistic( command: RequestCommand | IncomingRequestCommand, - messageType: MessageType + messageType: MessageType, ): void { switch (messageType) { case MessageType.CALL_MESSAGE: if ( this.statistics.statisticsData.has(command) && - this.statistics.statisticsData.get(command)?.countRequest + this.statistics.statisticsData.get(command)?.requestCount ) { - this.statistics.statisticsData.get(command).countRequest++; + ++this.statistics.statisticsData.get(command)!.requestCount!; } else { this.statistics.statisticsData.set(command, { ...this.statistics.statisticsData.get(command), - countRequest: 1, + requestCount: 1, }); } break; case MessageType.CALL_RESULT_MESSAGE: if ( this.statistics.statisticsData.has(command) && - this.statistics.statisticsData.get(command)?.countResponse + this.statistics.statisticsData.get(command)?.responseCount ) { - this.statistics.statisticsData.get(command).countResponse++; + ++this.statistics.statisticsData.get(command)!.responseCount!; } else { this.statistics.statisticsData.set(command, { ...this.statistics.statisticsData.get(command), - countResponse: 1, + responseCount: 1, }); } break; case MessageType.CALL_ERROR_MESSAGE: if ( this.statistics.statisticsData.has(command) && - this.statistics.statisticsData.get(command)?.countError + this.statistics.statisticsData.get(command)?.errorCount ) { - this.statistics.statisticsData.get(command).countError++; + ++this.statistics.statisticsData.get(command)!.errorCount!; } else { this.statistics.statisticsData.set(command, { ...this.statistics.statisticsData.get(command), - countError: 1, + errorCount: 1, }); } break; @@ -121,11 +136,15 @@ export class PerformanceStatistics { public start(): void { this.startLogStatisticsInterval(); - if (Configuration.getPerformanceStorage().enabled) { + const performanceStorageConfiguration = + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ); + if (performanceStorageConfiguration.enabled) { logger.info( - `${this.logPrefix()} storage enabled: type ${ - Configuration.getPerformanceStorage().type - }, uri: ${Configuration.getPerformanceStorage().uri}` + `${this.logPrefix()} storage enabled: type ${performanceStorageConfiguration.type}, uri: ${ + performanceStorageConfiguration.uri + }`, ); } } @@ -147,7 +166,7 @@ export class PerformanceStatistics { const lastPerformanceEntry = performanceObserverList.getEntries()[0]; // logger.debug( // `${this.logPrefix()} '${lastPerformanceEntry.name}' performance entry: %j`, - // lastPerformanceEntry + // lastPerformanceEntry, // ); this.addPerformanceEntryToStatistics(lastPerformanceEntry); }); @@ -157,28 +176,31 @@ export class PerformanceStatistics { private logStatistics(): void { logger.info(`${this.logPrefix()}`, { ...this.statistics, - statisticsData: Utils.JSONStringifyWithMapSupport(this.statistics.statisticsData), + statisticsData: JSONStringifyWithMapSupport(this.statistics.statisticsData), }); } private startLogStatisticsInterval(): void { - const logStatisticsInterval = Configuration.getLogStatisticsInterval(); + const logConfiguration = Configuration.getConfigurationSection( + ConfigurationSection.log, + ); + const logStatisticsInterval = logConfiguration.enabled + ? logConfiguration.statisticsInterval! + : 0; if (logStatisticsInterval > 0 && !this.displayInterval) { this.displayInterval = setInterval(() => { this.logStatistics(); - }, logStatisticsInterval * 1000); + }, secondsToMilliseconds(logStatisticsInterval)); logger.info( - `${this.logPrefix()} logged every ${Utils.formatDurationSeconds(logStatisticsInterval)}` + `${this.logPrefix()} logged every ${formatDurationSeconds(logStatisticsInterval)}`, ); } else if (this.displayInterval) { logger.info( - `${this.logPrefix()} already logged every ${Utils.formatDurationSeconds( - logStatisticsInterval - )}` + `${this.logPrefix()} already logged every ${formatDurationSeconds(logStatisticsInterval)}`, ); - } else { + } else if (logConfiguration.enabled) { logger.info( - `${this.logPrefix()} log interval is set to ${logStatisticsInterval?.toString()}. Not logging statistics` + `${this.logPrefix()} log interval is set to ${logStatisticsInterval}. Not logging statistics`, ); } } @@ -191,75 +213,57 @@ export class PerformanceStatistics { } private addPerformanceEntryToStatistics(entry: PerformanceEntry): void { - const entryName = entry.name; // Initialize command statistics - if (!this.statistics.statisticsData.has(entryName)) { - this.statistics.statisticsData.set(entryName, {}); + if (!this.statistics.statisticsData.has(entry.name)) { + this.statistics.statisticsData.set(entry.name, {}); } // 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).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(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(entryName) - ?.timeMeasurementSeries?.push({ timestamp: entry.startTime, value: entry.duration }) - : (this.statistics.statisticsData.get(entryName).timeMeasurementSeries = - new CircularArray(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, { + .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, })); - this.statistics.statisticsData.get(entryName).medTimeMeasurement = Utils.median( - this.extractTimeSeriesValues( - this.statistics.statisticsData.get(entryName).timeMeasurementSeries - ) + const timeMeasurementValues = extractTimeSeriesValues( + this.statistics.statisticsData.get(entry.name)!.measurementTimeSeries!, ); - this.statistics.statisticsData.get(entryName).ninetyFiveThPercentileTimeMeasurement = - Utils.percentile( - this.extractTimeSeriesValues( - this.statistics.statisticsData.get(entryName).timeMeasurementSeries - ), - 95 - ); - this.statistics.statisticsData.get(entryName).stdDevTimeMeasurement = Utils.stdDeviation( - this.extractTimeSeriesValues( - this.statistics.statisticsData.get(entryName).timeMeasurementSeries - ) + 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, ); - if (Configuration.getPerformanceStorage().enabled) { - parentPort?.postMessage( - MessageChannelUtils.buildPerformanceStatisticsMessage(this.statistics) - ); + this.statistics.updatedAt = new Date(); + if ( + Configuration.getConfigurationSection( + ConfigurationSection.performanceStorage, + ).enabled + ) { + parentPort?.postMessage(buildPerformanceStatisticsMessage(this.statistics)); } } - private extractTimeSeriesValues(timeSeries: CircularArray): number[] { - return timeSeries.map((timeSeriesItem) => timeSeriesItem.value); - } - private logPrefix = (): string => { - return Utils.logPrefix(` ${this.objName} | Performance statistics`); + return logPrefix(` ${this.objName} | Performance statistics`); }; }