Gecko [ thecigaretteboxes.com ]

Name	Size	Permission
assets	[ DIR ]	drwxr-xr-x
addons.html	105.72 KB	-rw-r--r--
addons.json.gz	10.95 KB	-rw-r--r--
addons.md	39.76 KB	-rw-r--r--
all.html	7.2 MB	-rw-r--r--
all.json.gz	881.44 KB	-rw-r--r--
assert.html	191.3 KB	-rw-r--r--
assert.json.gz	13 KB	-rw-r--r--
assert.md	66.51 KB	-rw-r--r--
async_context.html	84.04 KB	-rw-r--r--
async_context.json.gz	7.09 KB	-rw-r--r--
async_context.md	24.68 KB	-rw-r--r--
async_hooks.html	87.13 KB	-rw-r--r--
async_hooks.json.gz	9.82 KB	-rw-r--r--
async_hooks.md	30.48 KB	-rw-r--r--
buffer.html	479.09 KB	-rw-r--r--
buffer.json.gz	28.89 KB	-rw-r--r--
buffer.md	148.96 KB	-rw-r--r--
child_process.html	168.62 KB	-rw-r--r--
child_process.json.gz	20.9 KB	-rw-r--r--
child_process.md	70.54 KB	-rw-r--r--
cli.html	154.13 KB	-rw-r--r--
cli.json.gz	23.79 KB	-rw-r--r--
cli.md	63.8 KB	-rw-r--r--
cluster.html	90.59 KB	-rw-r--r--
cluster.json.gz	9.48 KB	-rw-r--r--
cluster.md	28.84 KB	-rw-r--r--
console.html	59.43 KB	-rw-r--r--
console.json.gz	6.07 KB	-rw-r--r--
console.md	16.5 KB	-rw-r--r--
corepack.html	22.56 KB	-rw-r--r--
corepack.json.gz	2.55 KB	-rw-r--r--
corepack.md	5.08 KB	-rw-r--r--
crypto.html	521.88 KB	-rw-r--r--
crypto.json.gz	45.72 KB	-rw-r--r--
crypto.md	193.91 KB	-rw-r--r--
debugger.html	28.15 KB	-rw-r--r--
debugger.json.gz	3.12 KB	-rw-r--r--
debugger.md	7.02 KB	-rw-r--r--
deprecations.html	197.6 KB	-rw-r--r--
deprecations.json.gz	23.7 KB	-rw-r--r--
deprecations.md	97.51 KB	-rw-r--r--
dgram.html	89.39 KB	-rw-r--r--
dgram.json.gz	10.07 KB	-rw-r--r--
dgram.md	30.76 KB	-rw-r--r--
diagnostics_channel.html	44.76 KB	-rw-r--r--
diagnostics_channel.json.gz	3.2 KB	-rw-r--r--
diagnostics_channel.md	11.09 KB	-rw-r--r--
dns.html	130.7 KB	-rw-r--r--
dns.json.gz	15.74 KB	-rw-r--r--
dns.md	52.17 KB	-rw-r--r--
documentation.html	25.04 KB	-rw-r--r--
documentation.json.gz	2.22 KB	-rw-r--r--
documentation.md	4.67 KB	-rw-r--r--
domain.html	48.47 KB	-rw-r--r--
domain.json.gz	6.2 KB	-rw-r--r--
domain.md	15.21 KB	-rw-r--r--
embedding.html	25.79 KB	-rw-r--r--
embedding.json.gz	3.01 KB	-rw-r--r--
embedding.md	6.65 KB	-rw-r--r--
errors.html	282.1 KB	-rw-r--r--
errors.json.gz	42.26 KB	-rw-r--r--
errors.md	96.75 KB	-rw-r--r--
esm.html	126.92 KB	-rw-r--r--
esm.json.gz	20.56 KB	-rw-r--r--
esm.md	58.28 KB	-rw-r--r--
events.html	225.71 KB	-rw-r--r--
events.json.gz	16.69 KB	-rw-r--r--
events.md	64.93 KB	-rw-r--r--
fs.html	628.53 KB	-rw-r--r--
fs.json.gz	66.73 KB	-rw-r--r--
fs.md	247.34 KB	-rw-r--r--
globals.html	74.86 KB	-rw-r--r--
globals.json.gz	9 KB	-rw-r--r--
globals.md	20.04 KB	-rw-r--r--
http.html	275.03 KB	-rw-r--r--
http.json.gz	35.28 KB	-rw-r--r--
http.md	106.51 KB	-rw-r--r--
http2.html	318.05 KB	-rw-r--r--
http2.json.gz	39.24 KB	-rw-r--r--
http2.md	129.92 KB	-rw-r--r--
https.html	56.48 KB	-rw-r--r--
https.json.gz	5.69 KB	-rw-r--r--
https.md	16.33 KB	-rw-r--r--
index.html	12.63 KB	-rw-r--r--
index.json	54 B	-rw-r--r--
index.md	1.97 KB	-rw-r--r--
inspector.html	34.25 KB	-rw-r--r--
inspector.json.gz	3.62 KB	-rw-r--r--
inspector.md	7.63 KB	-rw-r--r--
intl.html	31.9 KB	-rw-r--r--
intl.json.gz	3.87 KB	-rw-r--r--
intl.md	10.71 KB	-rw-r--r--
module.html	30.94 KB	-rw-r--r--
module.json.gz	2.7 KB	-rw-r--r--
module.md	5.12 KB	-rw-r--r--
modules.html	80.58 KB	-rw-r--r--
modules.json.gz	12.65 KB	-rw-r--r--
modules.md	32.97 KB	-rw-r--r--
n-api.html	395.21 KB	-rw-r--r--
n-api.json.gz	50.69 KB	-rw-r--r--
n-api.md	214.45 KB	-rw-r--r--
net.html	140.93 KB	-rw-r--r--
net.json.gz	17.64 KB	-rw-r--r--
net.md	50.96 KB	-rw-r--r--
os.html	71.85 KB	-rw-r--r--
os.json.gz	8.88 KB	-rw-r--r--
os.md	35.5 KB	-rw-r--r--
packages.html	99.12 KB	-rw-r--r--
packages.json.gz	15.18 KB	-rw-r--r--
packages.md	45.48 KB	-rw-r--r--
path.html	52.44 KB	-rw-r--r--
path.json.gz	4.9 KB	-rw-r--r--
path.md	14.91 KB	-rw-r--r--
perf_hooks.html	139.88 KB	-rw-r--r--
perf_hooks.json.gz	12.51 KB	-rw-r--r--
perf_hooks.md	42.15 KB	-rw-r--r--
permissions.html	44.6 KB	-rw-r--r--
permissions.json.gz	5.44 KB	-rw-r--r--
permissions.md	14.59 KB	-rw-r--r--
policy.html	14.21 KB	-rw-r--r--
policy.json	475 B	-rw-r--r--
policy.md	221 B	-rw-r--r--
process.html	290.1 KB	-rw-r--r--
process.json.gz	31.21 KB	-rw-r--r--
process.md	106.75 KB	-rw-r--r--
punycode.html	26.24 KB	-rw-r--r--
punycode.json.gz	2 KB	-rw-r--r--
punycode.md	4.17 KB	-rw-r--r--
querystring.html	28.24 KB	-rw-r--r--
querystring.json.gz	2.65 KB	-rw-r--r--
querystring.md	5.57 KB	-rw-r--r--
readline.html	109.24 KB	-rw-r--r--
readline.json.gz	11.9 KB	-rw-r--r--
readline.md	40.45 KB	-rw-r--r--
repl.html	68.72 KB	-rw-r--r--
repl.json.gz	10 KB	-rw-r--r--
repl.md	23.69 KB	-rw-r--r--
report.html	81.54 KB	-rw-r--r--
report.json.gz	6.39 KB	-rw-r--r--
report.md	18.83 KB	-rw-r--r--
single-executable-applications...	23.53 KB	-rw-r--r--
single-executable-applications...	2.36 KB	-rw-r--r--
single-executable-applications...	5.12 KB	-rw-r--r--
stream.html	397.04 KB	-rw-r--r--
stream.json.gz	51.16 KB	-rw-r--r--
stream.md	145.8 KB	-rw-r--r--
string_decoder.html	23.21 KB	-rw-r--r--
string_decoder.json.gz	1.54 KB	-rw-r--r--
string_decoder.md	2.96 KB	-rw-r--r--
synopsis.html	19.54 KB	-rw-r--r--
synopsis.json	2.96 KB	-rw-r--r--
synopsis.md	2.12 KB	-rw-r--r--
test.html	168.11 KB	-rw-r--r--
test.json.gz	16.62 KB	-rw-r--r--
test.md	57.47 KB	-rw-r--r--
timers.html	55.89 KB	-rw-r--r--
timers.json.gz	5.21 KB	-rw-r--r--
timers.md	15.53 KB	-rw-r--r--
tls.html	179.78 KB	-rw-r--r--
tls.json.gz	32.31 KB	-rw-r--r--
tls.md	87.96 KB	-rw-r--r--
tracing.html	34.37 KB	-rw-r--r--
tracing.json.gz	3.47 KB	-rw-r--r--
tracing.md	8.52 KB	-rw-r--r--
tty.html	36.94 KB	-rw-r--r--
tty.json.gz	3.72 KB	-rw-r--r--
tty.md	8.91 KB	-rw-r--r--
url.html	150.42 KB	-rw-r--r--
url.json.gz	15.7 KB	-rw-r--r--
url.md	53.65 KB	-rw-r--r--
util.html	285.68 KB	-rw-r--r--
util.json.gz	25.73 KB	-rw-r--r--
util.md	96.25 KB	-rw-r--r--
v8.html	111.35 KB	-rw-r--r--
v8.json.gz	11.86 KB	-rw-r--r--
v8.md	34.31 KB	-rw-r--r--
vm.html	142.53 KB	-rw-r--r--
vm.json.gz	16.81 KB	-rw-r--r--
vm.md	59.81 KB	-rw-r--r--
wasi.html	27.91 KB	-rw-r--r--
wasi.json.gz	2.86 KB	-rw-r--r--
wasi.md	6.54 KB	-rw-r--r--
webcrypto.html	152.21 KB	-rw-r--r--
webcrypto.json.gz	9.76 KB	-rw-r--r--
webcrypto.md	45.48 KB	-rw-r--r--
webstreams.html	150.7 KB	-rw-r--r--
webstreams.json.gz	9.88 KB	-rw-r--r--
webstreams.md	36.82 KB	-rw-r--r--
worker_threads.html	113.35 KB	-rw-r--r--
worker_threads.json.gz	14.43 KB	-rw-r--r--
worker_threads.md	43.13 KB	-rw-r--r--
zlib.html	108.85 KB	-rw-r--r--
zlib.json.gz	10.34 KB	-rw-r--r--
zlib.md	35.1 KB	-rw-r--r--

Code Editor : report.html

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width">
 <meta name="nodejs.org:node-version" content="v18.17.0">
 <title>Diagnostic report | Node.js v18.17.0 Documentation</title>
 <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Lato:400,700,400italic&display=fallback">
 <link rel="stylesheet" href="assets/style.css">
 <link rel="stylesheet" href="assets/hljs.css">
 <link rel="canonical" href="https://nodejs.org/api/report.html">
 <script async defer src="assets/api.js" type="text/javascript"></script>
 
</head>
<body class="alt apidoc" id="api-section-report">
 <div id="content" class="clearfix">
 <div id="column2" class="interior">
 <div id="intro" class="interior">
 <a href="/" title="Go back to the home page">
 Node.js
 </a>
 </div>
 <ul>
<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li>
<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li>
</ul>
<hr class="line">
<ul>
<li><a href="assert.html" class="nav-assert">Assertion testing</a></li>
<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li>
<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li>
<li><a href="buffer.html" class="nav-buffer">Buffer</a></li>
<li><a href="addons.html" class="nav-addons">C++ addons</a></li>
<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li>
<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li>
<li><a href="child_process.html" class="nav-child_process">Child processes</a></li>
<li><a href="cluster.html" class="nav-cluster">Cluster</a></li>
<li><a href="cli.html" class="nav-cli">Command-line options</a></li>
<li><a href="console.html" class="nav-console">Console</a></li>
<li><a href="corepack.html" class="nav-corepack">Corepack</a></li>
<li><a href="crypto.html" class="nav-crypto">Crypto</a></li>
<li><a href="debugger.html" class="nav-debugger">Debugger</a></li>
<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li>
<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li>
<li><a href="dns.html" class="nav-dns">DNS</a></li>
<li><a href="domain.html" class="nav-domain">Domain</a></li>
<li><a href="errors.html" class="nav-errors">Errors</a></li>
<li><a href="events.html" class="nav-events">Events</a></li>
<li><a href="fs.html" class="nav-fs">File system</a></li>
<li><a href="globals.html" class="nav-globals">Globals</a></li>
<li><a href="http.html" class="nav-http">HTTP</a></li>
<li><a href="http2.html" class="nav-http2">HTTP/2</a></li>
<li><a href="https.html" class="nav-https">HTTPS</a></li>
<li><a href="inspector.html" class="nav-inspector">Inspector</a></li>
<li><a href="intl.html" class="nav-intl">Internationalization</a></li>
<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li>
<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li>
<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li>
<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li>
<li><a href="net.html" class="nav-net">Net</a></li>
<li><a href="os.html" class="nav-os">OS</a></li>
<li><a href="path.html" class="nav-path">Path</a></li>
<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li>
<li><a href="permissions.html" class="nav-permissions">Permissions</a></li>
<li><a href="process.html" class="nav-process">Process</a></li>
<li><a href="punycode.html" class="nav-punycode">Punycode</a></li>
<li><a href="querystring.html" class="nav-querystring">Query strings</a></li>
<li><a href="readline.html" class="nav-readline">Readline</a></li>
<li><a href="repl.html" class="nav-repl">REPL</a></li>
<li><a href="report.html" class="nav-report active">Report</a></li>
<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li>
<li><a href="stream.html" class="nav-stream">Stream</a></li>
<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li>
<li><a href="test.html" class="nav-test">Test runner</a></li>
<li><a href="timers.html" class="nav-timers">Timers</a></li>
<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li>
<li><a href="tracing.html" class="nav-tracing">Trace events</a></li>
<li><a href="tty.html" class="nav-tty">TTY</a></li>
<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li>
<li><a href="url.html" class="nav-url">URL</a></li>
<li><a href="util.html" class="nav-util">Utilities</a></li>
<li><a href="v8.html" class="nav-v8">V8</a></li>
<li><a href="vm.html" class="nav-vm">VM</a></li>
<li><a href="wasi.html" class="nav-wasi">WASI</a></li>
<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li>
<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li>
<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li>
<li><a href="zlib.html" class="nav-zlib">Zlib</a></li>
</ul>
<hr class="line">
<ul>
<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li>
</ul>
 </div>

<div id="column1" data-id="report" class="interior">
 <header class="header">
 <div class="header-container">
 <h1>Node.js v18.17.0 documentation</h1>
 <button class="theme-toggle-btn" id="theme-toggle-btn" title="Toggle dark mode/light mode" aria-label="Toggle dark mode/light mode" hidden>
 <svg xmlns="http://www.w3.org/2000/svg" class="icon dark-icon" height="24" width="24">
 <path fill="none" d="M0 0h24v24H0z" />
 <path d="M11.1 12.08c-2.33-4.51-.5-8.48.53-10.07C6.27 2.2 1.98 6.59 1.98 12c0 .14.02.28.02.42.62-.27 1.29-.42 2-.42 1.66 0 3.18.83 4.1 2.15A4.01 4.01 0 0111 18c0 1.52-.87 2.83-2.12 3.51.98.32 2.03.5 3.11.5 3.5 0 6.58-1.8 8.37-4.52-2.36.23-6.98-.97-9.26-5.41z"/>
 <path d="M7 16h-.18C6.4 14.84 5.3 14 4 14c-1.66 0-3 1.34-3 3s1.34 3 3 3h3c1.1 0 2-.9 2-2s-.9-2-2-2z"/>
 </svg>
 <svg xmlns="http://www.w3.org/2000/svg" class="icon light-icon" height="24" width="24">
 <path d="M0 0h24v24H0z" fill="none" />
 <path d="M6.76 4.84l-1.8-1.79-1.41 1.41 1.79 1.79 1.42-1.41zM4 10.5H1v2h3v-2zm9-9.95h-2V3.5h2V.55zm7.45 3.91l-1.41-1.41-1.79 1.79 1.41 1.41 1.79-1.79zm-3.21 13.7l1.79 1.8 1.41-1.41-1.8-1.79-1.4 1.4zM20 10.5v2h3v-2h-3zm-8-5c-3.31 0-6 2.69-6 6s2.69 6 6 6 6-2.69 6-6-2.69-6-6-6zm-1 16.95h2V19.5h-2v2.95zm-7.45-3.91l1.41 1.41 1.79-1.8-1.41-1.41-1.79 1.8z"/>
 </svg>
 </button>
 </div>
 <div id="gtoc">
 <ul>
 <li class="pinned-header">Node.js v18.17.0</li>
 
 <li class="picker-header">
 <a href="#">
 &#x25ba;&#x25bc;
 Table of contents
 </a>

<div class="picker"><div class="toc"><ul>
<li><a href="#diagnostic-report">Diagnostic report</a>
<ul>
<li><a href="#usage">Usage</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#interaction-with-workers">Interaction with workers</a></li>
</ul>
</li>
</ul></div></div>
 </li>
 
 
 <li class="picker-header">
 <a href="#">
 &#x25ba;&#x25bc;
 Index
 </a>

<div class="picker"><ul>
<li><a href="documentation.html" class="nav-documentation">About this documentation</a></li>
<li><a href="synopsis.html" class="nav-synopsis">Usage and example</a></li>

<li>
 <a href="index.html">Index</a>
 </li>
 </ul>
 
<hr class="line">
<ul>
<li><a href="assert.html" class="nav-assert">Assertion testing</a></li>
<li><a href="async_context.html" class="nav-async_context">Asynchronous context tracking</a></li>
<li><a href="async_hooks.html" class="nav-async_hooks">Async hooks</a></li>
<li><a href="buffer.html" class="nav-buffer">Buffer</a></li>
<li><a href="addons.html" class="nav-addons">C++ addons</a></li>
<li><a href="n-api.html" class="nav-n-api">C/C++ addons with Node-API</a></li>
<li><a href="embedding.html" class="nav-embedding">C++ embedder API</a></li>
<li><a href="child_process.html" class="nav-child_process">Child processes</a></li>
<li><a href="cluster.html" class="nav-cluster">Cluster</a></li>
<li><a href="cli.html" class="nav-cli">Command-line options</a></li>
<li><a href="console.html" class="nav-console">Console</a></li>
<li><a href="corepack.html" class="nav-corepack">Corepack</a></li>
<li><a href="crypto.html" class="nav-crypto">Crypto</a></li>
<li><a href="debugger.html" class="nav-debugger">Debugger</a></li>
<li><a href="deprecations.html" class="nav-deprecations">Deprecated APIs</a></li>
<li><a href="diagnostics_channel.html" class="nav-diagnostics_channel">Diagnostics Channel</a></li>
<li><a href="dns.html" class="nav-dns">DNS</a></li>
<li><a href="domain.html" class="nav-domain">Domain</a></li>
<li><a href="errors.html" class="nav-errors">Errors</a></li>
<li><a href="events.html" class="nav-events">Events</a></li>
<li><a href="fs.html" class="nav-fs">File system</a></li>
<li><a href="globals.html" class="nav-globals">Globals</a></li>
<li><a href="http.html" class="nav-http">HTTP</a></li>
<li><a href="http2.html" class="nav-http2">HTTP/2</a></li>
<li><a href="https.html" class="nav-https">HTTPS</a></li>
<li><a href="inspector.html" class="nav-inspector">Inspector</a></li>
<li><a href="intl.html" class="nav-intl">Internationalization</a></li>
<li><a href="modules.html" class="nav-modules">Modules: CommonJS modules</a></li>
<li><a href="esm.html" class="nav-esm">Modules: ECMAScript modules</a></li>
<li><a href="module.html" class="nav-module">Modules: <code>node:module</code> API</a></li>
<li><a href="packages.html" class="nav-packages">Modules: Packages</a></li>
<li><a href="net.html" class="nav-net">Net</a></li>
<li><a href="os.html" class="nav-os">OS</a></li>
<li><a href="path.html" class="nav-path">Path</a></li>
<li><a href="perf_hooks.html" class="nav-perf_hooks">Performance hooks</a></li>
<li><a href="permissions.html" class="nav-permissions">Permissions</a></li>
<li><a href="process.html" class="nav-process">Process</a></li>
<li><a href="punycode.html" class="nav-punycode">Punycode</a></li>
<li><a href="querystring.html" class="nav-querystring">Query strings</a></li>
<li><a href="readline.html" class="nav-readline">Readline</a></li>
<li><a href="repl.html" class="nav-repl">REPL</a></li>
<li><a href="report.html" class="nav-report active">Report</a></li>
<li><a href="single-executable-applications.html" class="nav-single-executable-applications">Single executable applications</a></li>
<li><a href="stream.html" class="nav-stream">Stream</a></li>
<li><a href="string_decoder.html" class="nav-string_decoder">String decoder</a></li>
<li><a href="test.html" class="nav-test">Test runner</a></li>
<li><a href="timers.html" class="nav-timers">Timers</a></li>
<li><a href="tls.html" class="nav-tls">TLS/SSL</a></li>
<li><a href="tracing.html" class="nav-tracing">Trace events</a></li>
<li><a href="tty.html" class="nav-tty">TTY</a></li>
<li><a href="dgram.html" class="nav-dgram">UDP/datagram</a></li>
<li><a href="url.html" class="nav-url">URL</a></li>
<li><a href="util.html" class="nav-util">Utilities</a></li>
<li><a href="v8.html" class="nav-v8">V8</a></li>
<li><a href="vm.html" class="nav-vm">VM</a></li>
<li><a href="wasi.html" class="nav-wasi">WASI</a></li>
<li><a href="webcrypto.html" class="nav-webcrypto">Web Crypto API</a></li>
<li><a href="webstreams.html" class="nav-webstreams">Web Streams API</a></li>
<li><a href="worker_threads.html" class="nav-worker_threads">Worker threads</a></li>
<li><a href="zlib.html" class="nav-zlib">Zlib</a></li>
</ul>
<hr class="line">
<ul>
<li><a href="https://github.com/nodejs/node" class="nav-https-github-com-nodejs-node">Code repository and issue tracker</a></li>
</ul></div>
 </li>
 
 
 <li class="picker-header">
 <a href="#">
 &#x25ba;&#x25bc;
 Other versions
 </a>
 <div class="picker"><ol id="alt-docs"><li><a href="https://nodejs.org/docs/latest-v20.x/api/report.html">20.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v19.x/api/report.html">19.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v18.x/api/report.html">18.x LTS</a></li>
<li><a href="https://nodejs.org/docs/latest-v17.x/api/report.html">17.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v16.x/api/report.html">16.x LTS</a></li>
<li><a href="https://nodejs.org/docs/latest-v15.x/api/report.html">15.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v14.x/api/report.html">14.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v13.x/api/report.html">13.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v12.x/api/report.html">12.x</a></li>
<li><a href="https://nodejs.org/docs/latest-v11.x/api/report.html">11.x</a></li></ol></div>
 </li>
 
 <li class="picker-header">
 <a href="#">
 &#x25ba;&#x25bc;
 Options
 </a>
 
 <div class="picker">
 <ul>
 <li>
 <a href="all.html">View on single page</a>
 </li>
 <li>
 <a href="report.json">View as JSON</a>
 </li>
 <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/main/doc/api/report.md">Edit on GitHub</a></li> 
 </ul>
 </div>
 </li>
 </ul>
 </div>
 <hr>
 </header>

<details id="toc" open><summary>Table of contents</summary><ul>
<li><a href="#diagnostic-report">Diagnostic report</a>
<ul>
<li><a href="#usage">Usage</a></li>
<li><a href="#configuration">Configuration</a></li>
<li><a href="#interaction-with-workers">Interaction with workers</a></li>
</ul>
</li>
</ul></details>

<div id="apicontent">
 <h2>Diagnostic report<a class="mark" href="#diagnostic-report" id="diagnostic-report">#</a><a aria-hidden="true" class="legacy" id="report_diagnostic_report"></a></h2>

<div class="api_stability api_stability_2"><a href="documentation.html#stability-index">Stability: 2</a> - Stable</div>

Delivers a JSON-formatted diagnostic summary, written to a file.
The report is intended for development, test, and production use, to capture
and preserve information for problem determination. It includes JavaScript
and native stack traces, heap statistics, platform information, resource
usage etc. With the report option enabled, diagnostic reports can be triggered
on unhandled exceptions, fatal errors and user signals, in addition to
triggering programmatically through API calls.
A complete example report that was generated on an uncaught exception
is provided below for reference.
<pre><code class="language-json">{
 "header": {
 "reportVersion": 3,
 "event": "exception",
 "trigger": "Exception",
 "filename": "report.20181221.005011.8974.0.001.json",
 "dumpEventTime": "2018-12-21T00:50:11Z",
 "dumpEventTimeStamp": "1545371411331",
 "processId": 8974,
 "cwd": "/home/nodeuser/project/node",
 "commandLine": [
 "/home/nodeuser/project/node/out/Release/node",
 "--report-uncaught-exception",
 "/home/nodeuser/project/node/test/report/test-exception.js",
 "child"
 ],
 "nodejsVersion": "v12.0.0-pre",
 "glibcVersionRuntime": "2.17",
 "glibcVersionCompiler": "2.17",
 "wordSize": "64 bit",
 "arch": "x64",
 "platform": "linux",
 "componentVersions": {
 "node": "12.0.0-pre",
 "v8": "7.1.302.28-node.5",
 "uv": "1.24.1",
 "zlib": "1.2.11",
 "ares": "1.15.0",
 "modules": "68",
 "nghttp2": "1.34.0",
 "napi": "3",
 "llhttp": "1.0.1",
 "openssl": "1.1.0j"
 },
 "release": {
 "name": "node"
 },
 "osName": "Linux",
 "osRelease": "3.10.0-862.el7.x86_64",
 "osVersion": "#1 SMP Wed Mar 21 18:14:51 EDT 2018",
 "osMachine": "x86_64",
 "cpus": [
 {
 "model": "Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz",
 "speed": 2700,
 "user": 88902660,
 "nice": 0,
 "sys": 50902570,
 "idle": 241732220,
 "irq": 0
 },
 {
 "model": "Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz",
 "speed": 2700,
 "user": 88902660,
 "nice": 0,
 "sys": 50902570,
 "idle": 241732220,
 "irq": 0
 }
 ],
 "networkInterfaces": [
 {
 "name": "en0",
 "internal": false,
 "mac": "13:10:de:ad:be:ef",
 "address": "10.0.0.37",
 "netmask": "255.255.255.0",
 "family": "IPv4"
 }
 ],
 "host": "test_machine"
 },
 "javascriptStack": {
 "message": "Error: *** test-exception.js: throwing uncaught Error",
 "stack": [
 "at myException (/home/nodeuser/project/node/test/report/test-exception.js:9:11)",
 "at Object.&#x3C;anonymous> (/home/nodeuser/project/node/test/report/test-exception.js:12:3)",
 "at Module._compile (internal/modules/cjs/loader.js:718:30)",
 "at Object.Module._extensions..js (internal/modules/cjs/loader.js:729:10)",
 "at Module.load (internal/modules/cjs/loader.js:617:32)",
 "at tryModuleLoad (internal/modules/cjs/loader.js:560:12)",
 "at Function.Module._load (internal/modules/cjs/loader.js:552:3)",
 "at Function.Module.runMain (internal/modules/cjs/loader.js:771:12)",
 "at executeUserCode (internal/bootstrap/node.js:332:15)"
 ]
 },
 "nativeStack": [
 {
 "pc": "0x000055b57f07a9ef",
 "symbol": "report::GetNodeReport(v8::Isolate*, node::Environment*, char const*, char const*, v8::Local&#x3C;v8::String>, std::ostream&#x26;) [./node]"
 },
 {
 "pc": "0x000055b57f07cf03",
 "symbol": "report::GetReport(v8::FunctionCallbackInfo&#x3C;v8::Value> const&#x26;) [./node]"
 },
 {
 "pc": "0x000055b57f1bccfd",
 "symbol": " [./node]"
 },
 {
 "pc": "0x000055b57f1be048",
 "symbol": "v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*) [./node]"
 },
 {
 "pc": "0x000055b57feeda0e",
 "symbol": " [./node]"
 }
 ],
 "javascriptHeap": {
 "totalMemory": 5660672,
 "executableMemory": 524288,
 "totalCommittedMemory": 5488640,
 "availableMemory": 4341379928,
 "totalGlobalHandlesMemory": 8192,
 "usedGlobalHandlesMemory": 3136,
 "usedMemory": 4816432,
 "memoryLimit": 4345298944,
 "mallocedMemory": 254128,
 "externalMemory": 315644,
 "peakMallocedMemory": 98752,
 "nativeContextCount": 1,
 "detachedContextCount": 0,
 "doesZapGarbage": 0,
 "heapSpaces": {
 "read_only_space": {
 "memorySize": 524288,
 "committedMemory": 39208,
 "capacity": 515584,
 "used": 30504,
 "available": 485080
 },
 "new_space": {
 "memorySize": 2097152,
 "committedMemory": 2019312,
 "capacity": 1031168,
 "used": 985496,
 "available": 45672
 },
 "old_space": {
 "memorySize": 2273280,
 "committedMemory": 1769008,
 "capacity": 1974640,
 "used": 1725488,
 "available": 249152
 },
 "code_space": {
 "memorySize": 696320,
 "committedMemory": 184896,
 "capacity": 152128,
 "used": 152128,
 "available": 0
 },
 "map_space": {
 "memorySize": 536576,
 "committedMemory": 344928,
 "capacity": 327520,
 "used": 327520,
 "available": 0
 },
 "large_object_space": {
 "memorySize": 0,
 "committedMemory": 0,
 "capacity": 1520590336,
 "used": 0,
 "available": 1520590336
 },
 "new_large_object_space": {
 "memorySize": 0,
 "committedMemory": 0,
 "capacity": 0,
 "used": 0,
 "available": 0
 }
 }
 },
 "resourceUsage": {
 "rss": "35766272",
 "free_memory": "1598337024",
 "total_memory": "17179869184",
 "available_memory": "1598337024",
 "maxRss": "36624662528",
 "constrained_memory": "36624662528",
 "userCpuSeconds": 0.040072,
 "kernelCpuSeconds": 0.016029,
 "cpuConsumptionPercent": 5.6101,
 "userCpuConsumptionPercent": 4.0072,
 "kernelCpuConsumptionPercent": 1.6029,
 "pageFaults": {
 "IORequired": 0,
 "IONotRequired": 4610
 },
 "fsActivity": {
 "reads": 0,
 "writes": 0
 }
 },
 "uvthreadResourceUsage": {
 "userCpuSeconds": 0.039843,
 "kernelCpuSeconds": 0.015937,
 "cpuConsumptionPercent": 5.578,
 "userCpuConsumptionPercent": 3.9843,
 "kernelCpuConsumptionPercent": 1.5937,
 "fsActivity": {
 "reads": 0,
 "writes": 0
 }
 },
 "libuv": [
 {
 "type": "async",
 "is_active": true,
 "is_referenced": false,
 "address": "0x0000000102910900",
 "details": ""
 },
 {
 "type": "timer",
 "is_active": false,
 "is_referenced": false,
 "address": "0x00007fff5fbfeab0",
 "repeat": 0,
 "firesInMsFromNow": 94403548320796,
 "expired": true
 },
 {
 "type": "check",
 "is_active": true,
 "is_referenced": false,
 "address": "0x00007fff5fbfeb48"
 },
 {
 "type": "idle",
 "is_active": false,
 "is_referenced": true,
 "address": "0x00007fff5fbfebc0"
 },
 {
 "type": "prepare",
 "is_active": false,
 "is_referenced": false,
 "address": "0x00007fff5fbfec38"
 },
 {
 "type": "check",
 "is_active": false,
 "is_referenced": false,
 "address": "0x00007fff5fbfecb0"
 },
 {
 "type": "async",
 "is_active": true,
 "is_referenced": false,
 "address": "0x000000010188f2e0"
 },
 {
 "type": "tty",
 "is_active": false,
 "is_referenced": true,
 "address": "0x000055b581db0e18",
 "width": 204,
 "height": 55,
 "fd": 17,
 "writeQueueSize": 0,
 "readable": true,
 "writable": true
 },
 {
 "type": "signal",
 "is_active": true,
 "is_referenced": false,
 "address": "0x000055b581d80010",
 "signum": 28,
 "signal": "SIGWINCH"
 },
 {
 "type": "tty",
 "is_active": true,
 "is_referenced": true,
 "address": "0x000055b581df59f8",
 "width": 204,
 "height": 55,
 "fd": 19,
 "writeQueueSize": 0,
 "readable": true,
 "writable": true
 },
 {
 "type": "loop",
 "is_active": true,
 "address": "0x000055fc7b2cb180",
 "loopIdleTimeSeconds": 22644.8
 }
 ],
 "workers": [],
 "environmentVariables": {
 "REMOTEHOST": "REMOVED",
 "MANPATH": "/opt/rh/devtoolset-3/root/usr/share/man:",
 "XDG_SESSION_ID": "66126",
 "HOSTNAME": "test_machine",
 "HOST": "test_machine",
 "TERM": "xterm-256color",
 "SHELL": "/bin/csh",
 "SSH_CLIENT": "REMOVED",
 "PERL5LIB": "/opt/rh/devtoolset-3/root//usr/lib64/perl5/vendor_perl:/opt/rh/devtoolset-3/root/usr/lib/perl5:/opt/rh/devtoolset-3/root//usr/share/perl5/vendor_perl",
 "OLDPWD": "/home/nodeuser/project/node/src",
 "JAVACONFDIRS": "/opt/rh/devtoolset-3/root/etc/java:/etc/java",
 "SSH_TTY": "/dev/pts/0",
 "PCP_DIR": "/opt/rh/devtoolset-3/root",
 "GROUP": "normaluser",
 "USER": "nodeuser",
 "LD_LIBRARY_PATH": "/opt/rh/devtoolset-3/root/usr/lib64:/opt/rh/devtoolset-3/root/usr/lib",
 "HOSTTYPE": "x86_64-linux",
 "XDG_CONFIG_DIRS": "/opt/rh/devtoolset-3/root/etc/xdg:/etc/xdg",
 "MAIL": "/var/spool/mail/nodeuser",
 "PATH": "/home/nodeuser/project/node:/opt/rh/devtoolset-3/root/usr/bin:/usr/local/bin:/usr/bin:/usr/local/sbin:/usr/sbin",
 "PWD": "/home/nodeuser/project/node",
 "LANG": "en_US.UTF-8",
 "PS1": "\\u@\\h : \\[\\e[31m\\]\\w\\[\\e[m\\] > ",
 "SHLVL": "2",
 "HOME": "/home/nodeuser",
 "OSTYPE": "linux",
 "VENDOR": "unknown",
 "PYTHONPATH": "/opt/rh/devtoolset-3/root/usr/lib64/python2.7/site-packages:/opt/rh/devtoolset-3/root/usr/lib/python2.7/site-packages",
 "MACHTYPE": "x86_64",
 "LOGNAME": "nodeuser",
 "XDG_DATA_DIRS": "/opt/rh/devtoolset-3/root/usr/share:/usr/local/share:/usr/share",
 "LESSOPEN": "||/usr/bin/lesspipe.sh %s",
 "INFOPATH": "/opt/rh/devtoolset-3/root/usr/share/info",
 "XDG_RUNTIME_DIR": "/run/user/50141",
 "_": "./node"
 },
 "userLimits": {
 "core_file_size_blocks": {
 "soft": "",
 "hard": "unlimited"
 },
 "data_seg_size_kbytes": {
 "soft": "unlimited",
 "hard": "unlimited"
 },
 "file_size_blocks": {
 "soft": "unlimited",
 "hard": "unlimited"
 },
 "max_locked_memory_bytes": {
 "soft": "unlimited",
 "hard": 65536
 },
 "max_memory_size_kbytes": {
 "soft": "unlimited",
 "hard": "unlimited"
 },
 "open_files": {
 "soft": "unlimited",
 "hard": 4096
 },
 "stack_size_bytes": {
 "soft": "unlimited",
 "hard": "unlimited"
 },
 "cpu_time_seconds": {
 "soft": "unlimited",
 "hard": "unlimited"
 },
 "max_user_processes": {
 "soft": "unlimited",
 "hard": 4127290
 },
 "virtual_memory_kbytes": {
 "soft": "unlimited",
 "hard": "unlimited"
 }
 },
 "sharedObjects": [
 "/lib64/libdl.so.2",
 "/lib64/librt.so.1",
 "/lib64/libstdc++.so.6",
 "/lib64/libm.so.6",
 "/lib64/libgcc_s.so.1",
 "/lib64/libpthread.so.0",
 "/lib64/libc.so.6",
 "/lib64/ld-linux-x86-64.so.2"
 ]
}</code> <button class="copy-button">copy</button></pre>
<section><h3>Usage<a class="mark" href="#usage" id="usage">#</a><a aria-hidden="true" class="legacy" id="report_usage"></a></h3>
<pre><code class="language-bash">node --report-uncaught-exception --report-on-signal \
--report-on-fatalerror app.js</code> <button class="copy-button">copy</button></pre>
<ul>
<li>
<code>--report-uncaught-exception</code> Enables report to be generated on
un-caught exceptions. Useful when inspecting JavaScript stack in conjunction
with native stack and other runtime environment data.
</li>
<li>
<code>--report-on-signal</code> Enables report to be generated upon receiving
the specified (or predefined) signal to the running Node.js process. (See
below on how to modify the signal that triggers the report.) Default signal is
<code>SIGUSR2</code>. Useful when a report needs to be triggered from another program.
Application monitors may leverage this feature to collect report at regular
intervals and plot rich set of internal runtime data to their views.
</li>
</ul>
Signal based report generation is not supported in Windows.
Under normal circumstances, there is no need to modify the report triggering
signal. However, if <code>SIGUSR2</code> is already used for other purposes, then this
flag helps to change the signal for report generation and preserve the original
meaning of <code>SIGUSR2</code> for the said purposes.
<ul>
<li>
<code>--report-on-fatalerror</code> Enables the report to be triggered on fatal errors
(internal errors within the Node.js runtime, such as out of memory)
that leads to termination of the application. Useful to inspect various
diagnostic data elements such as heap, stack, event loop state, resource
consumption etc. to reason about the fatal error.
</li>
<li>
<code>--report-compact</code> Write reports in a compact format, single-line JSON, more
easily consumable by log processing systems than the default multi-line format
designed for human consumption.
</li>
<li>
<code>--report-directory</code> Location at which the report will be
generated.
</li>
<li>
<code>--report-filename</code> Name of the file to which the report will be
written.
</li>
<li>
<code>--report-signal</code> Sets or resets the signal for report generation
(not supported on Windows). Default signal is <code>SIGUSR2</code>.
</li>
</ul>
A report can also be triggered via an API call from a JavaScript application:
<pre><code class="language-js">process.report.writeReport();</code> <button class="copy-button">copy</button></pre>
This function takes an optional additional argument <code>filename</code>, which is
the name of a file into which the report is written.
<pre><code class="language-js">process.report.writeReport('./foo.json');</code> <button class="copy-button">copy</button></pre>
This function takes an optional additional argument <code>err</code> which is an <code>Error</code>
object that will be used as the context for the JavaScript stack printed in the
report. When using report to handle errors in a callback or an exception
handler, this allows the report to include the location of the original error as
well as where it was handled.
<pre><code class="language-js">try {
 process.chdir('/non-existent-path');
} catch (err) {
 process.report.writeReport(err);
}
// Any other code</code> <button class="copy-button">copy</button></pre>
If both filename and error object are passed to <code>writeReport()</code> the
error object must be the second parameter.
<pre><code class="language-js">try {
 process.chdir('/non-existent-path');
} catch (err) {
 process.report.writeReport(filename, err);
}
// Any other code</code> <button class="copy-button">copy</button></pre>
The content of the diagnostic report can be returned as a JavaScript Object
via an API call from a JavaScript application:
<pre><code class="language-js">const report = process.report.getReport();
console.log(typeof report === 'object'); // true

// Similar to process.report.writeReport() output
console.log(JSON.stringify(report, null, 2));</code> <button class="copy-button">copy</button></pre>
This function takes an optional additional argument <code>err</code>, which is an <code>Error</code>
object that will be used as the context for the JavaScript stack printed in the
report.
<pre><code class="language-js">const report = process.report.getReport(new Error('custom error'));
console.log(typeof report === 'object'); // true</code> <button class="copy-button">copy</button></pre>
The API versions are useful when inspecting the runtime state from within
the application, in expectation of self-adjusting the resource consumption,
load balancing, monitoring etc.
The content of the report consists of a header section containing the event
type, date, time, PID, and Node.js version, sections containing JavaScript and
native stack traces, a section containing V8 heap information, a section
containing <code>libuv</code> handle information, and an OS platform information section
showing CPU and memory usage and system limits. An example report can be
triggered using the Node.js REPL:
<pre><code class="language-console">$ node
> process.report.writeReport();
Writing Node.js report to file: report.20181126.091102.8480.0.001.json
Node.js report completed
></code> <button class="copy-button">copy</button></pre>
When a report is written, start and end messages are issued to stderr
and the filename of the report is returned to the caller. The default filename
includes the date, time, PID, and a sequence number. The sequence number helps
in associating the report dump with the runtime state if generated multiple
times for the same Node.js process.
Diagnostic report has an associated single-digit version number (<code>report.header.reportVersion</code>),
uniquely representing the report format. The version number is bumped
when new key is added or removed, or the data type of a value is changed.
Report version definitions are consistent across LTS releases.
</section><section><h3>Configuration<a class="mark" href="#configuration" id="configuration">#</a><a aria-hidden="true" class="legacy" id="report_configuration"></a></h3>
Additional runtime configuration of report generation is available via
the following properties of <code>process.report</code>:
<code>reportOnFatalError</code> triggers diagnostic reporting on fatal errors when <code>true</code>.
Defaults to <code>false</code>.
<code>reportOnSignal</code> triggers diagnostic reporting on signal when <code>true</code>. This is
not supported on Windows. Defaults to <code>false</code>.
<code>reportOnUncaughtException</code> triggers diagnostic reporting on uncaught exception
when <code>true</code>. Defaults to <code>false</code>.
<code>signal</code> specifies the POSIX signal identifier that will be used
to intercept external triggers for report generation. Defaults to
<code>'SIGUSR2'</code>.
<code>filename</code> specifies the name of the output file in the file system.
Special meaning is attached to <code>stdout</code> and <code>stderr</code>. Usage of these
will result in report being written to the associated standard streams.
In cases where standard streams are used, the value in <code>directory</code> is ignored.
URLs are not supported. Defaults to a composite filename that contains
timestamp, PID, and sequence number.
<code>directory</code> specifies the file system directory where the report will be
written. URLs are not supported. Defaults to the current working directory of
the Node.js process.
<pre><code class="language-js">// Trigger report only on uncaught exceptions.
process.report.reportOnFatalError = false;
process.report.reportOnSignal = false;
process.report.reportOnUncaughtException = true;

// Trigger report for both internal errors as well as external signal.
process.report.reportOnFatalError = true;
process.report.reportOnSignal = true;
process.report.reportOnUncaughtException = false;

// Change the default signal to 'SIGQUIT' and enable it.
process.report.reportOnFatalError = false;
process.report.reportOnUncaughtException = false;
process.report.reportOnSignal = true;
process.report.signal = 'SIGQUIT';</code> <button class="copy-button">copy</button></pre>
Configuration on module initialization is also available via
environment variables:
<pre><code class="language-bash">NODE_OPTIONS="--report-uncaught-exception \
 --report-on-fatalerror --report-on-signal \
 --report-signal=SIGUSR2 --report-filename=./report.json \
 --report-directory=/home/nodeuser"</code> <button class="copy-button">copy</button></pre>
Specific API documentation can be found under
<a href="process.html"><code>process API documentation</code></a> section.
</section><section><h3>Interaction with workers<a class="mark" href="#interaction-with-workers" id="interaction-with-workers">#</a><a aria-hidden="true" class="legacy" id="report_interaction_with_workers"></a></h3>
<div class="api_metadata">
<details class="changelog"><summary>History</summary>
<table>
<tbody><tr><th>Version</th><th>Changes</th></tr>
<tr><td>v13.9.0, v12.16.2</td>
<td>Workers are now included in the report.</td></tr>
</tbody></table>
</details>
</div>
<a href="worker_threads.html"><code>Worker</code></a> threads can create reports in the same way that the main thread
does.
Reports will include information on any Workers that are children of the current
thread as part of the <code>workers</code> section, with each Worker generating a report
in the standard report format.
The thread which is generating the report will wait for the reports from Worker
threads to finish. However, the latency for this will usually be low, as both
running JavaScript and the event loop are interrupted to generate the report.</section>
 
 </div>
 </div>
 </div>
</body>
</html>

${this.title}

Code Editor : report.html