src: add loop idle time in diagnostic report

Add libuv's cumulative idle time in the diagnostic report. Add the data under the libuv's loop section Refs: #34938 PR-URL: #35940 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Richard Lau <[email protected]>
nodejs · Apr 6, 2021 · 4486801 · 4486801
1 parent 5d29781
commit 4486801
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 1 deletion.
diff --git a/doc/api/report.md b/doc/api/report.md
@@ -292,7 +292,8 @@ is provided below for reference.
     {
       "type": "loop",
       "is_active": true,
-      "address": "0x000055fc7b2cb180"
+      "address": "0x000055fc7b2cb180",
+      "loopIdleTimeSeconds": 22644.8
     }
   ],
   "workers": [],

diff --git a/src/node_report.cc b/src/node_report.cc
@@ -294,6 +294,10 @@ static void WriteNodeReport(Isolate* isolate,
         static_cast<bool>(uv_loop_alive(env->event_loop())));
     writer.json_keyvalue("address",
         ValueToHexString(reinterpret_cast<int64_t>(env->event_loop())));
+
+    // Report Event loop idle time
+    uint64_t idle_time = uv_metrics_idle_time(env->event_loop());
+    writer.json_keyvalue("loopIdleTimeSeconds", 1.0 * idle_time / 1e9);
     writer.json_end();
   }
 

diff --git a/test/report/test-report-uv-handles.js b/test/report/test-report-uv-handles.js
@@ -128,6 +128,9 @@ if (process.argv[2] === 'child') {
         assert.strictEqual(handle.filename, expected_filename);
         assert(handle.is_referenced);
       }),
+      loop: common.mustCall(function loop_validator(handle) {
+        assert.strictEqual(typeof handle.loopIdleTimeSeconds, 'number');
+      }),
       pipe: common.mustCallAtLeast(function pipe_validator(handle) {
         assert(handle.is_referenced);
       }),