diff --git a/doc/api/report.md b/doc/api/report.md index ecfd666775506c..6d5341a59a2f4b 100644 --- a/doc/api/report.md +++ b/doc/api/report.md @@ -10,7 +10,7 @@ Delivers a JSON-formatted diagnostic summary, written to a file. -The report is intended for development, test and production use, to capture +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 @@ -508,9 +508,9 @@ 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 +type, date, time, PID, and Node.js version, sections containing JavaScript and native stack traces, a section containing V8 heap information, a section -containing `libuv` handle information and an OS platform information section +containing `libuv` 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: