PM2 is a production process manager for Node.js 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:
$ pm2 start app.js
PM2 is constantly assailed by more than 1000 tests.
Official website: http://pm2.keymetrics.io/
Works on Linux (stable) & MacOSx (stable) & Windows (stable).
Install PM2
$ npm install pm2 -g
npm is a builtin CLI when you install Node.js - Installing Node.js with NVM
Start an application
$ pm2 start app.js
Your app is now put in background, monitored and kept alive forever.
More about Process Management
Update PM2
$ npm install pm2 -g
$ pm2 update
PM2 updates are seamless
Main features
Commands overview
$ npm install pm2 -g
$ pm2 start app.js
$ pm2 start app.js -i 4
$ pm2 start app.js --name="api"
$ pm2 start app.js --watch
$ pm2 start script.sh
$ pm2 start npm -- start
$ pm2 list
$ pm2 monit
$ pm2 show [app-name]
$ pm2 logs
$ pm2 logs [app-name]
$ pm2 flush
$ pm2 stop all
$ pm2 stop 0
$ pm2 restart all
$ pm2 reload all
$ pm2 gracefulReload all
$ pm2 delete all
$ pm2 delete 0
$ pm2 scale api 10
$ pm2 reset [app-name]
$ pm2 startup
$ pm2 save
$ pm2 resurrect
$ pm2 update
$ pm2 generate
$ pm2 deploy app.json prod setup
$ pm2 deploy app.json prod
$ pm2 deploy app.json prod revert 2
$ pm2 module:generate [name]
$ pm2 install pm2-logrotate
$ pm2 uninstall pm2-logrotate
$ pm2 publish
Different ways of starting processes
$ pm2 start app.js --watch
$ pm2 start script.sh
$ pm2 start app.js -- -a 34
$ pm2 start app.json
$ pm2 start my-python-script.py --interpreter python
Process management
Once apps are started you can list and manage them easily:
Listing all running processes:
$ pm2 list
Managing your processes is straightforward:
$ pm2 stop <app_name|id|'all'|json_conf>
$ pm2 restart <app_name|id|'all'|json_conf>
$ pm2 delete <app_name|id|'all'|json_conf>
To have more details on a specific process:
$ pm2 describe <id|app_name>
More about Process Management
Load balancing / 0s reload downtime
When an app is started with the -i option, the cluster mode is enabled.
Supported by all major Node.js frameworks and any Node.js applications
Warning: If you want to use the embedded load balancer (cluster mode), we recommend the use of node#0.12.0+
or node#0.11.16+
. We do not support node#0.10.*
's cluster module anymore.
With the cluster mode, PM2 enables load balancing between multiple application to use all CPUs available in a server.
Each HTTP/TCP/UDP request will be forwarded to one specific process at a time.
$ pm2 start app.js -i 0
$ pm2 reload all
$ pm2 scale <app_name> <instance_number>
More informations about how PM2 make clustering easy
CPU / Memory Monitoring
Monitoring all processes launched:
$ pm2 monit
Log facilities
Displaying logs of a specified process or all processes, in real time:
pm2 logs ['all'|'PM2'|app_name|app_id] [--err|--out] [--lines <n>] [--raw] [--timestamp [format]]
Examples:
$ pm2 logs
$ pm2 logs WEB-API --err
$ pm2 logs all --raw
$ pm2 logs --lines 5
$ pm2 logs --timestamp "HH:mm:ss"
$ pm2 logs WEB-API --lines 0 --timestamp "HH:mm" --out
$ pm2 logs PM2 --timestamp
$ pm2 flush
More about log management
Startup script generation
PM2 can generate and configure a startup script to keep PM2 and your processes alive at every server restart. Execute the startup command only as the user to be running the PM2 daemon.
$ pm2 startup
$ pm2 startup [platform]
To save a process list just do:
$ pm2 save
More about startup scripts
Module system
PM2 embeds a simple and powerful module system. Installing a module is straightforward:
$ pm2 install <module_name>
Here are some PM2 compatible modules (standalone Node.js applications managed by PM2):
pm2-logrotate auto rotate logs of PM2 and applications managed
pm2-webshell expose a fully capable terminal in browsers
pm2-auto-pull auto pull all applications managed by PM2
How to write a module
Keymetrics monitoring
If you manage your NodeJS app with PM2, Keymetrics makes it easy to monitor and manage apps across servers.
Feel free to try it:
Discover the monitoring dashboard for PM2
Thanks in advance and we hope that you like PM2!
More about PM2
CHANGELOG
CHANGELOG
Contributors
Contributors
License
PM2 is made available under the terms of the GNU Affero General Public License 3.0 (AGPL 3.0).
For other license contact us.