Merge pull request #1347 from Unitech/development

Release v0.14.0 Hellfire

Author: jshkurti

ADVANCED_README.md

@@ -5,6 +5,7 @@
 ### Quick start
 
 - [Installation](#a1)
+- [Folder structure](#pm2-folder-structure)
 - [Usage](#a2)
 - [Examples](#a3)
 - [Different ways to launch a process](#raw-examples)
@@ -21,6 +22,7 @@
 - [Monitoring CPU/Memory usage](#a7)
 - [Logs management](#a9)
 - [Clustering](#a5)
+- [Multiple PM2 on the same server](#multiple-pm2)
 - [Watch & Restart](#watch--restart)
 - [Reloading without downtime](#hot-reload--0s-reload)
 - [Make PM2 restart on server reboot](#a8)
@@ -87,6 +89,19 @@ If the above fails use:
 $ npm install git://github.com/Unitech/pm2#master -g
 ```
 
+<a name="pm2-folder-structure"/>
+## PM2 configuration folder structure
+
+Once PM2 is started, it automatically create these folders:
+- `$HOME/.pm2` will contain all PM2 related files
+- `$HOME/.pm2/logs` will contain all applications logs
+- `$HOME/.pm2/pids` will contain all applications pids
+- `$HOME/.pm2/pm2.log` PM2 logs
+- `$HOME/.pm2/pm2.pid` PM2 pid
+- `$HOME/.pm2/rpc.sock` Socket file for remote commands
+- `$HOME/.pm2/pub.sock` Socket file for publishable events
+- `$HOME/.pm2/conf.js` PM2 Configuration
+
 <a name="a2"/>
 ## Usage
 
@@ -516,7 +531,7 @@ $ pm2 start big-array.js --max-memory-restart 20M
 ### Programmatic
 
 ```
-pm2.start({{
+pm2.start({
   name               : "max_mem",
   script             : "big-array.js",
   max_memory_restart : "20M"
@@ -583,17 +598,39 @@ Just use the `-u <username>` option !
 $ pm2 startup ubuntu -u www
 ```
 
+<a name="multiple-pm2"/>
 ### Related commands
 
 Dump all processes status and environment managed by PM2:
+
 ```bash
-$ pm2 dump
+$ pm2 [dump|save]
 ```
+
 It populates the file `~/.pm2/dump.pm2` by default.
 
 To bring back the latest dump:
+
+```bash
+$ pm2 resurrect
+```
+
+## Multiple PM2 on the same server
+
+The client and daemon communicates via socket files available in $HOME/.pm2/[pub.sock|rpc.sock]
+
+You can start multiple PM2 instances by changing the `PM2_HOME` environmnent variable.
+
 ```bash
-$ pm2 [resurrect|save]
+$ PM2_HOME='.pm2' pm2 start echo.js --name="echo-node-1"
+$ PM2_HOME='.pm3' pm2 start echo.js --name="echo-node-2"
+```
+
+This will start two different PM2 instances. To list processes managed by each different instances do:
+
+```bash
+$ PM2_HOME='.pm2' pm2 list
+$ PM2_HOME='.pm3' pm2 list
 ```
 
 ## Watch & Restart
@@ -638,8 +675,7 @@ var watch_options = {
 
 ## JSON app declaration
 
-
-PM2 empowers your process management workflow, by allowing you to fine-tune the behavior, options, environment variables, logs files... of each process you need to manage via JSON configuration.
+PM2 empowers your process management workflow, by allowing you to fine-tune the behavior, options, environment variables, logs files... of each process you need to manage via JSON/JSON5/JS configuration.
 
 It's particularly usefull for micro service based applications.
 
@@ -680,11 +716,19 @@ $ pm2 start processes.json
 # Stop
 $ pm2 stop processes.json
 
+# Restart
+$ pm2 start processes.json
+## Or
+$ pm2 restart processes.json
+
+# Reload
+$ pm2 reload processes.json
+
+# Graceful Reload
+$ pm2 gracefulReload processes.json
+
 # Delete from PM2
 $ pm2 delete processes.json
-
-# Restart all
-$ pm2 restart processes.json
 ```
 
 ### Options

CHANGELOG.md

@@ -5,6 +5,33 @@
 - YAML support for apps declarations
 - Improve app declaration file parsing (log_file, out_file, error_file)
 
+# 0.14.0 - CrystalClear (pre 1.0)
+
+- Removed: pm2.startJSON() method, now call pm2.start()
+- API Change: pm2 start <app_name|app_id> restart an application already launched
+- API Change: pm2 start <json> restart all json apps if already launched
+- pm2 start all - restart all applications
+- pm2 reload <json_file> possible
+- pm2 gracefulReload <json_file> possible
+- Smart start (pm2 start app.js ; pm2 stop app ; pm2 start app)
+- Reduced memory footprint
+- Reduced pipelined data
+- Reduced CPU usage
+- Faster command processing
+- Upgrade shelljs, semver, colors, chalk, coffee-script, async, json-stringify-safe, cron, debug, commander
+- Fix: launchBus() only connects and disconnects once
+
+- Refactored `pm2 logs` :
+  - Now you don't need to install tail on Windows
+  - You don't need to Ctrl^C and `pm2 logs` again when a new app is launched (this one will be detected and added to the real-time logs output)
+  - Logs are shown in chronological order at a file level (modified date)
+  - More verbosity : tailed logs are explicitely separated from the real-time logs
+  - Real-time logs now use the `bus` event emitter
+  - PM2 logs added to the `bus`
+  - `--lines <n>` and `--raw` flags available for `pm2 logs` command
+  - New flag : '--timestamp [format]' // default format is 'YYYY-MM-DD-HH:mm:ss'
+  - Now you can exclusively show PM2 logs by doing `pm2 logs PM2`
+
 # 0.12.16 (Current stable)
 
 - Feature : File transmission added in Agent
@@ -364,7 +391,7 @@ Big thanks to @Tjatse !
 
 - Adds option to switch to a different user/group before starting a managed process #329
 - watch doesnt watch node_module folder
-- default log files and pid files location can be overidded by PM2_LOG_DIR / PM2_PID_DIR
+- default log files and pid files location can be overrided by PM2_LOG_DIR / PM2_PID_DIR
 
 
 # 0.8.1

README.md

@@ -16,8 +16,7 @@ Compatible with [io.js](https://github.com/iojs/io.js) and [Node.js](https://git
 Compatible with CoffeeScript.
 Works on Linux (stable) & MacOSx (stable) & Windows (stable).
 
-[![NPM version](https://badge.fury.io/js/pm2.svg)](http://badge.fury.io/js/pm2) [![Gitter](https://badges.gitter.im/Unitech/PM2.svg)](https://gitter.im/Unitech/PM2?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Build Status](https://api.travis-ci.org/Unitech/PM2.svg?branch=master)](https://travis-ci.org/Unitech/PM2) [![Inline docs](http://inch-ci.org/github/unitech/pm2.svg?branch=master)](http://inch-ci.org/github/unitech/pm2)
-
+[![Version npm](https://img.shields.io/npm/v/pm2.svg?style=flat-square)](https://www.npmjs.com/package/pm2)[![NPM Downloads](https://img.shields.io/npm/dm/pm2.svg?style=flat-square)](https://www.npmjs.com/package/pm2)[![Build Status](https://img.shields.io/travis/Unitech/PM2.svg?style=flat-square)](https://travis-ci.org/Unitech/PM2)[![Dependencies](https://img.shields.io/david/Unitech/pm2.svg?style=flat-square)](https://david-dm.org/Unitech/pm2)
 
 [![NPM](https://nodei.co/npm/pm2.png?downloads=true&downloadRank=true)](https://nodei.co/npm/pm2/)
 
@@ -71,15 +70,15 @@ $ pm2 list
 Managing your processes is straightforward:
 
 ```bash
-$ pm2 stop     <app_name|id|all>
-$ pm2 restart  <app_name|id|all>
-$ pm2 delete   <app_name|id|all>
+$ 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:
 
 ```bash
-$ pm2 describe 0
+$ pm2 describe <id|app_name>
 ```
 
 ### CPU / Memory Monitoring
@@ -100,11 +99,11 @@ Displaying logs of a specified process or all processes, in real time:
 
 ```bash
 $ pm2 logs
-$ pm2 logs big-api
+$ pm2 logs <app_name>
 $ pm2 logs --raw
 $ pm2 logs --lines 5
 $ pm2 logs --timestamp "HH:mm:ss"
-$ pm2 logs <app_name>
+$ pm2 logs WEB-API --lines 0 --timestamp "HH:mm"
 
 $ pm2 flush          # Clear all the logs
 ```

bin/pm2

@@ -72,7 +72,7 @@ commander.on('--help', function() {
   console.log('    $ pm2 kill');
   console.log('');
   console.log('    Update pm2 :');
-  console.log('    $ npm install pm2@latest -g ; pm2 updatePM2');
+  console.log('    $ npm install pm2@latest -g ; pm2 update');
   console.log('');
   console.log('    More examples in https://github.com/Unitech/pm2#usagefeatures');
   console.log('');
@@ -110,8 +110,8 @@ function beginCommandProcessing() {
       console.log('Local PM2 version:', chalk.blue.bold(pkg.version));
       console.log('');
     }
-    commander.parse(process.argv);
   });
+  commander.parse(process.argv);
 }
 
 if (process.argv.indexOf('--no-daemon') > -1) {
@@ -154,7 +154,7 @@ function failOnUnknown(fn) {
 //
 // Start command
 //
-commander.command('start <file|json|stdin>')
+commander.command('start <file|json|stdin|app_name|pm_id>')
   .option('--watch', 'Watch folder for changes')
   .description('start and daemonize an app')
   .action(function(cmd) {
@@ -568,17 +568,24 @@ commander.command('reloadLogs')
 //
 commander.command('logs [id|name]')
   .option('--raw', 'logs without timestamps and other PM2 indicators')
-  .option('--lines <N>', 'output the last N lines, instead of the last 20')
+  .option('--lines <n>', 'output the last N lines, instead of the last 20 by default')
+  .option('--timestamp [format]', 'add timestamps (default format YYYY-MM-DD-HH:mm:ss)')
   .description('stream logs file. Default stream all logs')
   .action(function(id, cmd) {
     var line = 20;
     var raw  = false;
+    var timestamp = false;
+
     if(!isNaN(cmd.lines)){
       line = parseInt(cmd.lines);
     }
+
     if (cmd.parent.rawArgs.indexOf('--raw') !== -1)
       raw = true;
-    CLI.streamLogs(id, line, raw);
+
+    if (cmd.timestamp)
+      timestamp = typeof cmd.timestamp === 'string' ? cmd.timestamp : 'YYYY-MM-DD-HH:mm:ss';
+    CLI.streamLogs(id, line, raw, timestamp);
   });
 
 

constants.js

@@ -59,7 +59,7 @@ var csts = {
   CLUSTER_MODE_ID        : 'cluster_mode',
   FORK_MODE_ID           : 'fork_mode',
 
-  KEYMETRICS_ROOT_URL    : 'root.keymetrics.io',
+  KEYMETRICS_ROOT_URL    : process.env.KEYMETRICS_NODE || 'root.keymetrics.io',
 
   DEFAULT_MODULE_JSON    : 'package.json',
 

doc/MODULE.md

@@ -5,7 +5,7 @@ A PM2 module is basically a NPM module. But this time it's not a library, but a
 
 Internally it embeds the NPM install procedure. So a PM2 module will be published to NPM and installed from NPM.
 
-![Process listing](https://github.com/unitech/pm2/raw/poc-plugin/pres/pm2-module.png)
+![Process listing](https://github.com/unitech/pm2/raw/master/pres/pm2-module.png)
 
 ## Basics
 
@@ -98,7 +98,7 @@ An object can be passed to initModule:
     latency          : false,
     versioning       : false,
     show_module_meta : false
-    pid              : pid_number (overidde pid to monitor // use pmx.getPID(FILE)),
+    pid              : pid_number (override pid to monitor // use pmx.getPID(FILE)),
     comment          : string (comment to be displayed in dashboard)
 }
 ```