Skip to content
Permalink
Browse files

report: add report versioning

This commit adds a version to the diagnostic report feature.

PR-URL: #28121
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
  • Loading branch information...
cjihrig authored and targos committed Jun 7, 2019
1 parent db65594 commit c4a357dadafffab5f342aa765a45c7d3c14e2d95
Showing with 6 additions and 2 deletions.
  1. +1 −0 doc/api/report.md
  2. +2 −1 src/node_report.cc
  3. +3 −1 test/common/report.js
@@ -22,6 +22,7 @@ is provided below for reference.
```json
{
"header": {
"reportVersion": 1,
"event": "exception",
"trigger": "Exception",
"filename": "report.20181221.005011.8974.0.001.json",
@@ -24,6 +24,7 @@
extern char** environ;
#endif

constexpr int NODE_REPORT_VERSION = 1;
constexpr int NANOS_PER_SEC = 1000 * 1000 * 1000;
constexpr double SEC_PER_MICROS = 1e-6;

@@ -172,7 +173,7 @@ static void WriteNodeReport(Isolate* isolate,
JSONWriter writer(out);
writer.json_start();
writer.json_objectstart("header");

writer.json_keyvalue("reportVersion", NODE_REPORT_VERSION);
writer.json_keyvalue("event", message);
writer.json_keyvalue("trigger", trigger);
if (!filename.empty())
@@ -63,8 +63,10 @@ function _validateContent(data) {
'nodejsVersion', 'wordSize', 'arch', 'platform',
'componentVersions', 'release', 'osName', 'osRelease',
'osVersion', 'osMachine', 'cpus', 'host',
'glibcVersionRuntime', 'glibcVersionCompiler', 'cwd'];
'glibcVersionRuntime', 'glibcVersionCompiler', 'cwd',
'reportVersion'];
checkForUnknownFields(header, headerFields);
assert.strictEqual(header.reportVersion, 1); // Increment as needed.
assert.strictEqual(typeof header.event, 'string');
assert.strictEqual(typeof header.trigger, 'string');
assert(typeof header.filename === 'string' || header.filename === null);

0 comments on commit c4a357d

Please sign in to comment.
You can’t perform that action at this time.