Node.js Production Process Manager with a built-in Load Balancer.
Clone or download
Latest commit 6d85f4c Sep 20, 2018
Permalink
Failed to load latest commit information.
.github fix: remove trailing spaces Jul 2, 2018
bin feature: switch to websocket by default when running pm2 link/plus Sep 19, 2018
examples refactor: only import the necessary methods from async. Jul 19, 2018
lib Merge branch 'development' Sep 19, 2018
packager fix: retab shell script to use space for indent consistency Jul 4, 2018
pres chore: btn Jul 4, 2018
test increase timeout graceful Sep 19, 2018
types fix: #3883 fix typings for max_memory_restart and add wait_ready Aug 29, 2018
.bithoundrc .bithoundrc Jan 25, 2018
.changelogrc chore: upgrade to 3.1.1 Sep 10, 2018
.drone.yml fix: remove trailing spaces Jul 2, 2018
.editorconfig chore: remove duplicate configs in .editorconfig Jul 2, 2018
.gitattributes Fix shell scripts EOL on Windows Jul 5, 2017
.gitignore fix: README update + downgrade promptly Jul 4, 2018
.npmignore fix: do not ignore child pres folder Jul 17, 2018
.travis.yml fix: that this - uncache node_modules May 17, 2018
ADVANCED_README.md change all ecosystem.json to ecosystem.config.js Mar 16, 2018
CHANGELOG.md pm2@3.1.3 Sep 20, 2018
CONTRIBUTING.md fix: remove trailing spaces Jul 2, 2018
GNU-AGPL-3.0.txt Update license year range to 2016 Jan 18, 2016
LICENSE README update - LICENSE Sep 4, 2014
Makefile (deploy) add deploy script Dec 9, 2016
README.md chore: README update Aug 22, 2018
changelogTemplate.md fix: remove trailing spaces Jul 2, 2018
constants.js fix: path Jul 13, 2018
index.js (startup refactor) Dec 4, 2016
package.json pm2@3.1.3 Sep 20, 2018
paths.js refactor: use @pm2/js-api for login/register on pm2.io via CLI May 30, 2018

README.md


pm2 logo

P(rocess) M(anager) 2
Runtime Edition

npm version npm version Build Status


PM2 is a Production Runtime and 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 facilitate common Devops tasks.

Starting an application in production mode is as easy as:

$ pm2 start app.js

PM2 is constantly assailed by more than 1800 tests.

Official website: https://pm2.io/doc/

Works on Linux (stable) & macOS (stable) & Windows (stable). All Node.js versions are supported starting Node.js 4.X.

NPM

Installing PM2

$ npm install pm2 -g

npm is a builtin CLI when you install Node.js - Installing Node.js with NVM

Start an application

You can start any application (Node.js, Python, Ruby, binaries in $PATH...) like that:

$ pm2 start app.js

Your app is now daemonized, monitored and kept alive forever.

More about Process Management

Container Support

With the drop-in replacement command for node, called pm2-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" ]

Read More about the dedicated integration

Managing Applications

Once applications are started you can manage them easily:

Process listing

To list all running applications:

$ pm2 list

Managing apps 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 application:

$ pm2 describe <id|app_name>

To monitor logs, custom metrics, application information:

$ pm2 monit

More about Application 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).

Starting a Node.js application in cluster mode that will leverage all CPUs available:

$ pm2 start api.js -i <processes>

<processes> can be 'max', -1 (all cpu minus 1) or a specified number of instances to start.

Zero Downtime Reload

Hot Reload allows to update an application without any downtime:

$ pm2 reload all

Seamlessly supported by all major Node.js frameworks and any Node.js applications without any code change:

Framework supported

More informations about how PM2 make clustering easy

Terminal Based Monitoring

Monit

Monitor all processes launched straight from the command line:

$ pm2 monit

Log Management

To consult logs just type the command:

$ pm2 logs

Standard, Raw, JSON and formated output are available.

Examples:

$ pm2 logs APP-NAME       # Display APP-NAME logs
$ pm2 logs --json         # JSON output
$ pm2 logs --format       # Formated output

$ pm2 flush               # Flush all logs
$ pm2 reloadLogs          # Reload all logs

More about log management

Startup Hooks Generation

PM2 can generates and configure a Startup Script to keep PM2 and your processes alive at every server restart.

Init Systems Supported: systemd, upstart, launchd, rc.d

# Generate Startup Script
$ pm2 startup

# Freeze your process list across server restart
$ pm2 save

# Remove Startup Script
$ pm2 unstartup

More about Startup Hooks

Updating PM2

# Install latest PM2 version
$ npm install pm2@latest -g
# Save process list, exit old PM2 & restore all processes
$ pm2 update

PM2 updates are seamless

Ready to Scale? Go further with PM2 Plus!



PM2 plus logo

PM2
Plus Edition

Once you scale you need to make sure that your application is running properly, without bugs, performance issues and without downtimes.

That's why we created PM2 Plus. It's a set of advanced features for both hardening the PM2 Runtime and monitoring applications in production.

With PM2 Plus you get:

  • A Real-time Monitoring Web Interface
  • Smart Exception Reporting
  • Production Profiling for Memory and CPU
  • PM2 Runtime High Availability Fallback

And much more like realtime logs, custom metrics, remote actions...

To start using PM2 Plus via CLI:

$ pm2 plus

Or go to the application and create an account:

To discover PM2 Plus Register Here

PM2 Plus Features

Visual Memory Snapshots:

https://raw.githubusercontent.com/Unitech/pm2/master/pres/memory-profiling.png

CPU FlameGraphs:

https://raw.githubusercontent.com/Unitech/pm2/master/pres/flamegraph.png

Multi Server Overview:

https://raw.githubusercontent.com/Unitech/pm2/master/pres/pm2-ls-multi.png

PM2 Plus: Expose Custom Metrics

To get more insights on how your application behave, plug custom metrics inside your code and monitor them with the pm2 monit command:

In your project install pm2-io-pm:

$ npm install @pm2/io --save

Then plug a custom metric:

const io = require('@pm2/io');

let counter = 1;

const latency = io.metric({
   name    : 'Counter',
   value   : function() {
     return counter;
   }
});

setInterval(() => {
  counter++;
}, 1000);

PM2 Plus: 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 automatically rotate logs and limit logs size
pm2-server-monit monitor the current server with more than 20+ metrics and 8 actions

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 licenses contact us.

GA