OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: update stability of report features

Browse Source 
This commit updates the stability documentation for the report
feature. All diagnostic report APIs are now listed as stable,
with the exception of report-on-fatalerror, which still has a
few bugs to work out.

PR-URL: https://github.com/nodejs/node/pull/32242
Fixes: https://github.com/nodejs/node/issues/26293
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: David Carlier <devnexen@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
This commit is contained in:
cjihrig
2020-03-13 00:28:01 -04:00
parent 9d1a3b6f60
commit a022d387ea
3 changed files with 50 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
doc/api/cli.md
View File

@@ -596,6 +596,9 @@ warning will be written to stderr instead.
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This option is no longer considered experimental.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: Changed from `--diagnostic-report-directory` to
@@ -608,6 +611,9 @@ Location at which the report will be generated.
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This option is no longer considered experimental.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-filename` to
@@ -626,6 +632,8 @@ changes:
`--report-on-fatalerror`
-->
> Stability: 1 - Experimental
Enables the report to be triggered on fatal errors (internal errors within
the Node.js runtime such as out of memory) that lead to termination of the
application. Useful to inspect various diagnostic data elements such as heap,
@@ -636,6 +644,9 @@ error.
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This option is no longer considered experimental.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-on-signal` to
@@ -650,6 +661,9 @@ specified through `--report-signal`.
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This option is no longer considered experimental.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-signal` to
@@ -663,6 +677,9 @@ Default signal is `SIGUSR2`.
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This option is no longer considered experimental.
- version: v12.0.0
pr-url: https://github.com/nodejs/node/pull/27312
description: changed from `--diagnostic-report-uncaught-exception` to

48
doc/api/process.md
View File

@@ -1783,10 +1783,12 @@ relied upon to exist.
## `process.report`
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* {Object}
`process.report` is an object whose methods are used to generate diagnostic
@@ -1796,10 +1798,12 @@ reports for the current process. Additional documentation is available in the
### `process.report.directory`
<!-- YAML
added: v11.12.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* {string}
Directory where the report is written. The default value is the empty string,
@@ -1813,10 +1817,12 @@ console.log(`Report directory is ${process.report.directory}`);
### `process.report.filename`
<!-- YAML
added: v11.12.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* {string}
Filename where the report is written. If set to the empty string, the output
@@ -1830,10 +1836,12 @@ console.log(`Report filename is ${process.report.filename}`);
### `process.report.getReport([err])`
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* `err` {Error} A custom error used for reporting the JavaScript stack.
* Returns: {Object}
@@ -1871,10 +1879,12 @@ console.log(`Report on fatal error: ${process.report.reportOnFatalError}`);
### `process.report.reportOnSignal`
<!-- YAML
added: v11.12.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* {boolean}
If `true`, a diagnostic report is generated when the process receives the
@@ -1887,10 +1897,12 @@ console.log(`Report on signal: ${process.report.reportOnSignal}`);
### `process.report.reportOnUncaughtException`
<!-- YAML
added: v11.12.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* {boolean}
If `true`, a diagnostic report is generated on uncaught exception.
@@ -1902,10 +1914,12 @@ console.log(`Report on exception: ${process.report.reportOnUncaughtException}`);
### `process.report.signal`
<!-- YAML
added: v11.12.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* {string}
The signal used to trigger the creation of a diagnostic report. Defaults to
@@ -1918,10 +1932,12 @@ console.log(`Report signal: ${process.report.signal}`);
### `process.report.writeReport([filename][, err])`
<!-- YAML
added: v11.8.0
changes:
- version: REPLACEME
pr-url: https://github.com/nodejs/node/pull/32242
description: This API is no longer considered experimental.
-->
> Stability: 1 - Experimental
* `filename` {string} Name of the file where the report is written. This
should be a relative path, that will be appended to the directory specified in
`process.report.directory`, or the current working directory of the Node.js

2
doc/api/report.md
View File

@@ -3,7 +3,7 @@
<!--introduced_in=v11.8.0-->
<!-- type=misc -->
> Stability: 1 - Experimental
> Stability: 2 - Stable
<!-- name=report -->