// 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 { PerformanceEntry, PerformanceObserver, performance } from 'perf_hooks';
-import { parentPort } from 'worker_threads';
+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, TimeSeries } from '../types/Statistics';
-import { CircularArray } from '../utils/CircularArray';
-import Configuration from '../utils/Configuration';
-import Constants from '../utils/Constants';
-import logger from '../utils/Logger';
-import Utils from '../utils/Utils';
+import {
+ ConfigurationSection,
+ type IncomingRequestCommand,
+ type LogConfiguration,
+ MessageType,
+ type RequestCommand,
+ type Statistics,
+ type StorageConfiguration,
+ type TimestampedData,
+} from '../types';
+import {
+ CircularArray,
+ Configuration,
+ Constants,
+ JSONStringifyWithMapSupport,
+ buildPerformanceStatisticsMessage,
+ extractTimeSeriesValues,
+ formatDurationSeconds,
+ generateUUID,
+ logPrefix,
+ logger,
+ median,
+ nthPercentile,
+ stdDeviation,
+} from '../utils';
-export default class PerformanceStatistics {
+export class PerformanceStatistics {
private static readonly instances: Map<string, PerformanceStatistics> = new Map<
string,
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;
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));
}
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;
}
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,
- Object.assign({ countRequest: 1 }, this.statistics.statisticsData.get(command))
- );
+ this.statistics.statisticsData.set(command, {
+ ...this.statistics.statisticsData.get(command),
+ 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,
- Object.assign({ countResponse: 1 }, this.statistics.statisticsData.get(command))
- );
+ this.statistics.statisticsData.set(command, {
+ ...this.statistics.statisticsData.get(command),
+ 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,
- Object.assign({ countError: 1 }, this.statistics.statisticsData.get(command))
- );
+ this.statistics.statisticsData.set(command, {
+ ...this.statistics.statisticsData.get(command),
+ errorCount: 1,
+ });
}
break;
default:
public start(): void {
this.startLogStatisticsInterval();
- if (Configuration.getPerformanceStorage().enabled) {
+ if (
+ Configuration.getConfigurationSection<StorageConfiguration>(
+ ConfigurationSection.performanceStorage,
+ ).enabled
+ ) {
logger.info(
`${this.logPrefix()} storage enabled: type ${
- Configuration.getPerformanceStorage().type
- }, uri: ${Configuration.getPerformanceStorage().uri}`
+ Configuration.getConfigurationSection<StorageConfiguration>(
+ ConfigurationSection.performanceStorage,
+ ).type
+ }, uri: ${
+ Configuration.getConfigurationSection<StorageConfiguration>(
+ ConfigurationSection.performanceStorage,
+ ).uri
+ }`,
);
}
}
public stop(): void {
- if (this.displayInterval) {
- clearInterval(this.displayInterval);
- }
+ this.stopLogStatisticsInterval();
performance.clearMarks();
performance.clearMeasures();
this.performanceObserver?.disconnect();
const lastPerformanceEntry = performanceObserverList.getEntries()[0];
// logger.debug(
// `${this.logPrefix()} '${lastPerformanceEntry.name}' performance entry: %j`,
- // lastPerformanceEntry
+ // lastPerformanceEntry,
// );
this.addPerformanceEntryToStatistics(lastPerformanceEntry);
});
private logStatistics(): void {
logger.info(`${this.logPrefix()}`, {
...this.statistics,
- statisticsData: Utils.JSONStringifyWithMapSupport(this.statistics.statisticsData),
+ statisticsData: JSONStringifyWithMapSupport(this.statistics.statisticsData),
});
}
private startLogStatisticsInterval(): void {
- if (Configuration.getLogStatisticsInterval() > 0) {
+ const logStatisticsInterval = Configuration.getConfigurationSection<LogConfiguration>(
+ ConfigurationSection.log,
+ ).enabled
+ ? Configuration.getConfigurationSection<LogConfiguration>(ConfigurationSection.log)
+ .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.getConfigurationSection<LogConfiguration>(ConfigurationSection.log).enabled
+ ) {
+ logger.info(
+ `${this.logPrefix()} log interval is set to ${logStatisticsInterval?.toString()}. Not logging statistics`,
);
}
}
- private median(dataSet: number[]): number {
- 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) {
- 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 {
}
// 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(entryName)!.timeMeasurementCount =
+ (this.statistics.statisticsData.get(entryName)?.timeMeasurementCount ?? 0) + 1;
+ this.statistics.statisticsData.get(entryName)!.currentTimeMeasurement = 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 ?? 0) + entry.duration;
+ this.statistics.statisticsData.get(entryName)!.avgTimeMeasurement =
+ this.statistics.statisticsData.get(entryName)!.totalTimeMeasurement! /
+ this.statistics.statisticsData.get(entryName)!.timeMeasurementCount!;
+ 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<TimeSeries>(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, {
+ ?.measurementTimeSeries?.push({ timestamp: entry.startTime, value: entry.duration })
+ : (this.statistics.statisticsData.get(entryName)!.measurementTimeSeries =
+ new CircularArray<TimestampedData>(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, {
timestamp: entry.startTime,
value: entry.duration,
}));
- this.statistics.statisticsData.get(entryName).medTimeMeasurement = this.median(
- this.extractTimeSeriesValues(
- this.statistics.statisticsData.get(entryName).timeMeasurementSeries
- )
+ this.statistics.statisticsData.get(entryName)!.medTimeMeasurement = median(
+ extractTimeSeriesValues(
+ this.statistics.statisticsData.get(entryName)!.measurementTimeSeries as TimestampedData[],
+ ),
);
- this.statistics.statisticsData.get(entryName).ninetyFiveThPercentileTimeMeasurement =
- this.percentile(
- this.extractTimeSeriesValues(
- this.statistics.statisticsData.get(entryName).timeMeasurementSeries
+ this.statistics.statisticsData.get(entryName)!.ninetyFiveThPercentileTimeMeasurement =
+ nthPercentile(
+ extractTimeSeriesValues(
+ this.statistics.statisticsData.get(entryName)!.measurementTimeSeries as TimestampedData[],
),
- 95
+ 95,
);
- this.statistics.statisticsData.get(entryName).stdDevTimeMeasurement = this.stdDeviation(
- this.extractTimeSeriesValues(
- this.statistics.statisticsData.get(entryName).timeMeasurementSeries
- )
+ this.statistics.statisticsData.get(entryName)!.stdDevTimeMeasurement = stdDeviation(
+ extractTimeSeriesValues(
+ this.statistics.statisticsData.get(entryName)!.measurementTimeSeries as TimestampedData[],
+ ),
);
- if (Configuration.getPerformanceStorage().enabled) {
- parentPort?.postMessage(
- MessageChannelUtils.buildPerformanceStatisticsMessage(this.statistics)
- );
+ if (
+ Configuration.getConfigurationSection<StorageConfiguration>(
+ ConfigurationSection.performanceStorage,
+ ).enabled
+ ) {
+ parentPort?.postMessage(buildPerformanceStatisticsMessage(this.statistics));
}
}
- private extractTimeSeriesValues(timeSeries: CircularArray<TimeSeries>): number[] {
- return timeSeries.map((timeSeriesItem) => timeSeriesItem.value);
- }
-
private logPrefix = (): string => {
- return Utils.logPrefix(` ${this.objName} | Performance statistics`);
+ return logPrefix(` ${this.objName} | Performance statistics`);
};
}
repositories / e-mobility-charging-stations-simulator.git / blobdiff