Skip to content

Commit

Permalink
report,doc: define report version semantics
Browse files Browse the repository at this point in the history
Diagnostics report has a version number representing its format,
yet its rule is not defined. This doc change specifies the rule.

Refs: nodejs/diagnostics#349
Refs: #28121 (comment)
PR-URL: #45050
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
  • Loading branch information
gireeshpunathil authored and danielleadams committed Dec 28, 2022
1 parent 1445b35 commit 6e5d411
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions doc/api/report.md
Original file line number Diff line number Diff line change
Expand Up @@ -528,6 +528,11 @@ 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 (`report.header.reportVersion`),
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.

## Configuration

Additional runtime configuration of report generation is available via
Expand Down

0 comments on commit 6e5d411

Please sign in to comment.