JSPM

pm2

0.12.7
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2433104
  • Score
    100M100P100Q185581F
  • License AGPLv3

Production process manager for Node.JS applications with a built-in load balancer.

Package Exports

  • pm2
  • pm2/bin/pm2
  • pm2/constants
  • pm2/constants.js
  • pm2/lib/CLI.js
  • pm2/lib/Common
  • pm2/lib/Common.js
  • pm2/lib/Configuration
  • pm2/lib/Log
  • pm2/lib/Satan
  • pm2/lib/Satan.js
  • pm2/lib/Utility.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (pm2) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

PM2

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.

PM2 is constantly assailed by more than 300 tests.

Compatible with io.js and Node.js. Compatible with CoffeeScript. Works on Linux (stable) & MacOSx (stable) & Windows (bêta).

NPM version![Gitter](https://badges.gitter.im/Join Chat.svg)Build StatusInline docs

NPM

Install PM2

$ npm install pm2 -g

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

Start an application

$ pm2 start app.js

Main features

Process management

Once apps are started you can list and manage them easily:

Process listing

Listing all running processes:

$ pm2 list

Managing your processes is straightforward:

$ pm2 stop     <app_name|id|all>
$ pm2 restart  <app_name|id|all>
$ pm2 delete   <app_name|id|all>

To have more details on a specific process:

$ pm2 describe 0

Monitoring

Monit

Monitoring all processes launched:

$ pm2 monit

Log facilities

Monit

Displaying logs of a specified process or all processes, in real time:

$ pm2 logs
$ pm2 logs big-api
$ pm2 flush          # Clear all the logs

Load balancing / 0s reload downtime

When an app is started with the -i option, the cluster mode is enabled.

Warning: It's still a beta feature. If you want to use the embed cluster module or reload with 0s downtime, we recommend the use of node#0.12.0+ node#0.11.16+ or io.js#1.0.2+. We do not support node#0.10.* cluster module anymore!

With the cluster mode, PM2 enables load balancing between each worker. Each HTTP/TCP/UDP request will be forwarded to one specific process at a time.

$ pm2 start app.js -i max  # Enable load-balancer and cluster features

$ pm2 reload all           # Reload all apps in 0s manner

Startup script generation

PM2 can generate and configure a startup script to keep PM2 and your processes alive at every server restart.

$ pm2 startup
# auto-detect platform
$ pm2 startup [platform]
# render startup-script for a specific platform, the [platform] could be one of:
#   ubuntu|centos|redhat|gentoo|systemd|darwin|amazon

To save a process list just do:

$ pm2 save

Monitoring dashboard

Dashboard

We are working on Keymetrics, a monitoring SaaS for PM2. It's still in beta, feel free to give it a try:

Discover the monitoring dashboard for PM2

Thanks in advance and we hope that you like PM2!

Other PM2 features

Learn more about PM2

Advanced README.md

Changelog

CHANGELOG

Contributors

Contributors

License

Files in lib/ are made available under the terms of the GNU Affero General Public License 3.0 (AGPL 3.0). Except the file lib/CLI.js who is made under the terms of the Apache V2 license.

Analytics