Skip to content

doc: upgrade stability status of report API #35654

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gireeshpunathil merged 1 commit into from
Oct 19, 2020
+4 −2
Merged

doc: upgrade stability status of report API #35654

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
doc: upgrade stability status of report API 
The property `process.report.reportOnFatalError`
was deemed experimental, as it was not honored
under certain scenarios (for example out of memory
conditions). The report configuration were previously
stored on the `environment` structure which was not
available on these types of fatal error cases.

The referenced PR has addressed this case (sometime
back), and the property is working as intended.

Refs: #32207
PR-URL: #35654
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Beth Griggs <bgriggs@redhat.com>
  • Loading branch information
@gireeshpunathil
gireeshpunathil committed Oct 19, 2020
commit 7798e59e988a66e731cc233f4a2fbee01269736d
6 changes: 4 additions & 2 deletions doc/api/process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1913,10 +1913,12 @@ Additional documentation is available in the [report documentation][].
### `process.report.reportOnFatalError`
<!-- YAML
added: v11.12.0
changes:
- version:
- REPLACEME
description: This API is no longer experimental.
-->

> Stability: 1 - Experimental

* {boolean}

If `true`, a diagnostic report is generated on fatal errors, such as out of
Expand Down