diff options
| author | James M Snell <jasnell@gmail.com> | 2018-02-14 11:06:32 -0800 |
|---|---|---|
| committer | James M Snell <jasnell@gmail.com> | 2018-02-26 13:55:33 -0800 |
| commit | 9e509b622bbdc14b7153d006f57043f268017138 (patch) | |
| tree | 0a01cc2665342046c8c198bdff76eed869263978 /doc | |
| parent | aca8e764da444a9a5eb67812db2317c1c32215d9 (diff) | |
| download | android-node-v8-9e509b622bbdc14b7153d006f57043f268017138.tar.gz android-node-v8-9e509b622bbdc14b7153d006f57043f268017138.tar.bz2 android-node-v8-9e509b622bbdc14b7153d006f57043f268017138.zip | |
perf_hooks: emit trace events for marks, measures, and timerify
Adds the `node.perf.usertiming` trace events category for recording
usertiming marks and measures (e.g. `perf_hooks.performance.mark()`)
in the trace events timeline.
Adds the `node.perf.function` trace events category for recording
`perf_hooks.performance.timerify()` durations in the trace events
timeline.
PR-URL: https://github.com/nodejs/node/pull/18789
Reviewed-By: Ali Ijaz Sheikh <ofrobots@google.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/perf_hooks.md | 4 | ||||
| -rw-r--r-- | doc/api/tracing.md | 18 |
2 files changed, 18 insertions, 4 deletions
diff --git a/doc/api/perf_hooks.md b/doc/api/perf_hooks.md index 5bef91eafb..4e31a24785 100644 --- a/doc/api/perf_hooks.md +++ b/doc/api/perf_hooks.md @@ -268,8 +268,8 @@ added: v8.5.0 * {string} -The type of the performance entry. Current it may be one of: `'node'`, `'mark'`, -`'measure'`, `'gc'`, or `'function'`. +The type of the performance entry. Currently it may be one of: `'node'`, +`'mark'`, `'measure'`, `'gc'`, or `'function'`. ### performanceEntry.kind <!-- YAML diff --git a/doc/api/tracing.md b/doc/api/tracing.md index 67b3394d55..3a534177a3 100644 --- a/doc/api/tracing.md +++ b/doc/api/tracing.md @@ -10,8 +10,20 @@ starting a Node.js application. The set of categories for which traces are recorded can be specified using the `--trace-event-categories` flag followed by a list of comma separated category -names. By default the `node`, `node.async_hooks`, and `v8` categories are -enabled. +names. + +The available categories are: + +* `node` +* `node.async_hooks` - Enables capture of detailed async_hooks trace data. +* `node.perf` - Enables capture of [Performance API] measurements. + * `node.perf.usertiming` - Enables capture of only Performance API User Timing + measures and marks. + * `node.perf.timerify` - Enables capture of only Performance API timerify + measurements. +* `v8` + +By default the `node`, `node.async_hooks`, and `v8` categories are enabled. ```txt node --trace-events-enabled --trace-event-categories v8,node,node.async_hooks server.js @@ -24,3 +36,5 @@ tab of Chrome. Starting with Node 10.0.0, the tracing system uses the same time source as the one used by `process.hrtime()` however the trace-event timestamps are expressed in microseconds, unlike `process.hrtime()` which returns nanoseconds. + +[Performance API]: perf_hooks.html |