Gecko [ tsuru-no-tsurugi.tokyo ]

Name	Size	Permission	Date
assets	[ DIR ]	drwxr-xr-x	2025-12-31 20:37
addons.html	106.56 KB	-rw-r--r--	2025-03-27 09:56
addons.json.gz	10.95 KB	-rw-r--r--	2025-03-27 09:56
addons.md	39.76 KB	-rw-r--r--	2025-03-27 09:56
all.html	7.41 MB	-rw-r--r--	2025-03-27 09:56
all.json.gz	902.17 KB	-rw-r--r--	2025-03-27 09:56
assert.html	192.05 KB	-rw-r--r--	2025-03-27 09:56
assert.json.gz	13 KB	-rw-r--r--	2025-03-27 09:56
assert.md	66.51 KB	-rw-r--r--	2025-03-27 09:56
async_context.html	84.88 KB	-rw-r--r--	2025-03-27 09:56
async_context.json.gz	7.1 KB	-rw-r--r--	2025-03-27 09:56
async_context.md	24.68 KB	-rw-r--r--	2025-03-27 09:56
async_hooks.html	88.11 KB	-rw-r--r--	2025-03-27 09:56
async_hooks.json.gz	9.82 KB	-rw-r--r--	2025-03-27 09:56
async_hooks.md	30.51 KB	-rw-r--r--	2025-03-27 09:56
buffer.html	479.74 KB	-rw-r--r--	2025-03-27 09:56
buffer.json.gz	28.89 KB	-rw-r--r--	2025-03-27 09:56
buffer.md	148.96 KB	-rw-r--r--	2025-03-27 09:56
child_process.html	170.26 KB	-rw-r--r--	2025-03-27 09:56
child_process.json.gz	20.98 KB	-rw-r--r--	2025-03-27 09:56
child_process.md	70.69 KB	-rw-r--r--	2025-03-27 09:56
cli.html	161.74 KB	-rw-r--r--	2025-03-27 09:56
cli.json.gz	25.06 KB	-rw-r--r--	2025-03-27 09:56
cli.md	67.4 KB	-rw-r--r--	2025-03-27 09:56
cluster.html	91.42 KB	-rw-r--r--	2025-03-27 09:56
cluster.json.gz	9.48 KB	-rw-r--r--	2025-03-27 09:56
cluster.md	28.84 KB	-rw-r--r--	2025-03-27 09:56
console.html	60.27 KB	-rw-r--r--	2025-03-27 09:56
console.json.gz	6.07 KB	-rw-r--r--	2025-03-27 09:56
console.md	16.5 KB	-rw-r--r--	2025-03-27 09:56
corepack.html	23.41 KB	-rw-r--r--	2025-03-27 09:56
corepack.json.gz	2.55 KB	-rw-r--r--	2025-03-27 09:56
corepack.md	5.08 KB	-rw-r--r--	2025-03-27 09:56
crypto.html	523.1 KB	-rw-r--r--	2025-03-27 09:56
crypto.json.gz	45.94 KB	-rw-r--r--	2025-03-27 09:56
crypto.md	194.44 KB	-rw-r--r--	2025-03-27 09:56
debugger.html	28.99 KB	-rw-r--r--	2025-03-27 09:56
debugger.json.gz	3.12 KB	-rw-r--r--	2025-03-27 09:56
debugger.md	7.02 KB	-rw-r--r--	2025-03-27 09:56
deprecations.html	199.72 KB	-rw-r--r--	2025-03-27 09:56
deprecations.json.gz	23.9 KB	-rw-r--r--	2025-03-27 09:56
deprecations.md	98.32 KB	-rw-r--r--	2025-03-27 09:56
dgram.html	91.02 KB	-rw-r--r--	2025-03-27 09:56
dgram.json.gz	10.19 KB	-rw-r--r--	2025-03-27 09:56
dgram.md	30.99 KB	-rw-r--r--	2025-03-27 09:56
diagnostics_channel.html	97.27 KB	-rw-r--r--	2025-03-27 09:56
diagnostics_channel.json.gz	7.45 KB	-rw-r--r--	2025-03-27 09:56
diagnostics_channel.md	31.06 KB	-rw-r--r--	2025-03-27 09:56
dns.html	131.53 KB	-rw-r--r--	2025-03-27 09:56
dns.json.gz	15.74 KB	-rw-r--r--	2025-03-27 09:56
dns.md	52.17 KB	-rw-r--r--	2025-03-27 09:56
documentation.html	26.08 KB	-rw-r--r--	2025-03-27 09:56
documentation.json.gz	2.26 KB	-rw-r--r--	2025-03-27 09:56
documentation.md	4.74 KB	-rw-r--r--	2025-03-27 09:56
domain.html	49.31 KB	-rw-r--r--	2025-03-27 09:56
domain.json.gz	6.2 KB	-rw-r--r--	2025-03-27 09:56
domain.md	15.21 KB	-rw-r--r--	2025-03-27 09:56
embedding.html	26.64 KB	-rw-r--r--	2025-03-27 09:56
embedding.json.gz	3.01 KB	-rw-r--r--	2025-03-27 09:56
embedding.md	6.65 KB	-rw-r--r--	2025-03-27 09:56
errors.html	284.97 KB	-rw-r--r--	2025-03-27 09:56
errors.json.gz	42.36 KB	-rw-r--r--	2025-03-27 09:56
errors.md	97.03 KB	-rw-r--r--	2025-03-27 09:56
esm.html	89.14 KB	-rw-r--r--	2025-03-27 09:56
esm.json.gz	14.96 KB	-rw-r--r--	2025-03-27 09:56
esm.md	41.13 KB	-rw-r--r--	2025-03-27 09:56
events.html	230.85 KB	-rw-r--r--	2025-03-27 09:56
events.json.gz	17.25 KB	-rw-r--r--	2025-03-27 09:56
events.md	66.55 KB	-rw-r--r--	2025-03-27 09:56
fs.html	633.14 KB	-rw-r--r--	2025-03-27 09:56
fs.json.gz	67.08 KB	-rw-r--r--	2025-03-27 09:56
fs.md	248.67 KB	-rw-r--r--	2025-03-27 09:56
globals.html	75.67 KB	-rw-r--r--	2025-03-27 09:56
globals.json.gz	9 KB	-rw-r--r--	2025-03-27 09:56
globals.md	20.01 KB	-rw-r--r--	2025-03-27 09:56
http.html	301.5 KB	-rw-r--r--	2025-03-27 09:56
http.json.gz	35.76 KB	-rw-r--r--	2025-03-27 09:56
http.md	113.28 KB	-rw-r--r--	2025-03-27 09:56
http2.html	318.89 KB	-rw-r--r--	2025-03-27 09:56
http2.json.gz	39.24 KB	-rw-r--r--	2025-03-27 09:56
http2.md	129.92 KB	-rw-r--r--	2025-03-27 09:56
https.html	57.3 KB	-rw-r--r--	2025-03-27 09:56
https.json.gz	5.69 KB	-rw-r--r--	2025-03-27 09:56
https.md	16.33 KB	-rw-r--r--	2025-03-27 09:56
index.html	13.44 KB	-rw-r--r--	2025-03-27 09:56
index.json	54 B	-rw-r--r--	2025-03-27 09:56
index.md	1.97 KB	-rw-r--r--	2025-03-27 09:56
inspector.html	35.1 KB	-rw-r--r--	2025-03-27 09:56
inspector.json.gz	3.62 KB	-rw-r--r--	2025-03-27 09:56
inspector.md	7.63 KB	-rw-r--r--	2025-03-27 09:56
intl.html	32.73 KB	-rw-r--r--	2025-03-27 09:56
intl.json.gz	3.87 KB	-rw-r--r--	2025-03-27 09:56
intl.md	10.71 KB	-rw-r--r--	2025-03-27 09:56
module.html	99.46 KB	-rw-r--r--	2025-03-27 09:56
module.json.gz	12.9 KB	-rw-r--r--	2025-03-27 09:56
module.md	35.82 KB	-rw-r--r--	2025-03-27 09:56
modules.html	81.42 KB	-rw-r--r--	2025-03-27 09:56
modules.json.gz	12.66 KB	-rw-r--r--	2025-03-27 09:56
modules.md	32.97 KB	-rw-r--r--	2025-03-27 09:56
n-api.html	410.98 KB	-rw-r--r--	2025-03-27 09:56
n-api.json.gz	52.81 KB	-rw-r--r--	2025-03-27 09:56
n-api.md	223.67 KB	-rw-r--r--	2025-03-27 09:56
net.html	148.47 KB	-rw-r--r--	2025-03-27 09:56
net.json.gz	18.33 KB	-rw-r--r--	2025-03-27 09:56
net.md	53.5 KB	-rw-r--r--	2025-03-27 09:56
os.html	72.68 KB	-rw-r--r--	2025-03-27 09:56
os.json.gz	8.88 KB	-rw-r--r--	2025-03-27 09:56
os.md	35.5 KB	-rw-r--r--	2025-03-27 09:56
packages.html	101.35 KB	-rw-r--r--	2025-03-27 09:56
packages.json.gz	15.41 KB	-rw-r--r--	2025-03-27 09:56
packages.md	46.43 KB	-rw-r--r--	2025-03-27 09:56
path.html	53.27 KB	-rw-r--r--	2025-03-27 09:56
path.json.gz	4.9 KB	-rw-r--r--	2025-03-27 09:56
path.md	14.91 KB	-rw-r--r--	2025-03-27 09:56
perf_hooks.html	140.73 KB	-rw-r--r--	2025-03-27 09:56
perf_hooks.json.gz	12.51 KB	-rw-r--r--	2025-03-27 09:56
perf_hooks.md	42.15 KB	-rw-r--r--	2025-03-27 09:56
permissions.html	45.46 KB	-rw-r--r--	2025-03-27 09:56
permissions.json.gz	5.44 KB	-rw-r--r--	2025-03-27 09:56
permissions.md	14.59 KB	-rw-r--r--	2025-03-27 09:56
policy.html	15.05 KB	-rw-r--r--	2025-03-27 09:56
policy.json	476 B	-rw-r--r--	2025-03-27 09:56
policy.md	222 B	-rw-r--r--	2025-03-27 09:56
process.html	291.96 KB	-rw-r--r--	2025-03-27 09:56
process.json.gz	31.35 KB	-rw-r--r--	2025-03-27 09:56
process.md	107.1 KB	-rw-r--r--	2025-03-27 09:56
punycode.html	27.08 KB	-rw-r--r--	2025-03-27 09:56
punycode.json.gz	2 KB	-rw-r--r--	2025-03-27 09:56
punycode.md	4.17 KB	-rw-r--r--	2025-03-27 09:56
querystring.html	29.1 KB	-rw-r--r--	2025-03-27 09:56
querystring.json.gz	2.65 KB	-rw-r--r--	2025-03-27 09:56
querystring.md	5.57 KB	-rw-r--r--	2025-03-27 09:56
readline.html	110.11 KB	-rw-r--r--	2025-03-27 09:56
readline.json.gz	11.91 KB	-rw-r--r--	2025-03-27 09:56
readline.md	40.48 KB	-rw-r--r--	2025-03-27 09:56
repl.html	69.56 KB	-rw-r--r--	2025-03-27 09:56
repl.json.gz	10 KB	-rw-r--r--	2025-03-27 09:56
repl.md	23.69 KB	-rw-r--r--	2025-03-27 09:56
report.html	82.38 KB	-rw-r--r--	2025-03-27 09:56
report.json.gz	6.39 KB	-rw-r--r--	2025-03-27 09:56
report.md	18.83 KB	-rw-r--r--	2025-03-27 09:56
single-executable-applications.html	26.11 KB	-rw-r--r--	2025-03-27 09:56
single-executable-applications.json.gz	2.7 KB	-rw-r--r--	2025-03-27 09:56
single-executable-applications.md	6.1 KB	-rw-r--r--	2025-03-27 09:56
stream.html	399.91 KB	-rw-r--r--	2025-03-27 09:56
stream.json.gz	51.38 KB	-rw-r--r--	2025-03-27 09:56
stream.md	146.64 KB	-rw-r--r--	2025-03-27 09:56
string_decoder.html	24.3 KB	-rw-r--r--	2025-03-27 09:56
string_decoder.json.gz	1.55 KB	-rw-r--r--	2025-03-27 09:56
string_decoder.md	2.9 KB	-rw-r--r--	2025-03-27 09:56
synopsis.html	20.38 KB	-rw-r--r--	2025-03-27 09:56
synopsis.json	2.96 KB	-rw-r--r--	2025-03-27 09:56
synopsis.md	2.12 KB	-rw-r--r--	2025-03-27 09:56
test.html	227.62 KB	-rw-r--r--	2025-03-27 09:56
test.json.gz	20.4 KB	-rw-r--r--	2025-03-27 09:56
test.md	77.32 KB	-rw-r--r--	2025-03-27 09:56
timers.html	58.12 KB	-rw-r--r--	2025-03-27 09:56
timers.json.gz	5.28 KB	-rw-r--r--	2025-03-27 09:56
timers.md	15.81 KB	-rw-r--r--	2025-03-27 09:56
tls.html	181.66 KB	-rw-r--r--	2025-03-27 09:56
tls.json.gz	32.58 KB	-rw-r--r--	2025-03-27 09:56
tls.md	88.87 KB	-rw-r--r--	2025-03-27 09:56
tracing.html	35.22 KB	-rw-r--r--	2025-03-27 09:56
tracing.json.gz	3.47 KB	-rw-r--r--	2025-03-27 09:56
tracing.md	8.52 KB	-rw-r--r--	2025-03-27 09:56
tty.html	37.77 KB	-rw-r--r--	2025-03-27 09:56
tty.json.gz	3.72 KB	-rw-r--r--	2025-03-27 09:56
tty.md	8.91 KB	-rw-r--r--	2025-03-27 09:56
url.html	152.76 KB	-rw-r--r--	2025-03-27 09:56
url.json.gz	15.93 KB	-rw-r--r--	2025-03-27 09:56
url.md	54.46 KB	-rw-r--r--	2025-03-27 09:56
util.html	286.48 KB	-rw-r--r--	2025-03-27 09:56
util.json.gz	26.23 KB	-rw-r--r--	2025-03-27 09:56
util.md	96.24 KB	-rw-r--r--	2025-03-27 09:56
v8.html	112.17 KB	-rw-r--r--	2025-03-27 09:56
v8.json.gz	11.86 KB	-rw-r--r--	2025-03-27 09:56
v8.md	34.31 KB	-rw-r--r--	2025-03-27 09:56
vm.html	145.37 KB	-rw-r--r--	2025-03-27 09:56
vm.json.gz	16.9 KB	-rw-r--r--	2025-03-27 09:56
vm.md	61.11 KB	-rw-r--r--	2025-03-27 09:56
wasi.html	28.74 KB	-rw-r--r--	2025-03-27 09:56
wasi.json.gz	2.86 KB	-rw-r--r--	2025-03-27 09:56
wasi.md	6.54 KB	-rw-r--r--	2025-03-27 09:56
webcrypto.html	153.34 KB	-rw-r--r--	2025-03-27 09:56
webcrypto.json.gz	9.86 KB	-rw-r--r--	2025-03-27 09:56
webcrypto.md	45.75 KB	-rw-r--r--	2025-03-27 09:56
webstreams.html	151.84 KB	-rw-r--r--	2025-03-27 09:56
webstreams.json.gz	9.95 KB	-rw-r--r--	2025-03-27 09:56
webstreams.md	37.04 KB	-rw-r--r--	2025-03-27 09:56
worker_threads.html	114.31 KB	-rw-r--r--	2025-03-27 09:56
worker_threads.json.gz	14.46 KB	-rw-r--r--	2025-03-27 09:56
worker_threads.md	43.24 KB	-rw-r--r--	2025-03-27 09:56
zlib.html	109.68 KB	-rw-r--r--	2025-03-27 09:56
zlib.json.gz	10.34 KB	-rw-r--r--	2025-03-27 09:56
zlib.md	35.1 KB	-rw-r--r--	2025-03-27 09:56

Rename

# Trace events

> Stability: 1 - Experimental

The `node:trace_events` module provides a mechanism to centralize tracing
information generated by V8, Node.js core, and userspace code.

Tracing can be enabled with the `--trace-event-categories` command-line flag
or by using the `node:trace_events` module. The `--trace-event-categories` flag
accepts a list of comma-separated category names.

The available categories are:

* `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.console`: Enables capture of `console.time()` and `console.count()`
  output.
* `node.threadpoolwork.sync`: Enables capture of trace data for threadpool
  synchronous operations, such as `blob`, `zlib`, `crypto` and `node_api`.
* `node.threadpoolwork.async`: Enables capture of trace data for threadpool
  asynchronous operations, such as `blob`, `zlib`, `crypto` and `node_api`.
* `node.dns.native`: Enables capture of trace data for DNS queries.
* `node.net.native`: Enables capture of trace data for network.
* `node.environment`: Enables capture of Node.js Environment milestones.
* `node.fs.sync`: Enables capture of trace data for file system sync methods.
* `node.fs_dir.sync`: Enables capture of trace data for file system sync
  directory methods.
* `node.fs.async`: Enables capture of trace data for file system async methods.
* `node.fs_dir.async`: Enables capture of trace data for file system async
  directory methods.
* `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.
* `node.promises.rejections`: Enables capture of trace data tracking the number
  of unhandled Promise rejections and handled-after-rejections.
* `node.vm.script`: Enables capture of trace data for the `node:vm` module's
  `runInNewContext()`, `runInContext()`, and `runInThisContext()` methods.
* `v8`: The [V8][] events are GC, compiling, and execution related.
* `node.http`: Enables capture of trace data for http request / response.

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

```bash
node --trace-event-categories v8,node,node.async_hooks server.js
```

Prior versions of Node.js required the use of the `--trace-events-enabled`
flag to enable trace events. This requirement has been removed. However, the
`--trace-events-enabled` flag _may_ still be used and will enable the
`node`, `node.async_hooks`, and `v8` trace event categories by default.

```bash
node --trace-events-enabled

# is equivalent to

node --trace-event-categories v8,node,node.async_hooks
```

Alternatively, trace events may be enabled using the `node:trace_events` module:

```js
const trace_events = require('node:trace_events');
const tracing = trace_events.createTracing({ categories: ['node.perf'] });
tracing.enable();  // Enable trace event capture for the 'node.perf' category

// do work

tracing.disable();  // Disable trace event capture for the 'node.perf' category
```

Running Node.js with tracing enabled will produce log files that can be opened
in the [`chrome://tracing`](https://www.chromium.org/developers/how-tos/trace-event-profiling-tool)
tab of Chrome.

The logging file is by default called `node_trace.${rotation}.log`, where
`${rotation}` is an incrementing log-rotation id. The filepath pattern can
be specified with `--trace-event-file-pattern` that accepts a template
string that supports `${rotation}` and `${pid}`:

```bash
node --trace-event-categories v8 --trace-event-file-pattern '${pid}-${rotation}.log' server.js
```

To guarantee that the log file is properly generated after signal events like
`SIGINT`, `SIGTERM`, or `SIGBREAK`, make sure to have the appropriate handlers
in your code, such as:

```js
process.on('SIGINT', function onSigint() {
  console.info('Received SIGINT.');
  process.exit(130);  // Or applicable exit code depending on OS and signal
});
```

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.

The features from this module are not available in [`Worker`][] threads.

## The `node:trace_events` module

### `Tracing` object

The `Tracing` object is used to enable or disable tracing for sets of
categories. Instances are created using the `trace_events.createTracing()`
method.

When created, the `Tracing` object is disabled. Calling the
`tracing.enable()` method adds the categories to the set of enabled trace event
categories. Calling `tracing.disable()` will remove the categories from the
set of enabled trace event categories.

#### `tracing.categories`

* {string}

A comma-separated list of the trace event categories covered by this
`Tracing` object.

#### `tracing.disable()`

Disables this `Tracing` object.

Only trace event categories _not_ covered by other enabled `Tracing` objects
and _not_ specified by the `--trace-event-categories` flag will be disabled.

```js
const trace_events = require('node:trace_events');
const t1 = trace_events.createTracing({ categories: ['node', 'v8'] });
const t2 = trace_events.createTracing({ categories: ['node.perf', 'node'] });
t1.enable();
t2.enable();

// Prints 'node,node.perf,v8'
console.log(trace_events.getEnabledCategories());

t2.disable(); // Will only disable emission of the 'node.perf' category

// Prints 'node,v8'
console.log(trace_events.getEnabledCategories());
```

#### `tracing.enable()`

Enables this `Tracing` object for the set of categories covered by the
`Tracing` object.

#### `tracing.enabled`

* {boolean} `true` only if the `Tracing` object has been enabled.

### `trace_events.createTracing(options)`

* `options` {Object}
  * `categories` {string\[]} An array of trace category names. Values included
    in the array are coerced to a string when possible. An error will be
    thrown if the value cannot be coerced.
* Returns: {Tracing}.

Creates and returns a `Tracing` object for the given set of `categories`.

```js
const trace_events = require('node:trace_events');
const categories = ['node.perf', 'node.async_hooks'];
const tracing = trace_events.createTracing({ categories });
tracing.enable();
// do stuff
tracing.disable();
```

### `trace_events.getEnabledCategories()`

* Returns: {string}

Returns a comma-separated list of all currently-enabled trace event
categories. The current set of enabled trace event categories is determined
by the _union_ of all currently-enabled `Tracing` objects and any categories
enabled using the `--trace-event-categories` flag.

Given the file `test.js` below, the command
`node --trace-event-categories node.perf test.js` will print
`'node.async_hooks,node.perf'` to the console.

```js
const trace_events = require('node:trace_events');
const t1 = trace_events.createTracing({ categories: ['node.async_hooks'] });
const t2 = trace_events.createTracing({ categories: ['node.perf'] });
const t3 = trace_events.createTracing({ categories: ['v8'] });

t1.enable();
t2.enable();

console.log(trace_events.getEnabledCategories());
```

## Examples

### Collect trace events data by inspector

```js
'use strict';

const { Session } = require('inspector');
const session = new Session();
session.connect();

async function collect() {
  const data = [];
  session.on('NodeTracing.dataCollected', (chunk) => data.push(chunk));
  session.on('NodeTracing.tracingComplete', () => {
    // done
  });
  const traceConfig = { includedCategories: ['v8'] };
  await post('NodeTracing.start', { traceConfig });
  // do something
  setTimeout(() => {
    post('NodeTracing.stop').then(() => {
      session.disconnect();
      console.log(data);
    });
  }, 1000);
}

collect();
```

[Performance API]: perf_hooks.md
[V8]: v8.md
[`Worker`]: worker_threads.md#class-worker
[`async_hooks`]: async_hooks.md