pm2-perfmonitor 1.1.2 → 1.2.3

package/README.md

@@ -17,15 +17,16 @@ $ pm2 install pm2-perfmonitor
 
 # Configure
 
-|            Property             | Default Value |                               Description                                |
-| :-----------------------------: | :-----------: | :----------------------------------------------------------------------: |
-|            `enabled`            |    `true`     |                  Specify whether to enable this module                   |
-|          `excludeApps`          |       -       | Specify the application name that needs to be excluded from guardianship |
-|          `includeApps`          |       -       |          Specify the application name that needs to be guarded           |
-|        `workerInterval`         |    `60000`    |                    Timed task execution interval (ms)                    |
-|        `zombieDetection`        |    `true`     |           Specify whether to enable zombie process protection            |
-|         `zombieMaxHits`         |     `10`      |        Specify the maximum occurrence frequency of zombie status         |
-| `autoRestartWhenZombieDetected` |    `true`     |        Specify whether to automatically restart zombie processes         |
+|            Property             | Default Value |                                     Description                                      |
+| :-----------------------------: | :-----------: | :----------------------------------------------------------------------------------: |
+|            `enabled`            |    `true`     |                        Specify whether to enable this module                         |
+|          `excludeApps`          |       -       |       Specify the application name that needs to be excluded from guardianship       |
+|          `includeApps`          |       -       |                Specify the application name that needs to be guarded                 |
+|        `workerInterval`         |    `60000`    |                          Timed task execution interval (ms)                          |
+|        `zombieDetection`        |    `true`     |                 Specify whether to enable zombie process protection                  |
+|         `zombieMaxHits`         |     `10`      |              Specify the maximum occurrence frequency of zombie status               |
+| `autoRestartWhenZombieDetected` |    `true`     |              Specify whether to automatically restart zombie processes               |
+|       `zombieMaxRestarts`       |      `0`      | The maximum number of zombie process restarts can be set to `0` to indicate no limit |
 
 # How to set these values ?
 

package/lib/app.js

@@ -1,34 +1,9 @@
 const pmx = require('pmx')
 const pm2 = require('pm2')
+const { listAppsAsync } = require('./pm2-extra')
 const { parseParamToArray, parseParamToNumber, parseBool } = require('./utils')
-
-const defaultOptions = {
-  enabled: true,
-  /**
-   * 排除的 app 名
-   */
-  excludeApps: [],
-  /**
-   * 包含的 app 名
-   */
-  includeApps: [],
-  /**
-   * 定时检测间隔（ms）
-   */
-  workerInterval: 60000,
-  /**
-   * 是否开启僵尸进程守护
-   */
-  zombieDetection: true,
-  /**
-   * 僵尸状态最大出现次数
-   */
-  zombieMaxHits: 10,
-  /**
-   * 僵尸状态达到最大容忍度时，是否自动重启僵尸进程
-   */
-  autoRestartWhenZombieDetected: true,
-}
+const { defaultOptions } = require('./defaults')
+// const { sendMessage } = require('./message')
 
 const conf = pmx.initModule({}, (err, incomingConf) => {
   if (err) {
@@ -53,6 +28,7 @@ const AUTO_RESTART_WHEN_ZOMBIE_DETECTED = parseBool(
   conf.autoRestartWhenZombieDetected,
 )
 const ZOMBIE_MAX_HITS = parseParamToNumber(conf.zombieMaxHits)
+const ZOMBIE_MAX_RESTARTS = parseParamToNumber(conf.zombieMaxRestarts)
 
 // 存储每个进程的 CPU 采样历史（pm_id -> [cpu1, cpu2, ...]）
 const cpuHistory = new Map()
@@ -69,6 +45,7 @@ const logger = (type, ...args) => {
 
 /**
  * 判断是否为僵尸进程：最近 ZOMBIE_MAX_HITS 次全是 0%
+ * @param { number[] } history
  */
 const isZombie = (history) => {
   return history.length >= ZOMBIE_MAX_HITS && history.every((v) => v === 0)
@@ -77,16 +54,19 @@ const isZombie = (history) => {
 /**
  * check zombie process
  */
-const zombieProcessChecker = () => {
+const zombieProcessChecker = async () => {
   if (!ZOMBIE_DETECTION) return
 
-  pm2.list((err, apps) => {
+  try {
+    const apps = await listAppsAsync()
+
     apps.forEach((app) => {
       const { name, pm_id, monit, pm2_env } = app
 
       const appStatus = pm2_env?.status
       const appCpuUsage = monit?.cpu || 0
 
+      // 非目标应用，跳过
       if (
         MODULE_NAME === name ||
         (INCLUDE_APPS.length > 0 && !INCLUDE_APPS.includes(name)) ||
@@ -95,7 +75,7 @@ const zombieProcessChecker = () => {
         return
       }
 
-      // 2. 只处理 online 状态的进程
+      // 只处理 online 状态的进程
       if (appStatus !== 'online') {
         // 进程不在 online 状态时，清空其历史记录，避免干扰
         cpuHistory.delete(pm_id)
@@ -115,12 +95,21 @@ const zombieProcessChecker = () => {
         history.shift()
       }
 
-      // 4. 判断是否为僵尸：最近 ZOMBIE_MAX_HITS 次全是 0%
-
+      // 判断是否为僵尸：最近 ZOMBIE_MAX_HITS 次全是 0%
       if (isZombie(history)) {
-        logger('info', `Zombie detected: ${name} (pm_id: ${pm_id})`)
+        logger(
+          'info',
+          `Zombie detected: ${name} (pm_id: ${pm_id}, pid: ${app.pid})`,
+        )
 
         if (AUTO_RESTART_WHEN_ZOMBIE_DETECTED) {
+          if (
+            ZOMBIE_MAX_RESTARTS > 0 &&
+            zombieRestartHistory.get(pm_id) >= ZOMBIE_MAX_RESTARTS
+          ) {
+            return
+          }
+
           logger('info', 'restarting...')
 
           pm2.restart(pm_id, (restartErr) => {
@@ -162,7 +151,9 @@ const zombieProcessChecker = () => {
         }
       }
     })
-  })
+  } catch (err) {
+    logger('error', err)
+  }
 }
 
 const runModule = () => {

package/lib/defaults.js

@@ -0,0 +1,35 @@
+const defaultOptions = {
+  enabled: true,
+  /**
+   * 排除的 app 名
+   */
+  excludeApps: [],
+  /**
+   * 包含的 app 名
+   */
+  includeApps: [],
+  /**
+   * 定时检测间隔（ms）
+   */
+  workerInterval: 60000,
+  /**
+   * 是否开启僵尸进程守护
+   */
+  zombieDetection: true,
+  /**
+   * 僵尸状态最大出现次数
+   */
+  zombieMaxHits: 10,
+  /**
+   * 僵尸状态达到最大容忍度时，是否自动重启僵尸进程
+   */
+  autoRestartWhenZombieDetected: true,
+  /**
+   * 僵尸进程最大重启次数，设置为0表示不限制
+   */
+  zombieMaxRestarts: 0,
+}
+
+module.exports = {
+  defaultOptions,
+}

package/lib/message.js

@@ -0,0 +1,22 @@
+const pm2 = require('pm2')
+
+/**
+ * @param { number } pid 进程id
+ * @param { string } eventName 事件名
+ * @param { Object } data
+ */
+const sendMessage = (pid, eventName, data) => {
+  pm2.sendDataToProcessId(pid, {
+    id: pid,
+    type: 'process:msg',
+    topic: true,
+    data: {
+      event: `pm2-perfmonitor:${eventName}`,
+      data,
+    },
+  })
+}
+
+module.exports = {
+  sendMessage,
+}

package/lib/pm2-extra.js

@@ -0,0 +1,37 @@
+const pm2 = require('pm2')
+
+/**
+ * @returns { Promise<pm2.ProcessDescription[]> }
+ */
+const listAppsAsync = () => {
+  return new Promise((resolve, reject) => {
+    pm2.list((err, apps) => {
+      if (err) {
+        return reject(err)
+      }
+
+      resolve(apps)
+    })
+  })
+}
+
+/**
+ * @param { string | number} pm_id
+ * @returns { Promise<void> }
+ */
+const stopAppAsync = (pm_id) => {
+  return new Promise((resolve, reject) => {
+    pm2.stop(pm_id, (err) => {
+      if (err) {
+        return reject(err)
+      }
+
+      resolve()
+    })
+  })
+}
+
+module.exports = {
+  listAppsAsync,
+  stopAppAsync,
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pm2-perfmonitor",
-  "version": "1.1.2",
+  "version": "1.2.3",
   "description": "A pm2 module for performance monitoring. Automatically detect zombie processes and restart it",
   "author": {
     "name": "elenh",
@@ -20,8 +20,12 @@
   },
   "homepage": "https://github.com/yisibell/pm2-perfmonitor",
   "scripts": {
-    "start": "pm2 delete app1 || true && pm2 start ecosystem.app.config.cjs",
-    "dev": "pm2 start ecosystem.dev.config.cjs",
+    "start-or-restart:app": "pm2 startOrRestart ecosystem.app.config.cjs --update-env",
+    "start:app": "pm2 start ecosystem.app.config.cjs",
+    "restart:app": "pm2 restart ecosystem.app.config.cjs",
+    "delete-start:app": "pm2 delete app1 || true && pm2 start ecosystem.app.config.cjs",
+    "start": "node ./scripts/app.js --env=app",
+    "dev": "pm2 restart ecosystem.dev.config.cjs",
     "release": "changelogen --release && npm publish --access=public && git push --follow-tags"
   },
   "keywords": [
@@ -43,6 +47,7 @@
   },
   "devDependencies": {
     "changelogen": "^0.6.2",
-    "cz-conventional-changelog": "^3.3.0"
+    "cz-conventional-changelog": "^3.3.0",
+    "minimist": "^1.2.8"
   }
 }