@zappinginc/zm2 6.0.14 → 6.0.15

package/CLAUDE.md

@@ -1,8 +1,8 @@
-# CLAUDE.md - PM2 Project Guide
+# CLAUDE.md - ZM2 Project Guide
 
 ## Project Overview
 
-PM2 is a production process manager for Node.js/Bun applications with a built-in load balancer. Version 6.0.14, licensed under AGPL-3.0. Minimum Node.js version: 16.
+ZM2 is a production process manager for Node.js/Bun applications with a built-in load balancer. Forked from PM2 6.0.14, published as `@zappinginc/zm2`. Licensed under AGPL-3.0. Minimum Node.js version: 16.
 
 ## Quick Commands
 
@@ -10,12 +10,12 @@ PM2 is a production process manager for Node.js/Bun applications with a built-in
 npm test              # Run all tests (e2e + unit)
 npm run test:unit     # Unit tests only (bash test/unit.sh)
 npm run test:e2e      # E2E tests only (bash test/e2e.sh)
-pm2 update            # Restart daemon after modifying Daemon.js, God.js, God/*, Watcher.js
+zm2 update            # Restart daemon after modifying Daemon.js, God.js, God/*, Watcher.js
 ```
 
 ## Architecture
 
-- **Entry points**: `index.js` (programmatic API), `bin/pm2` (CLI)
+- **Entry points**: `index.js` (programmatic API), `bin/zm2` (CLI)
 - **API** (`lib/API.js`): Main programmatic interface, ~1900 lines
 - **Daemon** (`lib/Daemon.js`): Daemon lifecycle, uses pm2-axon for RPC/messaging
 - **God** (`lib/God.js` + `lib/God/`): Core process monitoring — ClusterMode, ForkMode, Reload, ActionMethods
@@ -28,7 +28,7 @@ pm2 update            # Restart daemon after modifying Daemon.js, God.js, God/*,
 ## Key Directories
 
 ```
-bin/          CLI entry points (pm2, pm2-dev, pm2-docker, pm2-runtime)
+bin/          CLI entry points (zm2, zm2-dev, zm2-docker, zm2-runtime)
 lib/          Core source code
 lib/API/      Extended API modules (Deploy, Log, Startup, Modules, etc.)
 lib/God/      Process management submodules (ClusterMode, ForkMode, Reload)
@@ -43,14 +43,28 @@ types/        TypeScript definitions
 examples/     Example applications
 ```
 
-## PM2 Runtime Files
+## ZM2 Runtime Files
 
-Located at `$HOME/.pm2/`:
-- `pm2.log`, `pm2.pid` — daemon log and PID
+Located at `$HOME/.zm2/`:
+- `zm2.log`, `zm2.pid` — daemon log and PID
 - `rpc.sock`, `pub.sock` — IPC sockets
-- `dump.pm2` — process list dump for resurrection
+- `dump.zm2` — process list dump for resurrection
 - `logs/`, `pids/` — app logs and PIDs
-- `modules/` — installed PM2 modules
+- `modules/` — installed ZM2 modules
+
+## Naming Convention (Fork from PM2)
+
+- **User-facing**: All CLI commands, console messages, env vars, and paths use `zm2`/`ZM2`
+- **Internal**: Variable names (`pm2_env`, `pm2_home`) and object property keys (`PM2_ROOT_PATH`) remain as `pm2` for compatibility with upstream dependencies (`@pm2/io`, `pm2-axon`, etc.)
+- **Env vars**: `ZM2_HOME`, `ZM2_DEBUG`, etc. are preferred, with fallback to `PM2_*` equivalents
+
+## Syslog Support
+
+ZM2 adds syslog as a log transport option (not in upstream PM2):
+- `--log-transport file` (default) — write to `~/.zm2/logs/`
+- `--log-transport syslog` — send to syslog via unix socket
+- `--log-transport both` — write to files AND syslog
+- Implementation in `lib/Utility.js` (SyslogStream, DualStream classes)
 
 ## Code Style
 

package/README.md

@@ -1,58 +1,43 @@
 <div align="center">
  <br/>
 
-![https://raw.githubusercontent.com/Unitech/pm2/master/pres/pm2-logo-2.png](https://raw.githubusercontent.com/Unitech/pm2/master/pres/pm2-logo-2.png)
+<h1>ZM2</h1>
 
-<b>P</b>(rocess) <b>M</b>(anager) <b>2</b><br/>
+<b>Z</b>(apping) <b>M</b>(anager) <b>2</b><br/>
   <i>Runtime Edition</i>
 <br/><br/>
 
-
-<a title="PM2 Downloads" href="https://npm-stat.com/charts.html?package=pm2&from=2018-01-01&to=2023-08-01">
-  <img src="https://img.shields.io/npm/dm/pm2" alt="Downloads per Month"/>
-</a>
-
-<a title="PM2 Downloads" href="https://npm-stat.com/charts.html?package=pm2&from=2018-01-01&to=2023-08-01">
-  <img src="https://img.shields.io/npm/dy/pm2" alt="Downloads per Year"/>
-</a>
-
-<a href="https://badge.fury.io/js/pm2" title="NPM Version Badge">
-   <img src="https://badge.fury.io/js/pm2.svg" alt="npm version">
-</a>
+A production process manager for Node.js/Bun applications with a built-in load balancer.<br/>
+Forked from <a href="https://github.com/Unitech/pm2">PM2</a>.
 
-<br/>
 <br/>
 <br/>
 </div>
 
 
-PM2 is a production process manager for Node.js/Bun applications with a built-in load balancer. It allows you to keep applications alive forever, to reload them without downtime and to facilitate common system admin tasks.
+ZM2 is a production process manager for Node.js/Bun applications with a built-in load balancer. It allows you to keep applications alive forever, to reload them without downtime and to facilitate common system admin tasks.
 
 Starting an application in production mode is as easy as:
 
 ```bash
-$ pm2 start app.js
+$ zm2 start app.js
 ```
 
-PM2 is constantly assailed by [more than 1800 tests](https://github.com/Unitech/pm2/actions/workflows/node.js.yml).
-
-Official website: [https://pm2.keymetrics.io/](https://pm2.keymetrics.io/)
+Works on Linux (stable) & macOS (stable) & Windows (stable). All Node.js versions are supported starting Node.js 16.X and Bun since v1.
 
-Works on Linux (stable) & macOS (stable) & Windows (stable). All Node.js versions are supported starting Node.js 12.X and Bun since v1
 
-
-## Installing PM2
+## Installing ZM2
 
 ### With NPM
 
 ```bash
-$ npm install pm2 -g
+$ npm install @zappinginc/zm2 -g
 ```
 
 ### With Bun
 
 ```bash
-$ bun install pm2 -g
+$ bun install @zappinginc/zm2 -g
 ```
 **Please note that you might need to symlink node to bun if you only want to use bun via `sudo ln -s /home/$USER/.bun/bin/bun /usr/bin/node`**
 
@@ -65,7 +50,7 @@ You can install Node.js easily with [NVM](https://github.com/nvm-sh/nvm#installi
 You can start any application (Node.js, Bun, and also Python, Ruby, binaries in $PATH...) like that:
 
 ```bash
-$ pm2 start app.js
+$ zm2 start app.js
 ```
 
 Your app is now daemonized, monitored and kept alive forever.
@@ -74,46 +59,40 @@ Your app is now daemonized, monitored and kept alive forever.
 
 Once applications are started you can manage them easily:
 
-![Process listing](https://github.com/Unitech/pm2/raw/master/pres/pm2-ls-v2.png)
-
 To list all running applications:
 
 ```bash
-$ pm2 list
+$ zm2 list
 ```
 
 Managing apps is straightforward:
 
 ```bash
-$ pm2 stop     <app_name|namespace|id|'all'|json_conf>
-$ pm2 restart  <app_name|namespace|id|'all'|json_conf>
-$ pm2 delete   <app_name|namespace|id|'all'|json_conf>
+$ zm2 stop     <app_name|namespace|id|'all'|json_conf>
+$ zm2 restart  <app_name|namespace|id|'all'|json_conf>
+$ zm2 delete   <app_name|namespace|id|'all'|json_conf>
 ```
 
 To have more details on a specific application:
 
 ```bash
-$ pm2 describe <id|app_name>
+$ zm2 describe <id|app_name>
 ```
 
 To monitor logs, custom metrics, application information:
 
 ```bash
-$ pm2 monit
+$ zm2 monit
 ```
 
-[More about Process Management](https://pm2.keymetrics.io/docs/usage/process-management/)
-
 ### Cluster Mode: Node.js Load Balancing & Zero Downtime Reload
 
 The Cluster mode is a special mode when starting a Node.js application, it starts multiple processes and load-balance HTTP/TCP/UDP queries between them. This increase overall performance (by a factor of x10 on 16 cores machines) and reliability (faster socket re-balancing in case of unhandled errors).
 
-![Framework supported](https://raw.githubusercontent.com/Unitech/PM2/master/pres/cluster.png)
-
 Starting a Node.js application in cluster mode that will leverage all CPUs available:
 
 ```bash
-$ pm2 start api.js -i <processes>
+$ zm2 start api.js -i <processes>
 ```
 
 `<processes>` can be `'max'`, `-1` (all cpu minus 1) or a specified number of instances to start.
@@ -123,44 +102,63 @@ $ pm2 start api.js -i <processes>
 Hot Reload allows to update an application without any downtime:
 
 ```bash
-$ pm2 reload all
+$ zm2 reload all
 ```
 
-[More informations about how PM2 make clustering easy](https://pm2.keymetrics.io/docs/usage/cluster-mode/)
-
 ### Container Support
 
-With the drop-in replacement command for `node`, called `pm2-runtime`, run your Node.js application in a hardened production environment.
+With the drop-in replacement command for `node`, called `zm2-runtime`, run your Node.js application in a hardened production environment.
 Using it is seamless:
 
 ```
-RUN npm install pm2 -g
-CMD [ "pm2-runtime", "npm", "--", "start" ]
+RUN npm install @zappinginc/zm2 -g
+CMD [ "zm2-runtime", "npm", "--", "start" ]
 ```
 
-[Read More about the dedicated integration](https://pm2.keymetrics.io/docs/usage/docker-pm2-nodejs/)
+### Syslog Support
+
+ZM2 adds syslog as a log transport (in addition to standard file logging):
+
+```bash
+# Send logs to syslog only
+$ zm2 start app.js --log-transport syslog
+
+# Send logs to both files and syslog
+$ zm2 start app.js --log-transport both
+
+# Default: file only (standard behavior)
+$ zm2 start app.js
+```
+
+Or in ecosystem config:
+
+```javascript
+module.exports = {
+  apps: [{
+    name: 'api',
+    script: 'app.js',
+    log_transport: 'syslog'  // 'file', 'syslog', or 'both'
+  }]
+}
+```
 
 ### Host monitoring speedbar
 
-PM2 allows to monitor your host/server vitals with a monitoring speedbar.
+ZM2 allows to monitor your host/server vitals with a monitoring speedbar.
 
 To enable host monitoring:
 
 ```bash
-$ pm2 set pm2:sysmonit true
-$ pm2 update
+$ zm2 set zm2:sysmonit true
+$ zm2 update
 ```
 
-![Framework supported](https://raw.githubusercontent.com/Unitech/PM2/master/pres/vitals.png)
-
 ### Terminal Based Monitoring
 
-![Monit](https://github.com/Unitech/pm2/raw/master/pres/pm2-monit.png)
-
 Monitor all processes launched straight from the command line:
 
 ```bash
-$ pm2 monit
+$ zm2 monit
 ```
 
 ### Log Management
@@ -168,7 +166,7 @@ $ pm2 monit
 To consult logs just type the command:
 
 ```bash
-$ pm2 logs
+$ zm2 logs
 ```
 
 Standard, Raw, JSON and formated output are available.
@@ -176,73 +174,57 @@ Standard, Raw, JSON and formated output are available.
 Examples:
 
 ```bash
-$ pm2 logs APP-NAME       # Display APP-NAME logs
-$ pm2 logs --json         # JSON output
-$ pm2 logs --format       # Formated output
+$ zm2 logs APP-NAME       # Display APP-NAME logs
+$ zm2 logs --json         # JSON output
+$ zm2 logs --format       # Formated output
 
-$ pm2 flush               # Flush all logs
-$ pm2 reloadLogs          # Reload all logs
+$ zm2 flush               # Flush all logs
+$ zm2 reloadLogs          # Reload all logs
 ```
 
-To enable log rotation install the following module
-
-```bash
-$ pm2 install pm2-logrotate
-```
-
-[More about log management](https://pm2.keymetrics.io/docs/usage/log-management/)
-
 ### Startup Scripts Generation
 
-PM2 can generate and configure a Startup Script to keep PM2 and your processes alive at every server restart.
+ZM2 can generate and configure a Startup Script to keep ZM2 and your processes alive at every server restart.
 
 Init Systems Supported: **systemd**, **upstart**, **launchd**, **rc.d**
 
 ```bash
 # Generate Startup Script
-$ pm2 startup
+$ zm2 startup
 
 # Freeze your process list across server restart
-$ pm2 save
+$ zm2 save
 
 # Remove Startup Script
-$ pm2 unstartup
+$ zm2 unstartup
 ```
 
-[More about Startup Scripts Generation](https://pm2.keymetrics.io/docs/usage/startup/)
-
-### Updating PM2
+### Updating ZM2
 
 ```bash
-# Install latest PM2 version
-$ npm install pm2@latest -g
-# Save process list, exit old PM2 & restore all processes
-$ pm2 update
+# Install latest ZM2 version
+$ npm install @zappinginc/zm2@latest -g
+# Save process list, exit old ZM2 & restore all processes
+$ zm2 update
 ```
 
-*PM2 updates are seamless*
+*ZM2 updates are seamless*
 
-## PM2+ Monitoring
+## Environment Variables
 
-If you manage your apps with PM2, PM2+ makes it easy to monitor and manage apps across servers.
+ZM2 uses `ZM2_*` environment variables with fallback to `PM2_*` for compatibility:
 
-![https://app.pm2.io/](https://pm2.io/img/app-overview.png)
-
-Feel free to try it:
-
-[Discover the monitoring dashboard for PM2](https://app.pm2.io/)
-
-Thanks in advance and we hope that you like PM2!
-
-## CHANGELOG
-
-[CHANGELOG](https://github.com/Unitech/PM2/blob/master/CHANGELOG.md)
-
-## Contributors
-
-[Contributors](http://pm2.keymetrics.io/hall-of-fame/)
+| Variable | Description |
+|----------|-------------|
+| `ZM2_HOME` | Custom home directory (default: `~/.zm2`) |
+| `ZM2_DEBUG` | Enable debug mode |
+| `ZM2_KILL_TIMEOUT` | Process kill timeout (default: 1600ms) |
+| `ZM2_KILL_SIGNAL` | Kill signal (default: SIGINT) |
+| `ZM2_LOG_DATE_FORMAT` | Log date format |
+| `ZM2_GRACEFUL_TIMEOUT` | Graceful shutdown timeout |
 
 ## License
 
-PM2 is made available under the terms of the GNU Affero General Public License 3.0 (AGPL 3.0).
-For other licenses [contact us](mailto:contact@keymetrics.io).
+ZM2 is made available under the terms of the GNU Affero General Public License 3.0 (AGPL 3.0).
+
+Based on [PM2](https://github.com/Unitech/pm2) by Alexandre Strzelewicz and contributors.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@zappinginc/zm2",
   "preferGlobal": true,
-  "version": "6.0.14",
+  "version": "6.0.15",
   "engines": {
     "node": ">=16.0.0"
   },
@@ -94,7 +94,7 @@
       "email": "chris@chriswiggins.co.nz"
     }
   ],
-  "homepage": "https://github.com/chernandez/zm2",
+  "homepage": "https://github.com/eltelon/pm2",
   "description": "ZM2 - Production process manager for Node.JS applications with a built-in load balancer.",
   "main": "index.js",
   "types": "types/index.d.ts",
@@ -209,11 +209,11 @@
     "should": "^13.2.3"
   },
   "bugs": {
-    "url": "https://github.com/chernandez/zm2/issues"
+    "url": "https://github.com/eltelon/pm2/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git://github.com/chernandez/zm2.git"
+    "url": "git://github.com/eltelon/pm2.git"
   },
   "license": "AGPL-3.0"
 }