Skip to content

Commit

Permalink
doc: update trace events categories description
Browse files Browse the repository at this point in the history
PR-URL: #20092
Fixes: #16315
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
  • Loading branch information
BeniCheni authored and jasnell committed Apr 23, 2018
1 parent bb3ead8 commit b7d1e19
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions doc/api/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,17 @@ a list of comma-separated category names.

The available categories are:

* `node`
* `node.async_hooks` - Enables capture of detailed async_hooks trace data.
* `node` - An empty placeholder.
* `node.async_hooks` - Enables capture of detailed [async_hooks] trace data.
The [async_hooks] events have a unique `asyncId` and a special triggerId
`triggerAsyncId` property.
* `node.bootstrap` - Enables capture of Node.js bootstrap milestones.
* `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`
* `v8` - The [V8] events are GC, compiling, and execution related.

By default the `node`, `node.async_hooks`, and `v8` categories are enabled.

Expand Down Expand Up @@ -193,3 +195,5 @@ console.log(trace_events.getEnabledCategories());
```

[Performance API]: perf_hooks.html
[V8]: v8.html
[async_hooks]: async_hooks.html

0 comments on commit b7d1e19

Please sign in to comment.