0
0
mirror of https://github.com/nodejs/node.git synced 2024-11-30 07:27:22 +01:00
nodejs/doc/api/tracing.md
James M Snell 9e509b622b 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>
2018-02-26 13:55:33 -08:00

1.4 KiB

Tracing

Trace Event provides a mechanism to centralize tracing information generated by V8, Node core, and userspace code.

Tracing can be enabled by passing the --trace-events-enabled flag when 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.

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.

node --trace-events-enabled --trace-event-categories v8,node,node.async_hooks server.js

Running Node.js with tracing enabled will produce log files that can be opened in the chrome://tracing 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.