display fix + sysmetrics by default

Author: Unitech

CHANGELOG.md

@@ -4,11 +4,19 @@
 ### Bug Fixes
 
 - Fix `pm2 serve` returning 403 Forbidden on Windows — traversal guard used hardcoded `/` separator #6109
-- Fix `pm2 ls` table misalignment when a username exceeds the `user` column width — cli-tableau's `truncate()` miscounts ANSI bytes, so styled usernames were cut too short and leaked bold into the `watching` column
-- `pm2 ls` host-metrics line now only lists network interfaces that are actually carrying traffic (hides idle interfaces like utun, awdl, bridge, anpi, and unused en*)
-- `pm2 ls` host-metrics line: replaced `mem free` with `ram usage` (%), added GPU memory/temperature when a GPU reports it, and per-interface network errors/drops shown only when non-zero
-- `pm2 ls` now switches to the condensed layout based on the table's actual computed width vs. the terminal width (instead of a fixed column-count threshold that ignored the dynamic name column), and caps the `name` column at 40 chars so a long process name can't overflow the table
+- Fix `pm2 ls` table misalignment when a username exceeds the `user` column width — cli-tableau's `truncate()` miscounts ANSI bytes, leaking bold into the `watching` column
+- Fix long status lines (e.g. `Applying action … on app […]`) wrapping on narrow terminals — `Common.printOut` now ANSI-aware crops single-line TTY output to terminal width (piped output unaffected)
 
+### Features
+
+- `pm2 ls` host-metrics line now shown by default`pm2 update`)
+- `pm2 ls` adaptive layout: picks the widest layout that fits the terminal — full → condensed → new ultra-compact `mini` (`id · name · status · cpu · mem`) — and caps the `name` column so long names can't overflow the table
+- `pm2 ls` host-metrics line only lists network interfaces carrying traffic (hides idle utun/awdl/bridge/anpi/unused en*)
+- `pm2 ls` host-metrics line: replaced `mem free` with `ram usage` (%), added GPU memory/temperature when reported, per-interface network errors/drops shown when non-zero
+
+### Core Refactor
+
+- Replace the bundled `pm2-sysmonit` module and `systeminformation` with `lib/tools/SysMetrics.js` (Linux/macOS); `pm2 slist`/`getSystemData` and the Docker metrics path now read this collector. Covered by `test/programmatic/sysmetrics.mocha.js`
 
 ## 7.0.1
 

lib/API.js

@@ -180,7 +180,6 @@ class API {
       if (meta.new_pm2_instance == false && that.daemon_mode === true)
         return cb(err, meta);
 
-      that.launchSysMonitoring(() => {})
       // If new pm2 instance has been popped
       // Launch all modules
       that.launchAll(that, function(err_mod) {
@@ -410,7 +409,6 @@ class API {
             that.Client.launchRPC(function() {
               that.resurrect(function() {
                 Common.printOut(chalk.blue.bold('>>>>>>>>>> PM2 updated'));
-                that.launchSysMonitoring(() => {})
                 that.launchAll(that, function() {
                   KMDaemon.launchAndInteract(that._conf, {
                     pm2_version: pkg.version
@@ -1725,8 +1723,13 @@ class API {
     if ((conf.PM2_PROGRAMMATIC && process.env.PM2_USAGE != 'CLI'))
       return false;
 
-    return that.Client.executeRemote('getMonitorData', {}, (err, proc_list) => {
-      doList(err, proc_list)
+    // Best-effort host metrics snapshot (daemon-side SysMetrics collector);
+    // absence just means the `host metrics` line is skipped.
+    return that.Client.executeRemote('getSystemData', {}, (serrr, sdata) => {
+      systemdata = sdata || null
+      that.Client.executeRemote('getMonitorData', {}, (err, proc_list) => {
+        doList(err, proc_list)
+      })
     })
 
     function doList(err, list) {
@@ -1756,7 +1759,7 @@ class API {
                           chalk.bold(that.gl_interact_infos.machine_name),
                           chalk.bold(dashboard_url))
         }
-        UX.list(list, commander);
+        UX.list(list, commander, systemdata);
         //Common.printOut(chalk.white.italic(' Use `pm2 show <id|name>` to get more details about an app'));
       }
 

lib/API/Extra.js

@@ -30,35 +30,6 @@ module.exports = function(CLI) {
     });
   };
 
-  /**
-   * Launch the bundled pm2-sysmonit module (modules/pm2-sysmonit)
-   */
-  CLI.prototype.launchSysMonitoring = function(cb) {
-    if ((this.pm2_configuration && this.pm2_configuration.sysmonit != 'true') ||
-        process.env.TRAVIS ||
-        global.it === 'function' ||
-        cst.IS_WINDOWS === true)
-      return cb ? cb(null) : null
-
-    // Pointing at the directory keeps the process name (basename) as `pm2-sysmonit`
-    var filepath = path.resolve(__dirname, '../../modules/pm2-sysmonit')
-
-    if (!fs.existsSync(filepath))
-      return cb ? cb(null) : null
-
-    this.start({
-      script: filepath
-    }, {
-      started_as_module : true
-    }, (err, res) => {
-      if (err) {
-        Common.printError(cst.PREFIX_MSG_ERR + 'Error while trying to serve : ' + err.message || err);
-        return cb ? cb(err) : this.speedList(cst.ERROR_EXIT);
-      }
-      return cb ? cb(null) : this.speedList();
-    });
-  };
-
   /**
    * Show application environment
    * @method env

lib/API/UX/pm2-ls.js

@@ -93,32 +93,60 @@ function listModulesAndAppsManaged(list, commander) {
   }
 
   // cli-tableau renders at fixed widths and never shrinks to fit the
-  // terminal; switch to the condensed layout when the full table (incl.
-  // the dynamic name column) would overflow, rather than a fixed column
-  // count threshold. process.stdout.columns is undefined when piped, so
-  // the 300 fallback keeps the full table for non-TTY output.
-  var full_keys = Object.keys(app_head)
-  var full_width = full_keys.reduce((s, k) => s + app_head[k], 0) + full_keys.length + 1
-  CONDENSED_MODE = (process.stdout.columns || 300) < full_width
-
-  if (CONDENSED_MODE) {
-    app_head = {
-      id: id_width,
-      name: 20,
-      mode: 10,
-      '↺': 6,
-      status: 11,
-      cpu: 10,
-      memory: 10
-    }
+  // terminal. Pick the widest layout that fits: full -> condensed -> mini.
+  // process.stdout.columns is undefined when piped, so the 300 fallback
+  // keeps the full table for non-TTY output.
+  var term_cols = process.stdout.columns || 300
+  var tableWidth = function (head) {
+    var keys = Object.keys(head)
+    return keys.reduce((s, k) => s + head[k], 0) + keys.length + 1
+  }
 
-    mod_head = {
-      id: id_width,
-      name: 20,
-      status: 10,
-      cpu: 10,
-      mem: 10
-    }
+  var condensed_app = {
+    id: id_width,
+    name: Math.min(name_col_size, 20),
+    mode: 10,
+    '↺': 6,
+    status: 11,
+    cpu: 10,
+    memory: 10
+  }
+  var condensed_mod = {
+    id: id_width,
+    name: Math.min(name_col_size, 20),
+    status: 10,
+    cpu: 10,
+    mem: 10
+  }
+
+  var mini_app = {
+    id: id_width,
+    name: Math.min(name_col_size, 16),
+    status: 11,
+    cpu: 8,
+    mem: 10
+  }
+  var mini_mod = {
+    id: id_width,
+    name: Math.min(name_col_size, 16),
+    status: 11,
+    cpu: 8,
+    mem: 10
+  }
+
+  var MINI_MODE = false
+
+  if (term_cols >= tableWidth(app_head)) {
+    CONDENSED_MODE = false
+  } else if (term_cols >= tableWidth(condensed_app)) {
+    CONDENSED_MODE = true
+    app_head = condensed_app
+    mod_head = condensed_mod
+  } else {
+    CONDENSED_MODE = true
+    MINI_MODE = true
+    app_head = mini_app
+    mod_head = mini_mod
   }
 
   var app_table = new Table({
@@ -264,7 +292,8 @@ function listModulesAndAppsManaged(list, commander) {
         obj[key].push(l.pm2_env.version)
 
       // Exec mode
-      obj[key].push(mode == 'fork_mode' ? chalk.inverse.bold('fork') : chalk.blue.bold('cluster'))
+      if (!MINI_MODE)
+        obj[key].push(mode == 'fork_mode' ? chalk.inverse.bold('fork') : chalk.blue.bold('cluster'))
 
       // PID
       if (!CONDENSED_MODE)
@@ -275,7 +304,8 @@ function listModulesAndAppsManaged(list, commander) {
         obj[key].push((l.pm2_env.pm_uptime && status == 'online') ? UxHelpers.timeSince(l.pm2_env.pm_uptime) : 0)
 
       // Restart
-      obj[key].push(l.pm2_env.restart_time ? l.pm2_env.restart_time : 0)
+      if (!MINI_MODE)
+        obj[key].push(l.pm2_env.restart_time ? l.pm2_env.restart_time : 0)
 
       // Status
       obj[key].push(UxHelpers.colorStatus(status))
@@ -441,7 +471,7 @@ function miniMonitBar(sys_infos) {
   var sys_summary_line = `${chalk.bold.cyan('host metrics')} `
   sys_summary_line += `| ${chalk.bold('cpu')}: ${UxHelpers.colorizedMetric(cpu.value, 40, 70, '%')}`
 
-  let temp = sys_metrics['CPU Temperature'].value
+  let temp = sys_metrics['CPU Temperature'] ? sys_metrics['CPU Temperature'].value : null
   if (temp && temp != '-1') {
     sys_summary_line += ` ${UxHelpers.colorizedMetric(temp, 50, 70, 'º')}`
   }
@@ -491,9 +521,9 @@ function miniMonitBar(sys_infos) {
       sys_summary_line += `${chalk.bold('drop')} ${UxHelpers.colorizedMetric(rx_drop + tx_drop, 1, 10, '/min')} `
   })
 
-  if (CONDENSED_MODE == false) {
+  if (CONDENSED_MODE == false && sys_metrics['Disk Reads']) {
     let read = sys_metrics['Disk Reads'].value
-    let write = sys_metrics['Disk Writes'].value
+    let write = sys_metrics['Disk Writes'] ? sys_metrics['Disk Writes'].value : 0
 
     sys_summary_line += `| ${chalk.bold('disk')}: ⇓ ${UxHelpers.colorizedMetric(read, 10, 20, 'mb/s')}`
     sys_summary_line += ` ⇑ ${UxHelpers.colorizedMetric(write, 10, 20, 'mb/s')} `
@@ -502,6 +532,7 @@ function miniMonitBar(sys_infos) {
     var disk_nb = 0
 
     disks.forEach(fs => {
+      if (!sys_metrics[`fs:use:${fs}`]) return
       let use = sys_metrics[`fs:use:${fs}`].value
       if (use > 60)
         sys_summary_line += `${chalk.gray(fs)} ${UxHelpers.colorizedMetric(use, 80, 90, '%')} `
@@ -516,19 +547,19 @@ function miniMonitBar(sys_infos) {
  * pm2 ls
  * @method dispAsTable
  * @param {Object} list
- * @param {Object} system informations (via pm2 sysmonit/pm2 sysinfos)
+ * @param {Object} commander
+ * @param {Object} systemdata host metrics snapshot (daemon SysMetrics, axm_monitor-shaped)
  */
-module.exports = function(list, commander) {
+module.exports = function(list, commander, systemdata) {
   var pm2_conf = Configuration.getSync('pm2')
 
   if (!list)
     return console.log('list empty')
 
   listModulesAndAppsManaged(list, commander)
 
-  let sysmonit = list.filter(proc => proc.name == 'pm2-sysmonit')
-  if (sysmonit && sysmonit[0])
-    miniMonitBar(sysmonit[0])
+  if (systemdata && Object.keys(systemdata).length > 0)
+    miniMonitBar({ pm2_env: { axm_monitor: systemdata } })
 
   // Disable warning message of process list not saved
   //checkIfProcessAreDumped(list)

lib/Common.js

@@ -513,9 +513,35 @@ Common.logMod = function(msg) {
   return console.log(`${cst.PREFIX_MSG_MOD}${msg}`);
 }
 
+var ANSI_RE = /\x1b\[[0-9;]*m/g;
+
+/**
+ * Crop a (possibly ANSI-colored) single line to `width` visible columns so
+ * it does not wrap on narrow terminals. ANSI escapes are copied through
+ * without counting toward the width, and a reset is appended after the
+ * ellipsis so the truncation cannot leak color into following output.
+ */
+function cropToWidth(str, width) {
+  var out = '', visible = 0, i = 0;
+  while (i < str.length) {
+    if (str[i] === '\x1b') {
+      var m = str.slice(i).match(/^\x1b\[[0-9;]*m/);
+      if (m) { out += m[0]; i += m[0].length; continue; }
+    }
+    if (visible >= width - 1)
+      return out + '\u2026\x1b[0m';
+    out += str[i]; visible++; i++;
+  }
+  return out;
+}
+
 Common.printOut = function() {
   if (process.env.PM2_SILENT === 'true' || process.env.PM2_PROGRAMMATIC === 'true') return false;
-  return console.log.apply(console, arguments);
+  var msg = util.format.apply(util, arguments);
+  var cols = process.stdout.columns;
+  if (cols && msg.indexOf('\n') === -1 && msg.replace(ANSI_RE, '').length > cols)
+    msg = cropToWidth(msg, cols);
+  return console.log(msg);
 };
 
 

lib/Daemon.js

@@ -218,6 +218,7 @@ Daemon.prototype.innerStart = function(cb) {
     profileMEM              : profile.bind(this, 'mem'),
     prepare                 : God.prepare,
     getMonitorData          : God.getMonitorData,
+    getSystemData           : God.getSystemData,
 
     startProcessId          : God.startProcessId,
     stopProcessId           : God.stopProcessId,

lib/Worker.js

@@ -11,13 +11,24 @@ const pkg       = require('../package.json');
 
 var cst    = require('../constants.js');
 var vCheck = require('./VersionCheck.js')
+var Configuration = require('./Configuration.js');
+var SysMetrics = require('./tools/SysMetrics.js');
 
 module.exports = function(God) {
   var timer = null;
+  var sysMetricsTimer = null;
 
   God.CronJobs = new Map();
   God.Worker = {};
   God.Worker.is_running = false;
+  God.system_infos = {};
+
+  /**
+   * RPC: expose the latest host metrics snapshot (see SysMetrics.js).
+   */
+  God.getSystemData = function(env, cb) {
+    return cb(null, God.system_infos || {});
+  };
 
   God.getCronID = function(pm_id) {
     return `cron-${pm_id}`
@@ -149,9 +160,27 @@ module.exports = function(God) {
   };
 
 
+  // Host metrics collection (replaces the external pm2-sysmonit process).
+  // Enabled by default; disable with `pm2 set pm2:sysmonit false` + `pm2 update`.
+  var sysMetricsTask = function() {
+    try {
+      SysMetrics.collect(function(data) {
+        God.system_infos = data || {};
+      });
+    } catch (e) {
+      debug('[PM2][WORKER] SysMetrics collection failed: %s', e && e.message);
+    }
+  };
+
   God.Worker.start = function() {
     timer = setInterval(wrappedTasks, cst.WORKER_INTERVAL);
 
+    var pm2_conf = Configuration.getSync('pm2');
+    if (!pm2_conf || pm2_conf.sysmonit != 'false') {
+      sysMetricsTask();
+      sysMetricsTimer = setInterval(sysMetricsTask, cst.WORKER_INTERVAL);
+    }
+
     if (!process.env.PM2_DISABLE_VERSION_CHECK) {
       setInterval(() => {
         vCheck({
@@ -165,5 +194,7 @@ module.exports = function(God) {
   God.Worker.stop = function() {
     if (timer !== null)
       clearInterval(timer);
+    if (sysMetricsTimer !== null)
+      clearInterval(sysMetricsTimer);
   };
 };

lib/binaries/CLI.js

@@ -809,12 +809,6 @@ commander.command('jlist')
     pm2.jlist()
   });
 
-commander.command('sysmonit')
-  .description('start system monitoring daemon')
-  .action(function() {
-    pm2.launchSysMonitoring()
-  })
-
 commander.command('slist')
   .alias('sysinfos')
   .option('-t --tree', 'show as tree')