summaryrefslogtreecommitdiff
path: root/doc/api/perf_hooks.md
diff options
context:
space:
mode:
authorJames M Snell <jasnell@gmail.com>2018-01-10 09:42:10 -0800
committerJames M Snell <jasnell@gmail.com>2018-01-31 15:24:58 -0800
commit6bcd31f2f4a518f70646a72e7a6e42aa6ca90469 (patch)
tree39e2cb0645a6fd8b907a87a37c555fd86bdda26b /doc/api/perf_hooks.md
parent6e312c5cc7300e8c5d23301c970a1ac978950ff5 (diff)
downloadandroid-node-v8-6bcd31f2f4a518f70646a72e7a6e42aa6ca90469.tar.gz
android-node-v8-6bcd31f2f4a518f70646a72e7a6e42aa6ca90469.tar.bz2
android-node-v8-6bcd31f2f4a518f70646a72e7a6e42aa6ca90469.zip
perf_hooks: add warning when too many entries in the timeline
PR-URL: https://github.com/nodejs/node/pull/18087 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc/api/perf_hooks.md')
-rw-r--r--doc/api/perf_hooks.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md
index 2f2910af93..62b035f678 100644
--- a/doc/api/perf_hooks.md
+++ b/doc/api/perf_hooks.md
@@ -125,6 +125,20 @@ Creates a new `PerformanceMark` entry in the Performance Timeline. A
`performanceEntry.duration` is always `0`. Performance marks are used
to mark specific significant moments in the Performance Timeline.
+### performance.maxEntries
+<!-- YAML
+added: REPLACEME
+-->
+
+Value: {number}
+
+The maximum number of Performance Entry items that should be added to the
+Performance Timeline. This limit is not strictly enforced, but a process
+warning will be emitted if the number of entries in the timeline exceeds
+this limit.
+
+Defaults to 150.
+
### performance.measure(name, startMark, endMark)
<!-- YAML
added: v8.5.0