/
usr
/
share
/
doc
/
nodejs
/
api
/
/usr/share/doc/nodejs/api
mkdir
upload
Name
Size
Mode
Actions
assets/
-
0755
rm
addons.html
85172
0644
edit
dl
rm
addons.json.gz
11188
0644
edit
dl
rm
addons.md
41013
0644
edit
dl
rm
all.html
4598048
0644
edit
dl
rm
all.json.gz
681643
0644
edit
dl
rm
assert.html
110665
0644
edit
dl
rm
assert.json.gz
12007
0644
edit
dl
rm
assert.md
47147
0644
edit
dl
rm
async_hooks.html
83599
0644
edit
dl
rm
async_hooks.json.gz
14085
0644
edit
dl
rm
async_hooks.md
38888
0644
edit
dl
rm
buffer.html
245762
0644
edit
dl
rm
buffer.json.gz
24105
0644
edit
dl
rm
buffer.md
105044
0644
edit
dl
rm
child_process.html
136767
0644
edit
dl
rm
child_process.json.gz
19399
0644
edit
dl
rm
child_process.md
62919
0644
edit
dl
rm
cli.html
87936
0644
edit
dl
rm
cli.json.gz
16615
0644
edit
dl
rm
cli.md
42263
0644
edit
dl
rm
cluster.html
60116
0644
edit
dl
rm
cluster.json.gz
9557
0644
edit
dl
rm
cluster.md
25426
0644
edit
dl
rm
console.html
46093
0644
edit
dl
rm
console.json.gz
6056
0644
edit
dl
rm
console.md
16431
0644
edit
dl
rm
crypto.html
283043
0644
edit
dl
rm
crypto.json.gz
32118
0644
edit
dl
rm
crypto.md
125198
0644
edit
dl
rm
debugger.html
18089
0644
edit
dl
rm
debugger.json.gz
2820
0644
edit
dl
rm
debugger.md
6133
0644
edit
dl
rm
deprecations.html
138537
0644
edit
dl
rm
deprecations.json.gz
18470
0644
edit
dl
rm
deprecations.md
79120
0644
edit
dl
rm
dgram.html
62425
0644
edit
dl
rm
dgram.json.gz
9630
0644
edit
dl
rm
dgram.md
27746
0644
edit
dl
rm
dns.html
98289
0644
edit
dl
rm
dns.json.gz
13838
0644
edit
dl
rm
dns.md
40799
0644
edit
dl
rm
documentation.html
10978
0644
edit
dl
rm
documentation.json
3328
0644
edit
dl
rm
documentation.md
2247
0644
edit
dl
rm
domain.html
36301
0644
edit
dl
rm
domain.json.gz
6355
0644
edit
dl
rm
domain.md
15521
0644
edit
dl
rm
embedding.html
18165
0644
edit
dl
rm
embedding.json.gz
3625
0644
edit
dl
rm
embedding.md
8811
0644
edit
dl
rm
errors.html
182982
0644
edit
dl
rm
errors.json.gz
36479
0644
edit
dl
rm
errors.md
81734
0644
edit
dl
rm
esm.html
92490
0644
edit
dl
rm
esm.json.gz
15054
0644
edit
dl
rm
esm.md
48466
0644
edit
dl
rm
events.html
75986
0644
edit
dl
rm
events.json.gz
9561
0644
edit
dl
rm
events.md
28823
0644
edit
dl
rm
fs.html
437179
0644
edit
dl
rm
fs.json.gz
47095
0644
edit
dl
rm
fs.md
187735
0644
edit
dl
rm
globals.html
19795
0644
edit
dl
rm
globals.json.gz
2525
0644
edit
dl
rm
globals.md
5838
0644
edit
dl
rm
http.html
164378
0644
edit
dl
rm
http.json.gz
25888
0644
edit
dl
rm
http.md
74465
0644
edit
dl
rm
http2.html
256451
0644
edit
dl
rm
http2.json.gz
37157
0644
edit
dl
rm
http2.md
121722
0644
edit
dl
rm
https.html
38345
0644
edit
dl
rm
https.json.gz
4847
0644
edit
dl
rm
https.md
13942
0644
edit
dl
rm
index.html
10087
0644
edit
dl
rm
index.json
54
0644
edit
dl
rm
index.md
1825
0644
edit
dl
rm
inspector.html
22433
0644
edit
dl
rm
inspector.json.gz
3338
0644
edit
dl
rm
inspector.md
6825
0644
edit
dl
rm
intl.html
23154
0644
edit
dl
rm
intl.json.gz
4038
0644
edit
dl
rm
intl.md
11092
0644
edit
dl
rm
module.html
21739
0644
edit
dl
rm
module.json.gz
2821
0644
edit
dl
rm
module.md
5341
0644
edit
dl
rm
modules.html
61333
0644
edit
dl
rm
modules.json.gz
11897
0644
edit
dl
rm
modules.md
30610
0644
edit
dl
rm
n-api.html
340382
0644
edit
dl
rm
n-api.json.gz
48682
0644
edit
dl
rm
n-api.md
206268
0644
edit
dl
rm
net.html
95113
0644
edit
dl
rm
net.json.gz
14265
0644
edit
dl
rm
net.md
40473
0644
edit
dl
rm
os.html
58658
0644
edit
dl
rm
os.json.gz
8576
0644
edit
dl
rm
os.md
34632
0644
edit
dl
rm
packages.html
65483
0644
edit
dl
rm
packages.json.gz
12401
0644
edit
dl
rm
packages.md
36538
0644
edit
dl
rm
path.html
39321
0644
edit
dl
rm
path.json.gz
4873
0644
edit
dl
rm
path.md
14750
0644
edit
dl
rm
perf_hooks.html
56215
0644
edit
dl
rm
perf_hooks.json.gz
6973
0644
edit
dl
rm
perf_hooks.md
20116
0644
edit
dl
rm
policy.html
15908
0644
edit
dl
rm
policy.json.gz
2908
0644
edit
dl
rm
policy.md
6324
0644
edit
dl
rm
process.html
169341
0644
edit
dl
rm
process.json.gz
27734
0644
edit
dl
rm
process.md
82162
0644
edit
dl
rm
punycode.html
16904
0644
edit
dl
rm
punycode.json.gz
1939
0644
edit
dl
rm
punycode.md
4063
0644
edit
dl
rm
querystring.html
19334
0644
edit
dl
rm
querystring.json.gz
2519
0644
edit
dl
rm
querystring.md
5423
0644
edit
dl
rm
readline.html
58434
0644
edit
dl
rm
readline.json.gz
8835
0644
edit
dl
rm
readline.md
25133
0644
edit
dl
rm
repl.html
54152
0644
edit
dl
rm
repl.json.gz
10053
0644
edit
dl
rm
repl.md
23754
0644
edit
dl
rm
report.html
44941
0644
edit
dl
rm
report.json.gz
6227
0644
edit
dl
rm
report.md
18287
0644
edit
dl
rm
stream.html
200501
0644
edit
dl
rm
stream.json.gz
34485
0644
edit
dl
rm
stream.md
98619
0644
edit
dl
rm
string_decoder.html
14415
0644
edit
dl
rm
string_decoder.json.gz
1545
0644
edit
dl
rm
string_decoder.md
2934
0644
edit
dl
rm
synopsis.html
11475
0644
edit
dl
rm
synopsis.json
3013
0644
edit
dl
rm
synopsis.md
2129
0644
edit
dl
rm
timers.html
27467
0644
edit
dl
rm
timers.json.gz
3637
0644
edit
dl
rm
timers.md
9738
0644
edit
dl
rm
tls.html
148381
0644
edit
dl
rm
tls.json.gz
29988
0644
edit
dl
rm
tls.md
81388
0644
edit
dl
rm
tracing.html
19586
0644
edit
dl
rm
tracing.json.gz
2829
0644
edit
dl
rm
tracing.md
6756
0644
edit
dl
rm
tty.html
26930
0644
edit
dl
rm
tty.json.gz
3758
0644
edit
dl
rm
tty.md
8989
0644
edit
dl
rm
url.html
97495
0644
edit
dl
rm
url.json.gz
13611
0644
edit
dl
rm
url.md
44869
0644
edit
dl
rm
util.html
178081
0644
edit
dl
rm
util.json.gz
20542
0644
edit
dl
rm
util.md
71255
0644
edit
dl
rm
v8.html
44688
0644
edit
dl
rm
v8.json.gz
6082
0644
edit
dl
rm
v8.md
15533
0644
edit
dl
rm
vm.html
103392
0644
edit
dl
rm
vm.json.gz
14023
0644
edit
dl
rm
vm.md
48293
0644
edit
dl
rm
wasi.html
17088
0644
edit
dl
rm
wasi.json.gz
2814
0644
edit
dl
rm
wasi.md
5932
0644
edit
dl
rm
worker_threads.html
70808
0644
edit
dl
rm
worker_threads.json.gz
11326
0644
edit
dl
rm
worker_threads.md
33883
0644
edit
dl
rm
zlib.html
90124
0644
edit
dl
rm
zlib.json.gz
10569
0644
edit
dl
rm
zlib.md
35697
0644
edit
dl
rm
Edit:
/usr/share/doc/nodejs/api/report.html
(44941B)
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width"> <meta name="nodejs.org:node-version" content="v12.20.0"> <title>Diagnostic report | Node.js v12.20.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"> </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_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 N-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="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="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>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="policy.html" class="nav-policy">Policies</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="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="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="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> <h1>Node.js v12.20.0 Documentation</h1> <div id="gtoc"> <ul> <li> <a href="index.html">Index</a> </li> <li> <a href="all.html">View on single page</a> </li> <li> <a href="report.json">View as JSON</a> </li> <li class="version-picker"> <a href="#">View another version <span>▼</span></a> <ol class="version-picker"><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 <b>LTS</b></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 <b>LTS</b></a></li> <li><a href="https://nodejs.org/docs/latest-v11.x/api/report.html">11.x</a></li></ol> </li> <li class="edit_on_github"><a href="https://github.com/nodejs/node/edit/master/doc/api/report.md"><span class="github_icon"><svg height="16" width="16" viewBox="0 0 16.1 16.1" fill="currentColor"><path d="M8 0a8 8 0 0 0-2.5 15.6c.4 0 .5-.2.5-.4v-1.5c-2 .4-2.5-.5-2.7-1 0-.1-.5-.9-.8-1-.3-.2-.7-.6 0-.6.6 0 1 .6 1.2.8.7 1.2 1.9 1 2.4.7 0-.5.2-.9.5-1-1.8-.3-3.7-1-3.7-4 0-.9.3-1.6.8-2.2 0-.2-.3-1 .1-2 0 0 .7-.3 2.2.7a7.4 7.4 0 0 1 4 0c1.5-1 2.2-.8 2.2-.8.5 1.1.2 2 .1 2.1.5.6.8 1.3.8 2.2 0 3-1.9 3.7-3.6 4 .3.2.5.7.5 1.4v2.2c0 .2.1.5.5.4A8 8 0 0 0 16 8a8 8 0 0 0-8-8z"/></svg></span>Edit on GitHub</a></li> </ul> </div> <hr> </header> <div id="toc"> <h2>Table of Contents</h2> <ul> <li><span class="stability_2"><a href="#report_diagnostic_report">Diagnostic report</a></span> <ul> <li><a href="#report_usage">Usage</a></li> <li><a href="#report_configuration">Configuration</a></li> <li><a href="#report_interaction_with_workers">Interaction with workers</a></li> </ul> </li> </ul> </div> <div id="apicontent"> <h1>Diagnostic report<span><a class="mark" href="#report_diagnostic_report" id="report_diagnostic_report">#</a></span></h1> <p></p><div class="api_stability api_stability_2"><a href="documentation.html#documentation_stability_index">Stability: 2</a> - Stable</div><p></p> <p>Delivers a JSON-formatted diagnostic summary, written to a file.</p> <p>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.</p> <p>A complete example report that was generated on an uncaught exception is provided below for reference.</p> <pre><code class="language-json">{ <span class="hljs-attr">"header"</span>: { <span class="hljs-attr">"reportVersion"</span>: <span class="hljs-number">1</span>, <span class="hljs-attr">"event"</span>: <span class="hljs-string">"exception"</span>, <span class="hljs-attr">"trigger"</span>: <span class="hljs-string">"Exception"</span>, <span class="hljs-attr">"filename"</span>: <span class="hljs-string">"report.20181221.005011.8974.0.001.json"</span>, <span class="hljs-attr">"dumpEventTime"</span>: <span class="hljs-string">"2018-12-21T00:50:11Z"</span>, <span class="hljs-attr">"dumpEventTimeStamp"</span>: <span class="hljs-string">"1545371411331"</span>, <span class="hljs-attr">"processId"</span>: <span class="hljs-number">8974</span>, <span class="hljs-attr">"cwd"</span>: <span class="hljs-string">"/home/nodeuser/project/node"</span>, <span class="hljs-attr">"commandLine"</span>: [ <span class="hljs-string">"/home/nodeuser/project/node/out/Release/node"</span>, <span class="hljs-string">"--report-uncaught-exception"</span>, <span class="hljs-string">"/home/nodeuser/project/node/test/report/test-exception.js"</span>, <span class="hljs-string">"child"</span> ], <span class="hljs-attr">"nodejsVersion"</span>: <span class="hljs-string">"v12.0.0-pre"</span>, <span class="hljs-attr">"glibcVersionRuntime"</span>: <span class="hljs-string">"2.17"</span>, <span class="hljs-attr">"glibcVersionCompiler"</span>: <span class="hljs-string">"2.17"</span>, <span class="hljs-attr">"wordSize"</span>: <span class="hljs-string">"64 bit"</span>, <span class="hljs-attr">"arch"</span>: <span class="hljs-string">"x64"</span>, <span class="hljs-attr">"platform"</span>: <span class="hljs-string">"linux"</span>, <span class="hljs-attr">"componentVersions"</span>: { <span class="hljs-attr">"node"</span>: <span class="hljs-string">"12.0.0-pre"</span>, <span class="hljs-attr">"v8"</span>: <span class="hljs-string">"7.1.302.28-node.5"</span>, <span class="hljs-attr">"uv"</span>: <span class="hljs-string">"1.24.1"</span>, <span class="hljs-attr">"zlib"</span>: <span class="hljs-string">"1.2.11"</span>, <span class="hljs-attr">"ares"</span>: <span class="hljs-string">"1.15.0"</span>, <span class="hljs-attr">"modules"</span>: <span class="hljs-string">"68"</span>, <span class="hljs-attr">"nghttp2"</span>: <span class="hljs-string">"1.34.0"</span>, <span class="hljs-attr">"napi"</span>: <span class="hljs-string">"3"</span>, <span class="hljs-attr">"llhttp"</span>: <span class="hljs-string">"1.0.1"</span>, <span class="hljs-attr">"http_parser"</span>: <span class="hljs-string">"2.8.0"</span>, <span class="hljs-attr">"openssl"</span>: <span class="hljs-string">"1.1.0j"</span> }, <span class="hljs-attr">"release"</span>: { <span class="hljs-attr">"name"</span>: <span class="hljs-string">"node"</span> }, <span class="hljs-attr">"osName"</span>: <span class="hljs-string">"Linux"</span>, <span class="hljs-attr">"osRelease"</span>: <span class="hljs-string">"3.10.0-862.el7.x86_64"</span>, <span class="hljs-attr">"osVersion"</span>: <span class="hljs-string">"#1 SMP Wed Mar 21 18:14:51 EDT 2018"</span>, <span class="hljs-attr">"osMachine"</span>: <span class="hljs-string">"x86_64"</span>, <span class="hljs-attr">"cpus"</span>: [ { <span class="hljs-attr">"model"</span>: <span class="hljs-string">"Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz"</span>, <span class="hljs-attr">"speed"</span>: <span class="hljs-number">2700</span>, <span class="hljs-attr">"user"</span>: <span class="hljs-number">88902660</span>, <span class="hljs-attr">"nice"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"sys"</span>: <span class="hljs-number">50902570</span>, <span class="hljs-attr">"idle"</span>: <span class="hljs-number">241732220</span>, <span class="hljs-attr">"irq"</span>: <span class="hljs-number">0</span> }, { <span class="hljs-attr">"model"</span>: <span class="hljs-string">"Intel(R) Core(TM) i7-6820HQ CPU @ 2.70GHz"</span>, <span class="hljs-attr">"speed"</span>: <span class="hljs-number">2700</span>, <span class="hljs-attr">"user"</span>: <span class="hljs-number">88902660</span>, <span class="hljs-attr">"nice"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"sys"</span>: <span class="hljs-number">50902570</span>, <span class="hljs-attr">"idle"</span>: <span class="hljs-number">241732220</span>, <span class="hljs-attr">"irq"</span>: <span class="hljs-number">0</span> } ], <span class="hljs-attr">"networkInterfaces"</span>: [ { <span class="hljs-attr">"name"</span>: <span class="hljs-string">"en0"</span>, <span class="hljs-attr">"internal"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"mac"</span>: <span class="hljs-string">"13:10:de:ad:be:ef"</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"10.0.0.37"</span>, <span class="hljs-attr">"netmask"</span>: <span class="hljs-string">"255.255.255.0"</span>, <span class="hljs-attr">"family"</span>: <span class="hljs-string">"IPv4"</span> } ], <span class="hljs-attr">"host"</span>: <span class="hljs-string">"test_machine"</span> }, <span class="hljs-attr">"javascriptStack"</span>: { <span class="hljs-attr">"message"</span>: <span class="hljs-string">"Error: *** test-exception.js: throwing uncaught Error"</span>, <span class="hljs-attr">"stack"</span>: [ <span class="hljs-string">"at myException (/home/nodeuser/project/node/test/report/test-exception.js:9:11)"</span>, <span class="hljs-string">"at Object.<anonymous> (/home/nodeuser/project/node/test/report/test-exception.js:12:3)"</span>, <span class="hljs-string">"at Module._compile (internal/modules/cjs/loader.js:718:30)"</span>, <span class="hljs-string">"at Object.Module._extensions..js (internal/modules/cjs/loader.js:729:10)"</span>, <span class="hljs-string">"at Module.load (internal/modules/cjs/loader.js:617:32)"</span>, <span class="hljs-string">"at tryModuleLoad (internal/modules/cjs/loader.js:560:12)"</span>, <span class="hljs-string">"at Function.Module._load (internal/modules/cjs/loader.js:552:3)"</span>, <span class="hljs-string">"at Function.Module.runMain (internal/modules/cjs/loader.js:771:12)"</span>, <span class="hljs-string">"at executeUserCode (internal/bootstrap/node.js:332:15)"</span> ] }, <span class="hljs-attr">"nativeStack"</span>: [ { <span class="hljs-attr">"pc"</span>: <span class="hljs-string">"0x000055b57f07a9ef"</span>, <span class="hljs-attr">"symbol"</span>: <span class="hljs-string">"report::GetNodeReport(v8::Isolate*, node::Environment*, char const*, char const*, v8::Local<v8::String>, std::ostream&) [./node]"</span> }, { <span class="hljs-attr">"pc"</span>: <span class="hljs-string">"0x000055b57f07cf03"</span>, <span class="hljs-attr">"symbol"</span>: <span class="hljs-string">"report::GetReport(v8::FunctionCallbackInfo<v8::Value> const&) [./node]"</span> }, { <span class="hljs-attr">"pc"</span>: <span class="hljs-string">"0x000055b57f1bccfd"</span>, <span class="hljs-attr">"symbol"</span>: <span class="hljs-string">" [./node]"</span> }, { <span class="hljs-attr">"pc"</span>: <span class="hljs-string">"0x000055b57f1be048"</span>, <span class="hljs-attr">"symbol"</span>: <span class="hljs-string">"v8::internal::Builtin_HandleApiCall(int, v8::internal::Object**, v8::internal::Isolate*) [./node]"</span> }, { <span class="hljs-attr">"pc"</span>: <span class="hljs-string">"0x000055b57feeda0e"</span>, <span class="hljs-attr">"symbol"</span>: <span class="hljs-string">" [./node]"</span> } ], <span class="hljs-attr">"javascriptHeap"</span>: { <span class="hljs-attr">"totalMemory"</span>: <span class="hljs-number">6127616</span>, <span class="hljs-attr">"totalCommittedMemory"</span>: <span class="hljs-number">4357352</span>, <span class="hljs-attr">"usedMemory"</span>: <span class="hljs-number">3221136</span>, <span class="hljs-attr">"availableMemory"</span>: <span class="hljs-number">1521370240</span>, <span class="hljs-attr">"memoryLimit"</span>: <span class="hljs-number">1526909922</span>, <span class="hljs-attr">"heapSpaces"</span>: { <span class="hljs-attr">"read_only_space"</span>: { <span class="hljs-attr">"memorySize"</span>: <span class="hljs-number">524288</span>, <span class="hljs-attr">"committedMemory"</span>: <span class="hljs-number">39208</span>, <span class="hljs-attr">"capacity"</span>: <span class="hljs-number">515584</span>, <span class="hljs-attr">"used"</span>: <span class="hljs-number">30504</span>, <span class="hljs-attr">"available"</span>: <span class="hljs-number">485080</span> }, <span class="hljs-attr">"new_space"</span>: { <span class="hljs-attr">"memorySize"</span>: <span class="hljs-number">2097152</span>, <span class="hljs-attr">"committedMemory"</span>: <span class="hljs-number">2019312</span>, <span class="hljs-attr">"capacity"</span>: <span class="hljs-number">1031168</span>, <span class="hljs-attr">"used"</span>: <span class="hljs-number">985496</span>, <span class="hljs-attr">"available"</span>: <span class="hljs-number">45672</span> }, <span class="hljs-attr">"old_space"</span>: { <span class="hljs-attr">"memorySize"</span>: <span class="hljs-number">2273280</span>, <span class="hljs-attr">"committedMemory"</span>: <span class="hljs-number">1769008</span>, <span class="hljs-attr">"capacity"</span>: <span class="hljs-number">1974640</span>, <span class="hljs-attr">"used"</span>: <span class="hljs-number">1725488</span>, <span class="hljs-attr">"available"</span>: <span class="hljs-number">249152</span> }, <span class="hljs-attr">"code_space"</span>: { <span class="hljs-attr">"memorySize"</span>: <span class="hljs-number">696320</span>, <span class="hljs-attr">"committedMemory"</span>: <span class="hljs-number">184896</span>, <span class="hljs-attr">"capacity"</span>: <span class="hljs-number">152128</span>, <span class="hljs-attr">"used"</span>: <span class="hljs-number">152128</span>, <span class="hljs-attr">"available"</span>: <span class="hljs-number">0</span> }, <span class="hljs-attr">"map_space"</span>: { <span class="hljs-attr">"memorySize"</span>: <span class="hljs-number">536576</span>, <span class="hljs-attr">"committedMemory"</span>: <span class="hljs-number">344928</span>, <span class="hljs-attr">"capacity"</span>: <span class="hljs-number">327520</span>, <span class="hljs-attr">"used"</span>: <span class="hljs-number">327520</span>, <span class="hljs-attr">"available"</span>: <span class="hljs-number">0</span> }, <span class="hljs-attr">"large_object_space"</span>: { <span class="hljs-attr">"memorySize"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"committedMemory"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"capacity"</span>: <span class="hljs-number">1520590336</span>, <span class="hljs-attr">"used"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"available"</span>: <span class="hljs-number">1520590336</span> }, <span class="hljs-attr">"new_large_object_space"</span>: { <span class="hljs-attr">"memorySize"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"committedMemory"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"capacity"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"used"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"available"</span>: <span class="hljs-number">0</span> } } }, <span class="hljs-attr">"resourceUsage"</span>: { <span class="hljs-attr">"userCpuSeconds"</span>: <span class="hljs-number">0.069595</span>, <span class="hljs-attr">"kernelCpuSeconds"</span>: <span class="hljs-number">0.019163</span>, <span class="hljs-attr">"cpuConsumptionPercent"</span>: <span class="hljs-number">0.000000</span>, <span class="hljs-attr">"maxRss"</span>: <span class="hljs-number">18079744</span>, <span class="hljs-attr">"pageFaults"</span>: { <span class="hljs-attr">"IORequired"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"IONotRequired"</span>: <span class="hljs-number">4610</span> }, <span class="hljs-attr">"fsActivity"</span>: { <span class="hljs-attr">"reads"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"writes"</span>: <span class="hljs-number">0</span> } }, <span class="hljs-attr">"uvthreadResourceUsage"</span>: { <span class="hljs-attr">"userCpuSeconds"</span>: <span class="hljs-number">0.068457</span>, <span class="hljs-attr">"kernelCpuSeconds"</span>: <span class="hljs-number">0.019127</span>, <span class="hljs-attr">"cpuConsumptionPercent"</span>: <span class="hljs-number">0.000000</span>, <span class="hljs-attr">"fsActivity"</span>: { <span class="hljs-attr">"reads"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"writes"</span>: <span class="hljs-number">0</span> } }, <span class="hljs-attr">"libuv"</span>: [ { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"async"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x0000000102910900"</span>, <span class="hljs-attr">"details"</span>: <span class="hljs-string">""</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"timer"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x00007fff5fbfeab0"</span>, <span class="hljs-attr">"repeat"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"firesInMsFromNow"</span>: <span class="hljs-number">94403548320796</span>, <span class="hljs-attr">"expired"</span>: <span class="hljs-literal">true</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"check"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x00007fff5fbfeb48"</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"idle"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x00007fff5fbfebc0"</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"prepare"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x00007fff5fbfec38"</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"check"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x00007fff5fbfecb0"</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"async"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x000000010188f2e0"</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"tty"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x000055b581db0e18"</span>, <span class="hljs-attr">"width"</span>: <span class="hljs-number">204</span>, <span class="hljs-attr">"height"</span>: <span class="hljs-number">55</span>, <span class="hljs-attr">"fd"</span>: <span class="hljs-number">17</span>, <span class="hljs-attr">"writeQueueSize"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"readable"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"writable"</span>: <span class="hljs-literal">true</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"signal"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">false</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x000055b581d80010"</span>, <span class="hljs-attr">"signum"</span>: <span class="hljs-number">28</span>, <span class="hljs-attr">"signal"</span>: <span class="hljs-string">"SIGWINCH"</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"tty"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"is_referenced"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x000055b581df59f8"</span>, <span class="hljs-attr">"width"</span>: <span class="hljs-number">204</span>, <span class="hljs-attr">"height"</span>: <span class="hljs-number">55</span>, <span class="hljs-attr">"fd"</span>: <span class="hljs-number">19</span>, <span class="hljs-attr">"writeQueueSize"</span>: <span class="hljs-number">0</span>, <span class="hljs-attr">"readable"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"writable"</span>: <span class="hljs-literal">true</span> }, { <span class="hljs-attr">"type"</span>: <span class="hljs-string">"loop"</span>, <span class="hljs-attr">"is_active"</span>: <span class="hljs-literal">true</span>, <span class="hljs-attr">"address"</span>: <span class="hljs-string">"0x000055fc7b2cb180"</span> } ], <span class="hljs-attr">"workers"</span>: [], <span class="hljs-attr">"environmentVariables"</span>: { <span class="hljs-attr">"REMOTEHOST"</span>: <span class="hljs-string">"REMOVED"</span>, <span class="hljs-attr">"MANPATH"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root/usr/share/man:"</span>, <span class="hljs-attr">"XDG_SESSION_ID"</span>: <span class="hljs-string">"66126"</span>, <span class="hljs-attr">"HOSTNAME"</span>: <span class="hljs-string">"test_machine"</span>, <span class="hljs-attr">"HOST"</span>: <span class="hljs-string">"test_machine"</span>, <span class="hljs-attr">"TERM"</span>: <span class="hljs-string">"xterm-256color"</span>, <span class="hljs-attr">"SHELL"</span>: <span class="hljs-string">"/bin/csh"</span>, <span class="hljs-attr">"SSH_CLIENT"</span>: <span class="hljs-string">"REMOVED"</span>, <span class="hljs-attr">"PERL5LIB"</span>: <span class="hljs-string">"/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"</span>, <span class="hljs-attr">"OLDPWD"</span>: <span class="hljs-string">"/home/nodeuser/project/node/src"</span>, <span class="hljs-attr">"JAVACONFDIRS"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root/etc/java:/etc/java"</span>, <span class="hljs-attr">"SSH_TTY"</span>: <span class="hljs-string">"/dev/pts/0"</span>, <span class="hljs-attr">"PCP_DIR"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root"</span>, <span class="hljs-attr">"GROUP"</span>: <span class="hljs-string">"normaluser"</span>, <span class="hljs-attr">"USER"</span>: <span class="hljs-string">"nodeuser"</span>, <span class="hljs-attr">"LD_LIBRARY_PATH"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root/usr/lib64:/opt/rh/devtoolset-3/root/usr/lib"</span>, <span class="hljs-attr">"HOSTTYPE"</span>: <span class="hljs-string">"x86_64-linux"</span>, <span class="hljs-attr">"XDG_CONFIG_DIRS"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root/etc/xdg:/etc/xdg"</span>, <span class="hljs-attr">"MAIL"</span>: <span class="hljs-string">"/var/spool/mail/nodeuser"</span>, <span class="hljs-attr">"PATH"</span>: <span class="hljs-string">"/home/nodeuser/project/node:/opt/rh/devtoolset-3/root/usr/bin:/usr/local/bin:/usr/bin:/usr/local/sbin:/usr/sbin"</span>, <span class="hljs-attr">"PWD"</span>: <span class="hljs-string">"/home/nodeuser/project/node"</span>, <span class="hljs-attr">"LANG"</span>: <span class="hljs-string">"en_US.UTF-8"</span>, <span class="hljs-attr">"PS1"</span>: <span class="hljs-string">"\\u@\\h : \\[\\e[31m\\]\\w\\[\\e[m\\] > "</span>, <span class="hljs-attr">"SHLVL"</span>: <span class="hljs-string">"2"</span>, <span class="hljs-attr">"HOME"</span>: <span class="hljs-string">"/home/nodeuser"</span>, <span class="hljs-attr">"OSTYPE"</span>: <span class="hljs-string">"linux"</span>, <span class="hljs-attr">"VENDOR"</span>: <span class="hljs-string">"unknown"</span>, <span class="hljs-attr">"PYTHONPATH"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root/usr/lib64/python2.7/site-packages:/opt/rh/devtoolset-3/root/usr/lib/python2.7/site-packages"</span>, <span class="hljs-attr">"MACHTYPE"</span>: <span class="hljs-string">"x86_64"</span>, <span class="hljs-attr">"LOGNAME"</span>: <span class="hljs-string">"nodeuser"</span>, <span class="hljs-attr">"XDG_DATA_DIRS"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root/usr/share:/usr/local/share:/usr/share"</span>, <span class="hljs-attr">"LESSOPEN"</span>: <span class="hljs-string">"||/usr/bin/lesspipe.sh %s"</span>, <span class="hljs-attr">"INFOPATH"</span>: <span class="hljs-string">"/opt/rh/devtoolset-3/root/usr/share/info"</span>, <span class="hljs-attr">"XDG_RUNTIME_DIR"</span>: <span class="hljs-string">"/run/user/50141"</span>, <span class="hljs-attr">"_"</span>: <span class="hljs-string">"./node"</span> }, <span class="hljs-attr">"userLimits"</span>: { <span class="hljs-attr">"core_file_size_blocks"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">""</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-string">"unlimited"</span> }, <span class="hljs-attr">"data_seg_size_kbytes"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-string">"unlimited"</span> }, <span class="hljs-attr">"file_size_blocks"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-string">"unlimited"</span> }, <span class="hljs-attr">"max_locked_memory_bytes"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-number">65536</span> }, <span class="hljs-attr">"max_memory_size_kbytes"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-string">"unlimited"</span> }, <span class="hljs-attr">"open_files"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-number">4096</span> }, <span class="hljs-attr">"stack_size_bytes"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-string">"unlimited"</span> }, <span class="hljs-attr">"cpu_time_seconds"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-string">"unlimited"</span> }, <span class="hljs-attr">"max_user_processes"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-number">4127290</span> }, <span class="hljs-attr">"virtual_memory_kbytes"</span>: { <span class="hljs-attr">"soft"</span>: <span class="hljs-string">"unlimited"</span>, <span class="hljs-attr">"hard"</span>: <span class="hljs-string">"unlimited"</span> } }, <span class="hljs-attr">"sharedObjects"</span>: [ <span class="hljs-string">"/lib64/libdl.so.2"</span>, <span class="hljs-string">"/lib64/librt.so.1"</span>, <span class="hljs-string">"/lib64/libstdc++.so.6"</span>, <span class="hljs-string">"/lib64/libm.so.6"</span>, <span class="hljs-string">"/lib64/libgcc_s.so.1"</span>, <span class="hljs-string">"/lib64/libpthread.so.0"</span>, <span class="hljs-string">"/lib64/libc.so.6"</span>, <span class="hljs-string">"/lib64/ld-linux-x86-64.so.2"</span> ] }</code></pre> <h2>Usage<span><a class="mark" href="#report_usage" id="report_usage">#</a></span></h2> <pre><code class="language-bash">node --report-uncaught-exception --report-on-signal \ --report-on-fatalerror app.js</code></pre> <ul> <li> <p><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.</p> </li> <li> <p><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.</p> </li> </ul> <p>Signal based report generation is not supported in Windows.</p> <p>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.</p> <ul> <li> <p><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.</p> </li> <li> <p><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.</p> </li> <li> <p><code>--report-directory</code> Location at which the report will be generated.</p> </li> <li> <p><code>--report-filename</code> Name of the file to which the report will be written.</p> </li> <li> <p><code>--report-signal</code> Sets or resets the signal for report generation (not supported on Windows). Default signal is <code>SIGUSR2</code>.</p> </li> </ul> <p>A report can also be triggered via an API call from a JavaScript application:</p> <pre><code class="language-js">process.report.writeReport();</code></pre> <p>This function takes an optional additional argument <code>filename</code>, which is the name of a file into which the report is written.</p> <pre><code class="language-js">process.report.writeReport(<span class="hljs-string">'./foo.json'</span>);</code></pre> <p>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.</p> <pre><code class="language-js"><span class="hljs-keyword">try</span> { process.chdir(<span class="hljs-string">'/non-existent-path'</span>); } <span class="hljs-keyword">catch</span> (err) { process.report.writeReport(err); } <span class="hljs-comment">// Any other code</span></code></pre> <p>If both filename and error object are passed to <code>writeReport()</code> the error object must be the second parameter.</p> <pre><code class="language-js"><span class="hljs-keyword">try</span> { process.chdir(<span class="hljs-string">'/non-existent-path'</span>); } <span class="hljs-keyword">catch</span> (err) { process.report.writeReport(filename, err); } <span class="hljs-comment">// Any other code</span></code></pre> <p>The content of the diagnostic report can be returned as a JavaScript Object via an API call from a JavaScript application:</p> <pre><code class="language-js"><span class="hljs-keyword">const</span> report = process.report.getReport(); <span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">typeof</span> report === <span class="hljs-string">'object'</span>); <span class="hljs-comment">// true</span> <span class="hljs-comment">// Similar to process.report.writeReport() output</span> <span class="hljs-built_in">console</span>.log(<span class="hljs-built_in">JSON</span>.stringify(report, <span class="hljs-literal">null</span>, <span class="hljs-number">2</span>));</code></pre> <p>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.</p> <pre><code class="language-js"><span class="hljs-keyword">const</span> report = process.report.getReport(<span class="hljs-keyword">new</span> <span class="hljs-built_in">Error</span>(<span class="hljs-string">'custom error'</span>)); <span class="hljs-built_in">console</span>.log(<span class="hljs-keyword">typeof</span> report === <span class="hljs-string">'object'</span>); <span class="hljs-comment">// true</span></code></pre> <p>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.</p> <p>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:</p> <pre><code class="language-console"><span class="hljs-meta">$</span><span class="bash"> node</span> <span class="hljs-meta">></span><span class="bash"> process.report.writeReport();</span> Writing Node.js report to file: report.20181126.091102.8480.0.001.json Node.js report completed <span class="hljs-meta">></span></code></pre> <p>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.</p> <h2>Configuration<span><a class="mark" href="#report_configuration" id="report_configuration">#</a></span></h2> <p>Additional runtime configuration of report generation is available via the following properties of <code>process.report</code>:</p> <p><code>reportOnFatalError</code> triggers diagnostic reporting on fatal errors when <code>true</code>. Defaults to <code>false</code>.</p> <p><code>reportOnSignal</code> triggers diagnostic reporting on signal when <code>true</code>. This is not supported on Windows. Defaults to <code>false</code>.</p> <p><code>reportOnUncaughtException</code> triggers diagnostic reporting on uncaught exception when <code>true</code>. Defaults to <code>false</code>.</p> <p><code>signal</code> specifies the POSIX signal identifier that will be used to intercept external triggers for report generation. Defaults to <code>'SIGUSR2'</code>.</p> <p><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.</p> <p><code>directory</code> specifies the filesystem directory where the report will be written. URLs are not supported. Defaults to the current working directory of the Node.js process.</p> <pre><code class="language-js"><span class="hljs-comment">// Trigger report only on uncaught exceptions.</span> process.report.reportOnFatalError = <span class="hljs-literal">false</span>; process.report.reportOnSignal = <span class="hljs-literal">false</span>; process.report.reportOnUncaughtException = <span class="hljs-literal">true</span>; <span class="hljs-comment">// Trigger report for both internal errors as well as external signal.</span> process.report.reportOnFatalError = <span class="hljs-literal">true</span>; process.report.reportOnSignal = <span class="hljs-literal">true</span>; process.report.reportOnUncaughtException = <span class="hljs-literal">false</span>; <span class="hljs-comment">// Change the default signal to 'SIGQUIT' and enable it.</span> process.report.reportOnFatalError = <span class="hljs-literal">false</span>; process.report.reportOnUncaughtException = <span class="hljs-literal">false</span>; process.report.reportOnSignal = <span class="hljs-literal">true</span>; process.report.signal = <span class="hljs-string">'SIGQUIT'</span>;</code></pre> <p>Configuration on module initialization is also available via environment variables:</p> <pre><code class="language-bash">NODE_OPTIONS=<span class="hljs-string">"--report-uncaught-exception \ --report-on-fatalerror --report-on-signal \ --report-signal=SIGUSR2 --report-filename=./report.json \ --report-directory=/home/nodeuser"</span></code></pre> <p>Specific API documentation can be found under <a href="process.html"><code>process API documentation</code></a> section.</p> <h2>Interaction with workers<span><a class="mark" href="#report_interaction_with_workers" id="report_interaction_with_workers">#</a></span></h2> <div class="api_metadata"> <details class="changelog"><summary>History</summary> <table> <tbody><tr><th>Version</th><th>Changes</th></tr> <tr><td>v12.16.2</td> <td><p>Workers are now included in the report.</p></td></tr> </tbody></table> </details> </div> <p><a href="worker_threads.html"><code>Worker</code></a> threads can create reports in the same way that the main thread does.</p> <p>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.</p> <p>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.</p> <!-- API END --> </div> </div> </div> </body> </html>
Save
cmd:
run