1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
|
# Performance measurement APIs
<!--introduced_in=v8.5.0-->
> Stability: 2 - Stable
<!-- source_link=lib/perf_hooks.js -->
This module provides an implementation of a subset of the W3C
[Web Performance APIs][] as well as additional APIs for
Node.js-specific performance measurements.
Node.js supports the following [Web Performance APIs][]:
* [High Resolution Time][]
* [Performance Timeline][]
* [User Timing][]
```js
const { PerformanceObserver, performance } = require('perf_hooks');
const obs = new PerformanceObserver((items) => {
console.log(items.getEntries()[0].duration);
performance.clearMarks();
});
obs.observe({ entryTypes: ['measure'] });
performance.measure('Start to Now');
performance.mark('A');
doSomeLongRunningProcess(() => {
performance.measure('A to Now', 'A');
performance.mark('B');
performance.measure('A to B', 'A', 'B');
});
```
## `perf_hooks.performance`
<!-- YAML
added: v8.5.0
-->
An object that can be used to collect performance metrics from the current
Node.js instance. It is similar to [`window.performance`][] in browsers.
### `performance.clearMarks([name])`
<!-- YAML
added: v8.5.0
-->
* `name` {string}
If `name` is not provided, removes all `PerformanceMark` objects from the
Performance Timeline. If `name` is provided, removes only the named mark.
### `performance.mark([name])`
<!-- YAML
added: v8.5.0
-->
* `name` {string}
Creates a new `PerformanceMark` entry in the Performance Timeline. A
`PerformanceMark` is a subclass of `PerformanceEntry` whose
`performanceEntry.entryType` is always `'mark'`, and whose
`performanceEntry.duration` is always `0`. Performance marks are used
to mark specific significant moments in the Performance Timeline.
### `performance.measure(name[, startMark[, endMark]])`
<!-- YAML
added: v8.5.0
changes:
- version:
- v13.13.0
- v12.16.3
pr-url: https://github.com/nodejs/node/pull/32651
description: Make `startMark` and `endMark` parameters optional.
-->
* `name` {string}
* `startMark` {string} Optional.
* `endMark` {string} Optional.
Creates a new `PerformanceMeasure` entry in the Performance Timeline. A
`PerformanceMeasure` is a subclass of `PerformanceEntry` whose
`performanceEntry.entryType` is always `'measure'`, and whose
`performanceEntry.duration` measures the number of milliseconds elapsed since
`startMark` and `endMark`.
The `startMark` argument may identify any *existing* `PerformanceMark` in the
Performance Timeline, or *may* identify any of the timestamp properties
provided by the `PerformanceNodeTiming` class. If the named `startMark` does
not exist, then `startMark` is set to [`timeOrigin`][] by default.
The optional `endMark` argument must identify any *existing* `PerformanceMark`
in the Performance Timeline or any of the timestamp properties provided by the
`PerformanceNodeTiming` class. `endMark` will be `performance.now()`
if no parameter is passed, otherwise if the named `endMark` does not exist, an
error will be thrown.
### `performance.nodeTiming`
<!-- YAML
added: v8.5.0
-->
* {PerformanceNodeTiming}
_This property is an extension by Node.js. It is not available in Web browsers._
An instance of the `PerformanceNodeTiming` class that provides performance
metrics for specific Node.js operational milestones.
### `performance.now()`
<!-- YAML
added: v8.5.0
-->
* Returns: {number}
Returns the current high resolution millisecond timestamp, where 0 represents
the start of the current `node` process.
### `performance.timeOrigin`
<!-- YAML
added: v8.5.0
-->
* {number}
The [`timeOrigin`][] specifies the high resolution millisecond timestamp at
which the current `node` process began, measured in Unix time.
### `performance.timerify(fn)`
<!-- YAML
added: v8.5.0
-->
* `fn` {Function}
_This property is an extension by Node.js. It is not available in Web browsers._
Wraps a function within a new function that measures the running time of the
wrapped function. A `PerformanceObserver` must be subscribed to the `'function'`
event type in order for the timing details to be accessed.
```js
const {
performance,
PerformanceObserver
} = require('perf_hooks');
function someFunction() {
console.log('hello world');
}
const wrapped = performance.timerify(someFunction);
const obs = new PerformanceObserver((list) => {
console.log(list.getEntries()[0].duration);
obs.disconnect();
});
obs.observe({ entryTypes: ['function'] });
// A performance timeline entry will be created
wrapped();
```
## Class: `PerformanceEntry`
<!-- YAML
added: v8.5.0
-->
### `performanceEntry.duration`
<!-- YAML
added: v8.5.0
-->
* {number}
The total number of milliseconds elapsed for this entry. This value will not
be meaningful for all Performance Entry types.
### `performanceEntry.name`
<!-- YAML
added: v8.5.0
-->
* {string}
The name of the performance entry.
### `performanceEntry.startTime`
<!-- YAML
added: v8.5.0
-->
* {number}
The high resolution millisecond timestamp marking the starting time of the
Performance Entry.
### `performanceEntry.entryType`
<!-- YAML
added: v8.5.0
-->
* {string}
The type of the performance entry. It may be one of:
* `'node'` (Node.js only)
* `'mark'` (available on the Web)
* `'measure'` (available on the Web)
* `'gc'` (Node.js only)
* `'function'` (Node.js only)
* `'http2'` (Node.js only)
* `'http'` (Node.js only)
### `performanceEntry.kind`
<!-- YAML
added: v8.5.0
-->
* {number}
_This property is an extension by Node.js. It is not available in Web browsers._
When `performanceEntry.entryType` is equal to `'gc'`, the `performance.kind`
property identifies the type of garbage collection operation that occurred.
The value may be one of:
* `perf_hooks.constants.NODE_PERFORMANCE_GC_MAJOR`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_MINOR`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_INCREMENTAL`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_WEAKCB`
### performanceEntry.flags
<!-- YAML
added:
- v13.9.0
- v12.17.0
-->
* {number}
_This property is an extension by Node.js. It is not available in Web browsers._
When `performanceEntry.entryType` is equal to `'gc'`, the `performance.flags`
property contains additional information about garbage collection operation.
The value may be one of:
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_NO`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_CONSTRUCT_RETAINED`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_FORCED`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SYNCHRONOUS_PHANTOM_PROCESSING`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_AVAILABLE_GARBAGE`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_ALL_EXTERNAL_MEMORY`
* `perf_hooks.constants.NODE_PERFORMANCE_GC_FLAGS_SCHEDULE_IDLE`
## Class: `PerformanceNodeTiming`
<!-- YAML
added: v8.5.0
-->
* Extends: {PerformanceEntry}
_This property is an extension by Node.js. It is not available in Web browsers._
Provides timing details for Node.js itself. The constructor of this class
is not exposed to users.
### `performanceNodeTiming.bootstrapComplete`
<!-- YAML
added: v8.5.0
-->
* {number}
The high resolution millisecond timestamp at which the Node.js process
completed bootstrapping. If bootstrapping has not yet finished, the property
has the value of -1.
### `performanceNodeTiming.environment`
<!-- YAML
added: v8.5.0
-->
* {number}
The high resolution millisecond timestamp at which the Node.js environment was
initialized.
### `performanceNodeTiming.loopExit`
<!-- YAML
added: v8.5.0
-->
* {number}
The high resolution millisecond timestamp at which the Node.js event loop
exited. If the event loop has not yet exited, the property has the value of -1.
It can only have a value of not -1 in a handler of the [`'exit'`][] event.
### `performanceNodeTiming.loopStart`
<!-- YAML
added: v8.5.0
-->
* {number}
The high resolution millisecond timestamp at which the Node.js event loop
started. If the event loop has not yet started (e.g., in the first tick of the
main script), the property has the value of -1.
### `performanceNodeTiming.nodeStart`
<!-- YAML
added: v8.5.0
-->
* {number}
The high resolution millisecond timestamp at which the Node.js process was
initialized.
### `performanceNodeTiming.v8Start`
<!-- YAML
added: v8.5.0
-->
* {number}
The high resolution millisecond timestamp at which the V8 platform was
initialized.
## Class: `perf_hooks.PerformanceObserver`
### `new PerformanceObserver(callback)`
<!-- YAML
added: v8.5.0
-->
* `callback` {Function}
* `list` {PerformanceObserverEntryList}
* `observer` {PerformanceObserver}
`PerformanceObserver` objects provide notifications when new
`PerformanceEntry` instances have been added to the Performance Timeline.
```js
const {
performance,
PerformanceObserver
} = require('perf_hooks');
const obs = new PerformanceObserver((list, observer) => {
console.log(list.getEntries());
observer.disconnect();
});
obs.observe({ entryTypes: ['mark'], buffered: true });
performance.mark('test');
```
Because `PerformanceObserver` instances introduce their own additional
performance overhead, instances should not be left subscribed to notifications
indefinitely. Users should disconnect observers as soon as they are no
longer needed.
The `callback` is invoked when a `PerformanceObserver` is
notified about new `PerformanceEntry` instances. The callback receives a
`PerformanceObserverEntryList` instance and a reference to the
`PerformanceObserver`.
### `performanceObserver.disconnect()`
<!-- YAML
added: v8.5.0
-->
Disconnects the `PerformanceObserver` instance from all notifications.
### `performanceObserver.observe(options)`
<!-- YAML
added: v8.5.0
-->
* `options` {Object}
* `entryTypes` {string[]} An array of strings identifying the types of
`PerformanceEntry` instances the observer is interested in. If not
provided an error will be thrown.
* `buffered` {boolean} If true, the notification callback will be
called using `setImmediate()` and multiple `PerformanceEntry` instance
notifications will be buffered internally. If `false`, notifications will
be immediate and synchronous. **Default:** `false`.
Subscribes the `PerformanceObserver` instance to notifications of new
`PerformanceEntry` instances identified by `options.entryTypes`.
When `options.buffered` is `false`, the `callback` will be invoked once for
every `PerformanceEntry` instance:
```js
const {
performance,
PerformanceObserver
} = require('perf_hooks');
const obs = new PerformanceObserver((list, observer) => {
// Called three times synchronously. `list` contains one item.
});
obs.observe({ entryTypes: ['mark'] });
for (let n = 0; n < 3; n++)
performance.mark(`test${n}`);
```
```js
const {
performance,
PerformanceObserver
} = require('perf_hooks');
const obs = new PerformanceObserver((list, observer) => {
// Called once. `list` contains three items.
});
obs.observe({ entryTypes: ['mark'], buffered: true });
for (let n = 0; n < 3; n++)
performance.mark(`test${n}`);
```
## Class: `PerformanceObserverEntryList`
<!-- YAML
added: v8.5.0
-->
The `PerformanceObserverEntryList` class is used to provide access to the
`PerformanceEntry` instances passed to a `PerformanceObserver`.
The constructor of this class is not exposed to users.
### `performanceObserverEntryList.getEntries()`
<!-- YAML
added: v8.5.0
-->
* Returns: {PerformanceEntry[]}
Returns a list of `PerformanceEntry` objects in chronological order
with respect to `performanceEntry.startTime`.
### `performanceObserverEntryList.getEntriesByName(name[, type])`
<!-- YAML
added: v8.5.0
-->
* `name` {string}
* `type` {string}
* Returns: {PerformanceEntry[]}
Returns a list of `PerformanceEntry` objects in chronological order
with respect to `performanceEntry.startTime` whose `performanceEntry.name` is
equal to `name`, and optionally, whose `performanceEntry.entryType` is equal to
`type`.
### `performanceObserverEntryList.getEntriesByType(type)`
<!-- YAML
added: v8.5.0
-->
* `type` {string}
* Returns: {PerformanceEntry[]}
Returns a list of `PerformanceEntry` objects in chronological order
with respect to `performanceEntry.startTime` whose `performanceEntry.entryType`
is equal to `type`.
## `perf_hooks.monitorEventLoopDelay([options])`
<!-- YAML
added: v11.10.0
-->
* `options` {Object}
* `resolution` {number} The sampling rate in milliseconds. Must be greater
than zero. **Default:** `10`.
* Returns: {Histogram}
_This property is an extension by Node.js. It is not available in Web browsers._
Creates a `Histogram` object that samples and reports the event loop delay
over time. The delays will be reported in nanoseconds.
Using a timer to detect approximate event loop delay works because the
execution of timers is tied specifically to the lifecycle of the libuv
event loop. That is, a delay in the loop will cause a delay in the execution
of the timer, and those delays are specifically what this API is intended to
detect.
```js
const { monitorEventLoopDelay } = require('perf_hooks');
const h = monitorEventLoopDelay({ resolution: 20 });
h.enable();
// Do something.
h.disable();
console.log(h.min);
console.log(h.max);
console.log(h.mean);
console.log(h.stddev);
console.log(h.percentiles);
console.log(h.percentile(50));
console.log(h.percentile(99));
```
### Class: `Histogram`
<!-- YAML
added: v11.10.0
-->
Tracks the event loop delay at a given sampling rate. The constructor of
this class not exposed to users.
_This property is an extension by Node.js. It is not available in Web browsers._
#### `histogram.disable()`
<!-- YAML
added: v11.10.0
-->
* Returns: {boolean}
Disables the event loop delay sample timer. Returns `true` if the timer was
stopped, `false` if it was already stopped.
#### `histogram.enable()`
<!-- YAML
added: v11.10.0
-->
* Returns: {boolean}
Enables the event loop delay sample timer. Returns `true` if the timer was
started, `false` if it was already started.
#### `histogram.exceeds`
<!-- YAML
added: v11.10.0
-->
* {number}
The number of times the event loop delay exceeded the maximum 1 hour event
loop delay threshold.
#### `histogram.max`
<!-- YAML
added: v11.10.0
-->
* {number}
The maximum recorded event loop delay.
#### `histogram.mean`
<!-- YAML
added: v11.10.0
-->
* {number}
The mean of the recorded event loop delays.
#### `histogram.min`
<!-- YAML
added: v11.10.0
-->
* {number}
The minimum recorded event loop delay.
#### `histogram.percentile(percentile)`
<!-- YAML
added: v11.10.0
-->
* `percentile` {number} A percentile value between 1 and 100.
* Returns: {number}
Returns the value at the given percentile.
#### `histogram.percentiles`
<!-- YAML
added: v11.10.0
-->
* {Map}
Returns a `Map` object detailing the accumulated percentile distribution.
#### `histogram.reset()`
<!-- YAML
added: v11.10.0
-->
Resets the collected histogram data.
#### `histogram.stddev`
<!-- YAML
added: v11.10.0
-->
* {number}
The standard deviation of the recorded event loop delays.
## Examples
### Measuring the duration of async operations
The following example uses the [Async Hooks][] and Performance APIs to measure
the actual duration of a Timeout operation (including the amount of time it took
to execute the callback).
```js
'use strict';
const async_hooks = require('async_hooks');
const {
performance,
PerformanceObserver
} = require('perf_hooks');
const set = new Set();
const hook = async_hooks.createHook({
init(id, type) {
if (type === 'Timeout') {
performance.mark(`Timeout-${id}-Init`);
set.add(id);
}
},
destroy(id) {
if (set.has(id)) {
set.delete(id);
performance.mark(`Timeout-${id}-Destroy`);
performance.measure(`Timeout-${id}`,
`Timeout-${id}-Init`,
`Timeout-${id}-Destroy`);
}
}
});
hook.enable();
const obs = new PerformanceObserver((list, observer) => {
console.log(list.getEntries()[0]);
performance.clearMarks();
observer.disconnect();
});
obs.observe({ entryTypes: ['measure'], buffered: true });
setTimeout(() => {}, 1000);
```
### Measuring how long it takes to load dependencies
The following example measures the duration of `require()` operations to load
dependencies:
<!-- eslint-disable no-global-assign -->
```js
'use strict';
const {
performance,
PerformanceObserver
} = require('perf_hooks');
const mod = require('module');
// Monkey patch the require function
mod.Module.prototype.require =
performance.timerify(mod.Module.prototype.require);
require = performance.timerify(require);
// Activate the observer
const obs = new PerformanceObserver((list) => {
const entries = list.getEntries();
entries.forEach((entry) => {
console.log(`require('${entry[0]}')`, entry.duration);
});
obs.disconnect();
});
obs.observe({ entryTypes: ['function'], buffered: true });
require('some-module');
```
[`'exit'`]: process.html#process_event_exit
[`timeOrigin`]: https://w3c.github.io/hr-time/#dom-performance-timeorigin
[`window.performance`]: https://developer.mozilla.org/en-US/docs/Web/API/Window/performance
[Async Hooks]: async_hooks.html
[High Resolution Time]: https://www.w3.org/TR/hr-time-2
[Performance Timeline]: https://w3c.github.io/performance-timeline/
[Web Performance APIs]: https://w3c.github.io/perf-timing-primer/
[User Timing]: https://www.w3.org/TR/user-timing/
|