Commit | Line | Data |
---|---|---|
edd13439 | 1 | // Partial Copyright Jerome Benoit. 2021-2023. All Rights Reserved. |
c8eeb62b | 2 | |
01f4001e | 3 | import { type PerformanceEntry, PerformanceObserver, performance } from 'node:perf_hooks'; |
130783a7 | 4 | import type { URL } from 'node:url'; |
01f4001e | 5 | import { parentPort } from 'node:worker_threads'; |
63b48f77 | 6 | |
2896e06d | 7 | import { MessageChannelUtils } from '../charging-station'; |
268a74bb JB |
8 | import { |
9 | type IncomingRequestCommand, | |
10 | MessageType, | |
11 | type RequestCommand, | |
12 | type Statistics, | |
13 | type TimeSeries, | |
14 | } from '../types'; | |
60a74391 | 15 | import { CircularArray, Configuration, Constants, Utils, logger } from '../utils'; |
7dde0b73 | 16 | |
268a74bb | 17 | export class PerformanceStatistics { |
e7aeea18 JB |
18 | private static readonly instances: Map<string, PerformanceStatistics> = new Map< |
19 | string, | |
20 | PerformanceStatistics | |
21 | >(); | |
10068088 | 22 | |
9e23580d | 23 | private readonly objId: string; |
9f2e3130 | 24 | private readonly objName: string; |
1895299d | 25 | private performanceObserver!: PerformanceObserver; |
9e23580d | 26 | private readonly statistics: Statistics; |
1895299d | 27 | private displayInterval!: NodeJS.Timeout; |
560bcf5b | 28 | |
9f2e3130 | 29 | private constructor(objId: string, objName: string, uri: URL) { |
c0560973 | 30 | this.objId = objId; |
9f2e3130 | 31 | this.objName = objName; |
aef1b33a | 32 | this.initializePerformanceObserver(); |
e7aeea18 JB |
33 | this.statistics = { |
34 | id: this.objId ?? 'Object id not specified', | |
35 | name: this.objName ?? 'Object name not specified', | |
36 | uri: uri.toString(), | |
37 | createdAt: new Date(), | |
1e4b0e4b | 38 | statisticsData: new Map(), |
e7aeea18 | 39 | }; |
9f2e3130 JB |
40 | } |
41 | ||
844e496b JB |
42 | public static getInstance( |
43 | objId: string, | |
44 | objName: string, | |
45 | uri: URL | |
46 | ): PerformanceStatistics | undefined { | |
9f2e3130 JB |
47 | if (!PerformanceStatistics.instances.has(objId)) { |
48 | PerformanceStatistics.instances.set(objId, new PerformanceStatistics(objId, objName, uri)); | |
49 | } | |
50 | return PerformanceStatistics.instances.get(objId); | |
560bcf5b JB |
51 | } |
52 | ||
aef1b33a | 53 | public static beginMeasure(id: string): string { |
14ecae6a | 54 | const markId = `${id.charAt(0).toUpperCase()}${id.slice(1)}~${Utils.generateUUID()}`; |
c63c21bc JB |
55 | performance.mark(markId); |
56 | return markId; | |
57939a9d JB |
57 | } |
58 | ||
c63c21bc JB |
59 | public static endMeasure(name: string, markId: string): void { |
60 | performance.measure(name, markId); | |
61 | performance.clearMarks(markId); | |
c60af6ca | 62 | performance.clearMeasures(name); |
aef1b33a JB |
63 | } |
64 | ||
e7aeea18 JB |
65 | public addRequestStatistic( |
66 | command: RequestCommand | IncomingRequestCommand, | |
67 | messageType: MessageType | |
68 | ): void { | |
7f134aca | 69 | switch (messageType) { |
d2a64eb5 | 70 | case MessageType.CALL_MESSAGE: |
e7aeea18 JB |
71 | if ( |
72 | this.statistics.statisticsData.has(command) && | |
73 | this.statistics.statisticsData.get(command)?.countRequest | |
74 | ) { | |
ff4b895e | 75 | this.statistics.statisticsData.get(command).countRequest++; |
7dde0b73 | 76 | } else { |
71910904 JB |
77 | this.statistics.statisticsData.set(command, { |
78 | ...this.statistics.statisticsData.get(command), | |
79 | countRequest: 1, | |
80 | }); | |
7f134aca JB |
81 | } |
82 | break; | |
d2a64eb5 | 83 | case MessageType.CALL_RESULT_MESSAGE: |
e7aeea18 JB |
84 | if ( |
85 | this.statistics.statisticsData.has(command) && | |
86 | this.statistics.statisticsData.get(command)?.countResponse | |
87 | ) { | |
ff4b895e | 88 | this.statistics.statisticsData.get(command).countResponse++; |
7f134aca | 89 | } else { |
71910904 JB |
90 | this.statistics.statisticsData.set(command, { |
91 | ...this.statistics.statisticsData.get(command), | |
92 | countResponse: 1, | |
93 | }); | |
7dde0b73 | 94 | } |
7f134aca | 95 | break; |
d2a64eb5 | 96 | case MessageType.CALL_ERROR_MESSAGE: |
e7aeea18 JB |
97 | if ( |
98 | this.statistics.statisticsData.has(command) && | |
99 | this.statistics.statisticsData.get(command)?.countError | |
100 | ) { | |
ff4b895e | 101 | this.statistics.statisticsData.get(command).countError++; |
7f134aca | 102 | } else { |
71910904 JB |
103 | this.statistics.statisticsData.set(command, { |
104 | ...this.statistics.statisticsData.get(command), | |
105 | countError: 1, | |
106 | }); | |
7f134aca JB |
107 | } |
108 | break; | |
109 | default: | |
9534e74e | 110 | // eslint-disable-next-line @typescript-eslint/restrict-template-expressions |
9f2e3130 | 111 | logger.error(`${this.logPrefix()} wrong message type ${messageType}`); |
7f134aca | 112 | break; |
7dde0b73 JB |
113 | } |
114 | } | |
115 | ||
aef1b33a | 116 | public start(): void { |
72f041bd JB |
117 | this.startLogStatisticsInterval(); |
118 | if (Configuration.getPerformanceStorage().enabled) { | |
e7aeea18 JB |
119 | logger.info( |
120 | `${this.logPrefix()} storage enabled: type ${ | |
121 | Configuration.getPerformanceStorage().type | |
122 | }, uri: ${Configuration.getPerformanceStorage().uri}` | |
123 | ); | |
72f041bd | 124 | } |
7dde0b73 JB |
125 | } |
126 | ||
aef1b33a | 127 | public stop(): void { |
7874b0b1 JB |
128 | if (this.displayInterval) { |
129 | clearInterval(this.displayInterval); | |
dfe81c8f | 130 | delete this.displayInterval; |
7874b0b1 | 131 | } |
aef1b33a | 132 | performance.clearMarks(); |
c60af6ca | 133 | performance.clearMeasures(); |
087a502d JB |
134 | this.performanceObserver?.disconnect(); |
135 | } | |
136 | ||
137 | public restart(): void { | |
138 | this.stop(); | |
139 | this.start(); | |
136c90ba JB |
140 | } |
141 | ||
aef1b33a | 142 | private initializePerformanceObserver(): void { |
72092cfc | 143 | this.performanceObserver = new PerformanceObserver((performanceObserverList) => { |
c60af6ca | 144 | const lastPerformanceEntry = performanceObserverList.getEntries()[0]; |
9d1dc4b1 JB |
145 | // logger.debug( |
146 | // `${this.logPrefix()} '${lastPerformanceEntry.name}' performance entry: %j`, | |
147 | // lastPerformanceEntry | |
148 | // ); | |
eb835fa8 | 149 | this.addPerformanceEntryToStatistics(lastPerformanceEntry); |
a0ba4ced | 150 | }); |
aef1b33a JB |
151 | this.performanceObserver.observe({ entryTypes: ['measure'] }); |
152 | } | |
153 | ||
aef1b33a | 154 | private logStatistics(): void { |
c60af6ca JB |
155 | logger.info(`${this.logPrefix()}`, { |
156 | ...this.statistics, | |
157 | statisticsData: Utils.JSONStringifyWithMapSupport(this.statistics.statisticsData), | |
158 | }); | |
7dde0b73 JB |
159 | } |
160 | ||
72f041bd | 161 | private startLogStatisticsInterval(): void { |
dfe81c8f | 162 | if (Configuration.getLogStatisticsInterval() > 0 && !this.displayInterval) { |
aef1b33a JB |
163 | this.displayInterval = setInterval(() => { |
164 | this.logStatistics(); | |
72f041bd | 165 | }, Configuration.getLogStatisticsInterval() * 1000); |
e7aeea18 | 166 | logger.info( |
44eb6026 JB |
167 | `${this.logPrefix()} logged every ${Utils.formatDurationSeconds( |
168 | Configuration.getLogStatisticsInterval() | |
169 | )}` | |
e7aeea18 | 170 | ); |
dfe81c8f JB |
171 | } else if (this.displayInterval) { |
172 | logger.info( | |
173 | `${this.logPrefix()} already logged every ${Utils.formatDurationSeconds( | |
174 | Configuration.getLogStatisticsInterval() | |
175 | )}` | |
176 | ); | |
aef1b33a | 177 | } else { |
e7aeea18 | 178 | logger.info( |
72092cfc | 179 | `${this.logPrefix()} log interval is set to ${Configuration.getLogStatisticsInterval()?.toString()}. Not logging statistics` |
e7aeea18 | 180 | ); |
7dde0b73 JB |
181 | } |
182 | } | |
183 | ||
6bf6769e | 184 | private median(dataSet: number[]): number { |
5f7e72c1 | 185 | if (Array.isArray(dataSet) === true && dataSet.length === 1) { |
6bf6769e JB |
186 | return dataSet[0]; |
187 | } | |
e7aeea18 | 188 | const sortedDataSet = dataSet.slice().sort((a, b) => a - b); |
6bf6769e JB |
189 | const middleIndex = Math.floor(sortedDataSet.length / 2); |
190 | if (sortedDataSet.length % 2) { | |
191 | return sortedDataSet[middleIndex / 2]; | |
192 | } | |
e7aeea18 | 193 | return (sortedDataSet[middleIndex - 1] + sortedDataSet[middleIndex]) / 2; |
6bf6769e JB |
194 | } |
195 | ||
b49422c6 JB |
196 | // TODO: use order statistics tree https://en.wikipedia.org/wiki/Order_statistic_tree |
197 | private percentile(dataSet: number[], percentile: number): number { | |
198 | if (percentile < 0 && percentile > 100) { | |
199 | throw new RangeError('Percentile is not between 0 and 100'); | |
200 | } | |
201 | if (Utils.isEmptyArray(dataSet)) { | |
202 | return 0; | |
203 | } | |
e7aeea18 | 204 | const sortedDataSet = dataSet.slice().sort((a, b) => a - b); |
b49422c6 JB |
205 | if (percentile === 0) { |
206 | return sortedDataSet[0]; | |
207 | } | |
208 | if (percentile === 100) { | |
209 | return sortedDataSet[sortedDataSet.length - 1]; | |
210 | } | |
e7aeea18 | 211 | const percentileIndex = (percentile / 100) * sortedDataSet.length - 1; |
b49422c6 JB |
212 | if (Number.isInteger(percentileIndex)) { |
213 | return (sortedDataSet[percentileIndex] + sortedDataSet[percentileIndex + 1]) / 2; | |
214 | } | |
215 | return sortedDataSet[Math.round(percentileIndex)]; | |
216 | } | |
217 | ||
aeada1fa JB |
218 | private stdDeviation(dataSet: number[]): number { |
219 | let totalDataSet = 0; | |
220 | for (const data of dataSet) { | |
221 | totalDataSet += data; | |
222 | } | |
223 | const dataSetMean = totalDataSet / dataSet.length; | |
224 | let totalGeometricDeviation = 0; | |
225 | for (const data of dataSet) { | |
226 | const deviation = data - dataSetMean; | |
227 | totalGeometricDeviation += deviation * deviation; | |
228 | } | |
229 | return Math.sqrt(totalGeometricDeviation / dataSet.length); | |
230 | } | |
231 | ||
b49422c6 | 232 | private addPerformanceEntryToStatistics(entry: PerformanceEntry): void { |
976d11ec | 233 | const entryName = entry.name; |
7ec46a9a | 234 | // Initialize command statistics |
ff4b895e | 235 | if (!this.statistics.statisticsData.has(entryName)) { |
abe9e9dd | 236 | this.statistics.statisticsData.set(entryName, {}); |
7ec46a9a | 237 | } |
b49422c6 | 238 | // Update current statistics |
a6b3c6c3 | 239 | this.statistics.updatedAt = new Date(); |
e7aeea18 JB |
240 | this.statistics.statisticsData.get(entryName).countTimeMeasurement = |
241 | this.statistics.statisticsData.get(entryName)?.countTimeMeasurement | |
242 | ? this.statistics.statisticsData.get(entryName).countTimeMeasurement + 1 | |
243 | : 1; | |
ff4b895e | 244 | this.statistics.statisticsData.get(entryName).currentTimeMeasurement = entry.duration; |
e7aeea18 JB |
245 | this.statistics.statisticsData.get(entryName).minTimeMeasurement = |
246 | this.statistics.statisticsData.get(entryName)?.minTimeMeasurement | |
247 | ? this.statistics.statisticsData.get(entryName).minTimeMeasurement > entry.duration | |
248 | ? entry.duration | |
249 | : this.statistics.statisticsData.get(entryName).minTimeMeasurement | |
250 | : entry.duration; | |
251 | this.statistics.statisticsData.get(entryName).maxTimeMeasurement = | |
252 | this.statistics.statisticsData.get(entryName)?.maxTimeMeasurement | |
253 | ? this.statistics.statisticsData.get(entryName).maxTimeMeasurement < entry.duration | |
254 | ? entry.duration | |
255 | : this.statistics.statisticsData.get(entryName).maxTimeMeasurement | |
256 | : entry.duration; | |
257 | this.statistics.statisticsData.get(entryName).totalTimeMeasurement = | |
258 | this.statistics.statisticsData.get(entryName)?.totalTimeMeasurement | |
259 | ? this.statistics.statisticsData.get(entryName).totalTimeMeasurement + entry.duration | |
260 | : entry.duration; | |
261 | this.statistics.statisticsData.get(entryName).avgTimeMeasurement = | |
262 | this.statistics.statisticsData.get(entryName).totalTimeMeasurement / | |
263 | this.statistics.statisticsData.get(entryName).countTimeMeasurement; | |
9a15316c | 264 | this.statistics.statisticsData.get(entryName)?.timeMeasurementSeries instanceof CircularArray |
e7aeea18 JB |
265 | ? this.statistics.statisticsData |
266 | .get(entryName) | |
72092cfc | 267 | ?.timeMeasurementSeries?.push({ timestamp: entry.startTime, value: entry.duration }) |
e7aeea18 | 268 | : (this.statistics.statisticsData.get(entryName).timeMeasurementSeries = |
9a15316c | 269 | new CircularArray<TimeSeries>(Constants.DEFAULT_CIRCULAR_BUFFER_CAPACITY, { |
e7aeea18 JB |
270 | timestamp: entry.startTime, |
271 | value: entry.duration, | |
272 | })); | |
273 | this.statistics.statisticsData.get(entryName).medTimeMeasurement = this.median( | |
274 | this.extractTimeSeriesValues( | |
275 | this.statistics.statisticsData.get(entryName).timeMeasurementSeries | |
276 | ) | |
277 | ); | |
278 | this.statistics.statisticsData.get(entryName).ninetyFiveThPercentileTimeMeasurement = | |
279 | this.percentile( | |
280 | this.extractTimeSeriesValues( | |
281 | this.statistics.statisticsData.get(entryName).timeMeasurementSeries | |
282 | ), | |
283 | 95 | |
284 | ); | |
285 | this.statistics.statisticsData.get(entryName).stdDevTimeMeasurement = this.stdDeviation( | |
286 | this.extractTimeSeriesValues( | |
287 | this.statistics.statisticsData.get(entryName).timeMeasurementSeries | |
288 | ) | |
289 | ); | |
72f041bd | 290 | if (Configuration.getPerformanceStorage().enabled) { |
1895299d | 291 | parentPort?.postMessage( |
32de5a57 LM |
292 | MessageChannelUtils.buildPerformanceStatisticsMessage(this.statistics) |
293 | ); | |
72f041bd | 294 | } |
7ec46a9a JB |
295 | } |
296 | ||
0c142310 | 297 | private extractTimeSeriesValues(timeSeries: CircularArray<TimeSeries>): number[] { |
72092cfc | 298 | return timeSeries.map((timeSeriesItem) => timeSeriesItem.value); |
0c142310 JB |
299 | } |
300 | ||
8b7072dc | 301 | private logPrefix = (): string => { |
9f2e3130 | 302 | return Utils.logPrefix(` ${this.objName} | Performance statistics`); |
8b7072dc | 303 | }; |
7dde0b73 | 304 | } |