X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;ds=sidebyside;f=src%2Fperformance%2FPerformanceStatistics.ts;h=a4dfd0b35c86ee26d178498f8a21814f3cee683e;hb=dd08d43db9ea82b12b64289c68cb88ed6865b4de;hp=6a5b454f9c5d868f74ad3bc62c606324adfebe9e;hpb=6c1761d470507ea23d186be61b94ca7375c5144a;p=e-mobility-charging-stations-simulator.git diff --git a/src/performance/PerformanceStatistics.ts b/src/performance/PerformanceStatistics.ts index 6a5b454f..a4dfd0b3 100644 --- a/src/performance/PerformanceStatistics.ts +++ b/src/performance/PerformanceStatistics.ts @@ -1,21 +1,20 @@ -// 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 type { 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 type { IncomingRequestCommand, RequestCommand } from '../types/ocpp/Requests'; -import type Statistics from '../types/Statistics'; -// eslint-disable-next-line no-duplicate-imports -import type { 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 { MessageChannelUtils } from '../charging-station'; +import { + type IncomingRequestCommand, + MessageType, + type RequestCommand, + type Statistics, + type TimeSeries, +} from '../types'; +import { CircularArray, Configuration, Constants, Utils, logger } from '../utils'; -export default class PerformanceStatistics { +export class PerformanceStatistics { private static readonly instances: Map = new Map< string, PerformanceStatistics @@ -23,9 +22,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; @@ -36,7 +35,7 @@ export default class PerformanceStatistics { name: this.objName ?? 'Object name not specified', uri: uri.toString(), createdAt: new Date(), - statisticsData: new Map>(), + statisticsData: new Map(), }; } @@ -52,7 +51,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)}~${Utils.generateUUID()}`; performance.mark(markId); return markId; } @@ -60,6 +59,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( @@ -74,10 +74,10 @@ export default class PerformanceStatistics { ) { 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: @@ -87,10 +87,10 @@ export default class PerformanceStatistics { ) { 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: @@ -100,10 +100,10 @@ export default class PerformanceStatistics { ) { 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: @@ -125,10 +125,9 @@ export default class PerformanceStatistics { } public stop(): void { - if (this.displayInterval) { - clearInterval(this.displayInterval); - } + this.stopLogStatisticsInterval(); performance.clearMarks(); + performance.clearMeasures(); this.performanceObserver?.disconnect(); } @@ -138,48 +137,60 @@ 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 { - if (Configuration.getLogStatisticsInterval() > 0) { + const logStatisticsInterval = Configuration.getLogStatisticsInterval(); + if (logStatisticsInterval > 0 && !this.displayInterval) { this.displayInterval = setInterval(() => { this.logStatistics(); - }, Configuration.getLogStatisticsInterval() * 1000); + }, logStatisticsInterval * 1000); + logger.info( + `${this.logPrefix()} logged every ${Utils.formatDurationSeconds(logStatisticsInterval)}` + ); + } else if (this.displayInterval) { logger.info( - this.logPrefix() + - ' logged every ' + - Utils.formatDurationSeconds(Configuration.getLogStatisticsInterval()) + `${this.logPrefix()} already logged every ${Utils.formatDurationSeconds( + logStatisticsInterval + )}` ); } else { logger.info( - this.logPrefix() + - ' log interval is set to ' + - Configuration.getLogStatisticsInterval().toString() + - '. Not logging statistics' + `${this.logPrefix()} log interval is set to ${logStatisticsInterval?.toString()}. Not logging statistics` ); } } + private stopLogStatisticsInterval(): void { + if (this.displayInterval) { + clearInterval(this.displayInterval); + delete this.displayInterval; + } + } + 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 middleIndex = Math.floor(sortedDataSet.length / 2); - if (sortedDataSet.length % 2) { + if (sortedDataSet.length % 2 === 0) { return sortedDataSet[middleIndex / 2]; } return (sortedDataSet[middleIndex - 1] + sortedDataSet[middleIndex]) / 2; @@ -222,12 +233,7 @@ export default class PerformanceStatistics { } 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, {}); @@ -258,12 +264,12 @@ export default class PerformanceStatistics { 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)?.timeMeasurementSeries instanceof CircularArray ? this.statistics.statisticsData .get(entryName) - .timeMeasurementSeries.push({ timestamp: entry.startTime, value: entry.duration }) + ?.timeMeasurementSeries?.push({ timestamp: entry.startTime, value: entry.duration }) : (this.statistics.statisticsData.get(entryName).timeMeasurementSeries = - new CircularArray(DEFAULT_CIRCULAR_ARRAY_SIZE, { + new CircularArray(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, { timestamp: entry.startTime, value: entry.duration, })); @@ -285,7 +291,7 @@ export default class PerformanceStatistics { ) ); if (Configuration.getPerformanceStorage().enabled) { - parentPort.postMessage( + parentPort?.postMessage( MessageChannelUtils.buildPerformanceStatisticsMessage(this.statistics) ); } @@ -295,7 +301,7 @@ export default class PerformanceStatistics { return timeSeries.map((timeSeriesItem) => timeSeriesItem.value); } - private logPrefix(): string { + private logPrefix = (): string => { return Utils.logPrefix(` ${this.objName} | Performance statistics`); - } + }; }