Skip to content

Commit b7d1e19

Browse files
BeniChenijasnell
authored andcommitted
doc: update trace events categories description
PR-URL: #20092 Fixes: #16315 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent bb3ead8 commit b7d1e19

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/api/tracing.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,17 @@ a list of comma-separated category names.
1313

1414
The available categories are:
1515

16-
* `node`
17-
* `node.async_hooks` - Enables capture of detailed async_hooks trace data.
16+
* `node` - An empty placeholder.
17+
* `node.async_hooks` - Enables capture of detailed [async_hooks] trace data.
18+
The [async_hooks] events have a unique `asyncId` and a special triggerId
19+
`triggerAsyncId` property.
1820
* `node.bootstrap` - Enables capture of Node.js bootstrap milestones.
1921
* `node.perf` - Enables capture of [Performance API] measurements.
2022
* `node.perf.usertiming` - Enables capture of only Performance API User Timing
2123
measures and marks.
2224
* `node.perf.timerify` - Enables capture of only Performance API timerify
2325
measurements.
24-
* `v8`
26+
* `v8` - The [V8] events are GC, compiling, and execution related.
2527

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

@@ -193,3 +195,5 @@ console.log(trace_events.getEnabledCategories());
193195
```
194196

195197
[Performance API]: perf_hooks.html
198+
[V8]: v8.html
199+
[async_hooks]: async_hooks.html

0 commit comments

Comments
 (0)